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

Item viewer displays the search options and any search results for full-text searching within a single document

This class extends the abstract class abstractItemViewer and implements the iItemViewer interface.

Inheritance: SobekCM.Library.ItemViewer.Viewers.abstractItemViewer

Mostrar archivo Open project: MarkVSullivan/SobekCM-Web-Application

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
Text_Search_ItemViewer ( BriefItemInfo BriefItem, User_Object CurrentUser, Navigation_Object CurrentRequest, Custom_Tracer Tracer ) : System	Constructor for a new instance of the Text_Search_ItemViewer class, which allows the full text of an individual resource to be searched and individual matching pages are displayed with page thumbnails
Write_Main_Viewer_Section ( TextWriter Output, Custom_Tracer Tracer ) : void	Write the item viewer main section as HTML directly to the HTTP output stream

Protected Methods

Method	Description
Compute_Search_Explanation ( ) : string	Returns the textual explanation of the item-level search

Private Methods

Method	Description
number_to_string ( int Number ) : string

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

Compute_Search_Explanation() protected method

Returns the textual explanation of the item-level search

protected Compute_Search_Explanation ( ) : string
return	string

Text_Search_ItemViewer() public method

Constructor for a new instance of the Text_Search_ItemViewer class, which allows the full text of an individual resource to be searched and individual matching pages are displayed with page thumbnails

public Text_Search_ItemViewer ( BriefItemInfo BriefItem, User_Object CurrentUser, Navigation_Object CurrentRequest, Custom_Tracer Tracer ) : 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
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
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