C# Class SobekCM.Library.ItemViewer.Viewers.Citation_Standard_ItemViewer

Item viewer displays the descriptive citation in standard, human-readable format for a digital resource
This class extends the abstract class abstractNoPaginationItemViewer and implements the iItemViewer interface.
Inheritance: abstractNoPaginationItemViewer
Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Add_Citation_View_Tabs ( TextWriter Output, BriefItemInfo BriefItem, Navigation_Object CurrentRequest, string CurrentType ) : void

Write the citation view tabs to the stream

This static method is called from the other viewers that were split off from the old citation viewer ( Citation_MARC_ItemViewer, Metadata_Links_ItemViewer, and Usage_Stats_ItemViewer )

Add_Main_Viewer_Section ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void

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

This method does nothing, since nothing is added to the place holder as a control for this item viewer

Citation_Standard_ItemViewer ( BriefItemInfo BriefItem, User_Object CurrentUser, Navigation_Object CurrentRequest ) : System

Constructor for a new instance of the Citation_Standard_ItemViewer class, used to display the descriptive citation in standard, human-readable format for the digital resource

Standard_Citation_String ( bool Include_Links, Custom_Tracer Tracer ) : string

Returns the basic information about this digital resource in standard format

Write_Main_Viewer_Section ( TextWriter Output, Custom_Tracer Tracer ) : void

Write the item viewer main section as HTML directly to the HTTP output stream

Private Methods

Method Description
Add_Citation_HTML_Rows ( string Row_Name, List Values, string Indent, StringBuilder Results ) : void
Single_Citation_HTML_Row ( string Row_Name, string Value, string Indent ) : string
display_text_from_value ( string Value ) : string
display_text_from_value ( string Value, List URIs ) : string
search_link_from_value ( string Value ) : string

Method Details

Add_Citation_View_Tabs() public static method

Write the citation view tabs to the stream
This static method is called from the other viewers that were split off from the old citation viewer ( Citation_MARC_ItemViewer, Metadata_Links_ItemViewer, and Usage_Stats_ItemViewer )
public static Add_Citation_View_Tabs ( TextWriter Output, BriefItemInfo BriefItem, Navigation_Object CurrentRequest, string CurrentType ) : void
Output System.IO.TextWriter Response stream for the item viewer to write directly to
BriefItem SobekCM.Core.BriefItem.BriefItemInfo Digital resource object
CurrentRequest SobekCM.Core.Navigation.Navigation_Object Information about the current request
CurrentType string Type of the current view, so one tab can be marked as current
return void

Add_Main_Viewer_Section() public method

Allows controls to be added directory to a place holder, rather than just writing to the output HTML stream
This method does nothing, since nothing is added to the place holder as a control for this item viewer
public 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
return void

Citation_Standard_ItemViewer() public method

Constructor for a new instance of the Citation_Standard_ItemViewer class, used to display the descriptive citation in standard, human-readable format for the digital resource
public Citation_Standard_ItemViewer ( BriefItemInfo BriefItem, User_Object CurrentUser, Navigation_Object CurrentRequest ) : System
BriefItem SobekCM.Core.BriefItem.BriefItemInfo Digital resource object
CurrentUser SobekCM.Core.Users.User_Object Current user, who may or may not be logged on
CurrentRequest SobekCM.Core.Navigation.Navigation_Object Information about the current request
return System

Standard_Citation_String() public method

Returns the basic information about this digital resource in standard format
public Standard_Citation_String ( bool Include_Links, Custom_Tracer Tracer ) : string
Include_Links bool Flag tells whether to include the search links from this citation view
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return string

Write_Main_Viewer_Section() public method

Write the item viewer main section as HTML directly to the HTTP output stream
public 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
return void