C# Class SobekCM.Resource_Object.Web_Info

Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
Add_Pages_By_Sequence ( SobekCM.Resource_Object.Divisions.Page_TreeNode Next_Page ) : void	Adds to the collection of pages by sequence
Clear_Pages_By_Sequence ( ) : void	Clears the complete list of pages by sequence
Get_Download_Eligible_Files ( string Directory ) : ReadOnlyCollection	Gets the list of all download eligible files for this package This list excludes all page image type files and the standard SobekCM metadata files
Get_Thumbnail_Files ( string Directory ) : ReadOnlyCollection	Gets the list of all possible thumbnail jpeg files for this package This pulls the file list from the directory each time it is called. In addition, it sorts by the filename, since this was not always happening correctly and this is primarily used for the online metadata update.
Set_BibID_VID ( string BibID, string VID ) : void	Sets the BibID and VID in this child object, which is used to determine the default folder structure
Web_Info ( Behaviors_Info Behaviors ) : System	Constructor for a new instance of the Behaviors_Info class

Method Details

Add_Pages_By_Sequence() public method

Adds to the collection of pages by sequence

public Add_Pages_By_Sequence ( SobekCM.Resource_Object.Divisions.Page_TreeNode Next_Page ) : void
Next_Page	SobekCM.Resource_Object.Divisions.Page_TreeNode	Next page in sequence to add
return	void

Clear_Pages_By_Sequence() public method

Clears the complete list of pages by sequence

public Clear_Pages_By_Sequence ( ) : void
return	void

Get_Download_Eligible_Files() public method

Gets the list of all download eligible files for this package

This list excludes all page image type files and the standard SobekCM metadata files

public Get_Download_Eligible_Files ( string Directory ) : ReadOnlyCollection
Directory	string	Directory to check for the files
return	ReadOnlyCollection

Get_Thumbnail_Files() public method

Gets the list of all possible thumbnail jpeg files for this package

This pulls the file list from the directory each time it is called. In addition, it sorts by the filename, since this was not always happening correctly and this is primarily used for the online metadata update.

public Get_Thumbnail_Files ( string Directory ) : ReadOnlyCollection
Directory	string	Directory to check for the files
return	ReadOnlyCollection

Set_BibID_VID() public method

Sets the BibID and VID in this child object, which is used to determine the default folder structure

public Set_BibID_VID ( string BibID, string VID ) : void
BibID	string	BibID
VID	string	VID
return	void

Web_Info() public method

Constructor for a new instance of the Behaviors_Info class

public Web_Info ( Behaviors_Info Behaviors ) : System
Behaviors	SobekCM.Resource_Object.Behaviors.Behaviors_Info
return	System