abstractPageFilesItemViewer Class

Abstract item viewer is a good base class to extend for item viewers that display files related to the pages, using the built-in paging features to step through each available page

Namespace: SobekCM.Library.ItemViewer.Viewers
Assembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public abstract class abstractPageFilesItemViewer : iItemViewer

Remarks

This abstract class implements the iItemViewer interface, although several of the main methods are left abstract here and MUST be implemented by any classes that extend this abstract class.

Inheritance Hierarchy

System..::..Object
  SobekCM.Library.ItemViewer.Viewers..::..abstractPageFilesItemViewer
    SobekCM.Library.ItemViewer.Viewers..::..JPEG_ItemViewer
    SobekCM.Library.ItemViewer.Viewers..::..JPEG2000_ItemViewer

Constructors

	Name	Description
	abstractPageFilesItemViewer	Initializes a new instance of the abstractPageFilesItemViewer class

Methods

	Name	Description
	Add_Main_Viewer_Section	Abstract method allows controls to be added directory to a place holder, rather than just writing to the output HTML stream
	Add_ViewerSpecific_Body_Attributes	Gets the collection of body attributes to be included within the HTML body tag (usually to add events to the body)
	Write_Left_Nav_Menu_Section	Adds any viewer_specific information to the left Navigation Bar Menu Section
	Write_Main_Viewer_Section	Abstract method writes the item viewer main section as HTML directly to the HTTP output stream
	Write_Top_Additional_Navigation_Row	Adds any viewer_specific information to the item viewer above the standard pagination buttons
	Write_Within_HTML_Head	Write any additional values within the HTML Head of the final served page

Fields

	Name	Description
	Behaviors	Protected collection of behaviors for this item viewer
	BriefItem	Current digital resource item to display
	CurrentRequest	Current navigation information for this individual HTML request
	CurrentUser	Current user, which can help determine how things should display
	EmptyBehaviors	Empty list of behaviors, returned by default

Properties

	Name	Description
	Current_Page	Gets the current page for paging purposes
	First_Page_URL	Gets the url to go to the first page
	Go_To_Names	Gets the names to show in the Go To combo box
	ItemViewer_Behaviors	Gets the collection of special behaviors which this item viewer requests from the main HTML subwriter.
	Last_Page_URL	Gets the url to go to the last page
	Next_Page_URL	Gets the url to go to the next page
	Page_Selector	Gets the flag that indicates if the page selector should be shown, and which page selector
	PageCount	Gets the number of pages for this viewer
	Previous_Page_URL	Gets the url to go to the previous page
	ViewerBox_CssId	CSS ID for the viewer viewport for this particular viewer
	ViewerBox_InlineStyle	Any additional inline style for this viewer that affects the main box around this