C# Class SobekCM.Resource_Object.Divisions.Division_Tree

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

Private Properties

Property Type Description
preorder_build void
recursively_add_file bool
recursively_build_all_files_list void
recursively_check_for_any_files bool

Public Methods

Method Description
Add_File ( string FileName ) : SobekCM_File_Info

Adds a file (with the appropriate divisions and pages) to this tree by filename

This is generally used to add just a single file. To add many files, better logic should be implemented

Add_File ( string FileName, string Label ) : SobekCM_File_Info

Adds a file (with the appropriate divisions and pages) to this tree by filename

This is generally used to add just a single file. To add many files, better logic should be implemented

Add_File ( SobekCM_File_Info New_File ) : void

Adds a file object (with the appropriate divisions and pages) to this tree

This is generally used to add just a single file. To add many files, better logic should be implemented

Add_File ( SobekCM_File_Info New_File, string Label ) : void

Adds a file object (with the appropriate divisions and pages) to this tree

This is generally used to add just a single file. To add many files, better logic should be implemented

Clear ( ) : void

Clears this tree completely

Division_Tree ( ) : System

Constructor creates a new instance of the Division_Tree class

Page_Sequence_By_FileName ( string FileName ) : int

Returns the page sequence for the indicated file name

Private Methods

Method Description
preorder_build ( List Collection, SobekCM.Resource_Object.Divisions.abstract_TreeNode ThisNode, bool OnlyAddPages, bool PagesMustHaveFiles ) : void
recursively_add_file ( SobekCM.Resource_Object.Divisions.abstract_TreeNode Node, SobekCM_File_Info New_File, string SystemName_Upper ) : bool
recursively_build_all_files_list ( List ReturnValue, List HandledPages, SobekCM.Resource_Object.Divisions.abstract_TreeNode ThisNode ) : void
recursively_check_for_any_files ( SobekCM.Resource_Object.Divisions.abstract_TreeNode Node ) : bool

Method Details

Add_File() public method

Adds a file (with the appropriate divisions and pages) to this tree by filename
This is generally used to add just a single file. To add many files, better logic should be implemented
public Add_File ( string FileName ) : SobekCM_File_Info
FileName string Name of the file to add
return SobekCM_File_Info

Add_File() public method

Adds a file (with the appropriate divisions and pages) to this tree by filename
This is generally used to add just a single file. To add many files, better logic should be implemented
public Add_File ( string FileName, string Label ) : SobekCM_File_Info
FileName string Name of the file to add
Label string Label for the page containing this file, if it is a new page
return SobekCM_File_Info

Add_File() public method

Adds a file object (with the appropriate divisions and pages) to this tree
This is generally used to add just a single file. To add many files, better logic should be implemented
public Add_File ( SobekCM_File_Info New_File ) : void
New_File SobekCM_File_Info New file object to add
return void

Add_File() public method

Adds a file object (with the appropriate divisions and pages) to this tree
This is generally used to add just a single file. To add many files, better logic should be implemented
public Add_File ( SobekCM_File_Info New_File, string Label ) : void
New_File SobekCM_File_Info New file object to add
Label string Label for the page containing this file, if it is a new page
return void

Clear() public method

Clears this tree completely
public Clear ( ) : void
return void

Division_Tree() public method

Constructor creates a new instance of the Division_Tree class
public Division_Tree ( ) : System
return System

Page_Sequence_By_FileName() public method

Returns the page sequence for the indicated file name
public Page_Sequence_By_FileName ( string FileName ) : int
FileName string Name of the file to check for similar existence
return int