C# Класс SobekCM.Library.ItemViewer.Viewers.abstractPageFilesItemViewer

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
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.
Наследование: iItemViewer
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
Behaviors List
BriefItem SobekCM.Core.BriefItem.BriefItemInfo
CurrentRequest SobekCM.Core.Navigation.Navigation_Object
CurrentUser SobekCM.Core.Users.User_Object
EmptyBehaviors List

Открытые методы

Метод Описание
Add_Main_Viewer_Section ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void

Abstract method allows controls to be added directory to a place holder, rather than just writing to the output HTML stream

This MUST be implemented by all classes that implement this abstract class

Add_ViewerSpecific_Body_Attributes ( string>.List Body_Attributes ) : void

Gets the collection of body attributes to be included within the HTML body tag (usually to add events to the body)

By default this does nothing, but can be overwritten by all the individual item viewers

Write_Left_Nav_Menu_Section ( TextWriter Output, Custom_Tracer Tracer ) : void

Adds any viewer_specific information to the left Navigation Bar Menu Section

By default this does nothing, but can be overwritten by all the individual item viewers

Write_Main_Viewer_Section ( TextWriter Output, Custom_Tracer Tracer ) : void

Abstract method writes the item viewer main section as HTML directly to the HTTP output stream

This MUST be implemented by all classes that implement this abstract class

Write_Top_Additional_Navigation_Row ( TextWriter Output, Custom_Tracer Tracer ) : void

Adds any viewer_specific information to the item viewer above the standard pagination buttons

By default this does nothing, but can be overwritten by all the individual item viewers

Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void

Write any additional values within the HTML Head of the final served page

By default this does nothing, but can be overwritten by all the individual item viewers

Описание методов

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
This MUST be implemented by all classes that implement this abstract class
public abstract Add_Main_Viewer_Section ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder System.Web.UI.WebControls.PlaceHolder Main place holder ( "mainPlaceHolder" ) in the itemNavForm form into which the bulk of the item viewer's output is displayed
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
Результат void

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)
By default this does nothing, but can be overwritten by all the individual item viewers
public Add_ViewerSpecific_Body_Attributes ( string>.List Body_Attributes ) : void
Body_Attributes string>.List List of body attributes to be included
Результат void

Write_Left_Nav_Menu_Section() публичный Метод

Adds any viewer_specific information to the left Navigation Bar Menu Section
By default this does nothing, but can be overwritten by all the individual item viewers
public Write_Left_Nav_Menu_Section ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Response stream for the item viewer to write directly to
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
Результат void

Write_Main_Viewer_Section() публичный абстрактный Метод

Abstract method writes the item viewer main section as HTML directly to the HTTP output stream
This MUST be implemented by all classes that implement this abstract class
public abstract Write_Main_Viewer_Section ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Response stream for the item viewer to write directly to
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
Результат void

Write_Top_Additional_Navigation_Row() публичный Метод

Adds any viewer_specific information to the item viewer above the standard pagination buttons
By default this does nothing, but can be overwritten by all the individual item viewers
public Write_Top_Additional_Navigation_Row ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Response stream for the item viewer to write directly to
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
Результат void

Write_Within_HTML_Head() публичный Метод

Write any additional values within the HTML Head of the final served page
By default this does nothing, but can be overwritten by all the individual item viewers
public Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Output stream currently within the HTML head tags
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
Результат void

Описание свойств

Behaviors защищенное свойство

Protected collection of behaviors for this item viewer
protected List Behaviors
Результат List

BriefItem защищенное свойство

Current digital resource item to display
protected BriefItemInfo,SobekCM.Core.BriefItem BriefItem
Результат SobekCM.Core.BriefItem.BriefItemInfo

CurrentRequest защищенное свойство

Current navigation information for this individual HTML request
protected Navigation_Object,SobekCM.Core.Navigation CurrentRequest
Результат SobekCM.Core.Navigation.Navigation_Object

CurrentUser защищенное свойство

Current user, which can help determine how things should display
protected User_Object,SobekCM.Core.Users CurrentUser
Результат SobekCM.Core.Users.User_Object

EmptyBehaviors защищенное статическое свойство

Empty list of behaviors, returned by default
This just prevents an empty set from having to be created over and over
protected static List EmptyBehaviors
Результат List