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

Item viewer is substituted for the regular image/download viewers if an item is restricted by IP address range and is not accessible to the the current user
This class extends the abstract class abstractItemViewer and implements the iItemViewer interface.
Inheritance: SobekCM.Library.ItemViewer.Viewers.abstractItemViewer
Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Add_Main_Viewer_Section ( 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

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

Constructor for a new instance of the Restricted_ItemViewer class, used display the applicable restricted message for a digital resource which is currently restricted due to IP restrictions

Write_Main_Viewer_Section ( TextWriter Output, Custom_Tracer Tracer ) : void

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

Method Details

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 ( PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder 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

Restricted_ItemViewer() public method

Constructor for a new instance of the Restricted_ItemViewer class, used display the applicable restricted message for a digital resource which is currently restricted due to IP restrictions
public Restricted_ItemViewer ( BriefItemInfo BriefItem, User_Object CurrentUser, Navigation_Object CurrentRequest ) : System
BriefItem BriefItemInfo Digital resource object
CurrentUser 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

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