mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
Expand <a href='https://sobekrepository.org/codehelp/engineagnosticlayerdbaccess' title='EngineAgnosticLayerDbAccess'>EngineAgnosticLayerDbAccess Namespace</a>EngineAgnosticLayerDbAccess Namespace
Expand <a href='https://sobekrepository.org/codehelp/builder_library' title='SobekCM.Builder_Library'>Builder_Library Namespace</a>Builder_Library Namespace
Expand <a href='https://sobekrepository.org/codehelp/core' title='SobekCM.Core'>Core Namespace</a>Core Namespace
Expand <a href='https://sobekrepository.org/codehelp/engine_library' title='SobekCM.Engine_Library'>Engine_Library Namespace</a>Engine_Library Namespace
Collapse <a href='https://sobekrepository.org/codehelp/library' title='SobekCM.Library'>Library Namespace</a>Library Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/adminviewer' title='SobekCM.Library.AdminViewer'>AdminViewer Sub-Namespace</a>AdminViewer Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/aggregationviewer' title='SobekCM.Library.AggregationViewer'>AggregationViewer Sub-Namespace</a>AggregationViewer Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/ckeditor' title='SobekCM.Library.CKEditor'>CKEditor Sub-Namespace</a>CKEditor Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/citation' title='SobekCM.Library.Citation'>Citation Sub-Namespace</a>Citation Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/database' title='SobekCM.Library.Database'>Database Sub-Namespace</a>Database Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/email' title='SobekCM.Library.Email'>Email Sub-Namespace</a>Email Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/html' title='SobekCM.Library.HTML'>HTML Sub-Namespace</a>HTML Sub-Namespace
Collapse <a href='https://sobekrepository.org/codehelp/library/itemviewer' title='SobekCM.Library.ItemViewer'>ItemViewer Sub-Namespace</a>ItemViewer Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/localization' title='SobekCM.Library.Localization'>Localization Sub-Namespace</a>Localization Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/mainwriters' title='SobekCM.Library.MainWriters'>MainWriters Sub-Namespace</a>MainWriters Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/mysobekviewer' title='SobekCM.Library.MySobekViewer'>MySobekViewer Sub-Namespace</a>MySobekViewer Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/resultsviewer' title='SobekCM.Library.ResultsViewer'>ResultsViewer Sub-Namespace</a>ResultsViewer Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/ui' title='SobekCM.Library.UI'>UI Sub-Namespace</a>UI Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/uploadifive' title='SobekCM.Library.UploadiFive'>UploadiFive Sub-Namespace</a>UploadiFive Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/webcontentviewer' title='SobekCM.Library.WebContentViewer'>WebContentViewer Sub-Namespace</a>WebContentViewer Sub-Namespace
Expand <a href='https://sobekrepository.org/codehelp/library/aggregationviewbag' title='AggregationViewBag Class'>AggregationViewBag</a>AggregationViewBag
Expand <a href='https://sobekrepository.org/codehelp/library/requestcache' title='RequestCache Class'>RequestCache</a>RequestCache
Expand <a href='https://sobekrepository.org/codehelp/library/resource_web_config_writer' title='Resource_Web_Config_Writer Class'>Resource_Web_Config_Writer</a>Resource_Web_Config_Writer
Expand <a href='https://sobekrepository.org/codehelp/library/sobekcm_assistant' title='SobekCM_Assistant Class'>SobekCM_Assistant</a>SobekCM_Assistant
Expand <a href='https://sobekrepository.org/codehelp/library/static_pages_builder' title='Static_Pages_Builder Class'>Static_Pages_Builder</a>Static_Pages_Builder
Expand <a href='https://sobekrepository.org/codehelp/library/text_search_term_highlighter' title='Text_Search_Term_Highlighter Class'>Text_Search_Term_Highlighter</a>Text_Search_Term_Highlighter
Expand <a href='https://sobekrepository.org/codehelp/resource_object' title='SobekCM.Resource_Object'>Resource_Object Namespace</a>Resource_Object Namespace
Expand <a href='https://sobekrepository.org/codehelp/tools' title='SobekCM.Tools'>Tools Namespace</a>Tools Namespace
MISSING BANNER
Code Details >> Library >> ItemViewer >> Viewers >> abstractPageFilesItemViewer

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

Constructors

  NameDescription
Protected methodabstractPageFilesItemViewer
Initializes a new instance of the abstractPageFilesItemViewer class

Methods

  NameDescription
Public methodAdd_Main_Viewer_Section
Abstract method allows controls to be added directory to a place holder, rather than just writing to the output HTML stream
Public methodAdd_ViewerSpecific_Body_Attributes
Gets the collection of body attributes to be included within the HTML body tag (usually to add events to the body)
Public methodWrite_Left_Nav_Menu_Section
Adds any viewer_specific information to the left Navigation Bar Menu Section
Public methodWrite_Main_Viewer_Section
Abstract method writes the item viewer main section as HTML directly to the HTTP output stream
Public methodWrite_Top_Additional_Navigation_Row
Adds any viewer_specific information to the item viewer above the standard pagination buttons
Public methodWrite_Within_HTML_Head
Write any additional values within the HTML Head of the final served page

Fields

  NameDescription
Protected fieldBehaviors
Protected collection of behaviors for this item viewer
Protected fieldBriefItem
Current digital resource item to display
Protected fieldCurrentRequest
Current navigation information for this individual HTML request
Protected fieldCurrentUser
Current user, which can help determine how things should display
Protected fieldStatic memberEmptyBehaviors
Empty list of behaviors, returned by default

Properties

  NameDescription
Public propertyCurrent_Page
Gets the current page for paging purposes
Public propertyFirst_Page_URL
Gets the url to go to the first page
Public propertyGo_To_Names
Gets the names to show in the Go To combo box
Public propertyItemViewer_Behaviors
Gets the collection of special behaviors which this item viewer requests from the main HTML subwriter.
Public propertyLast_Page_URL
Gets the url to go to the last page
Public propertyNext_Page_URL
Gets the url to go to the next page
Public propertyPage_Selector
Gets the flag that indicates if the page selector should be shown, and which page selector
Public propertyPageCount
Gets the number of pages for this viewer
Public propertyPrevious_Page_URL
Gets the url to go to the previous page
Public propertyViewerBox_CssId
CSS ID for the viewer viewport for this particular viewer
Public propertyViewerBox_InlineStyle
Any additional inline style for this viewer that affects the main box around this

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )