C# Class SobekCM.Core.Navigation.Navigation_Object

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

Private Properties

Property	Type	Description
Constructor_Helper	void

Public Methods

Method	Description
Is_UserAgent_IP_Robot ( string UserAgent, string IP ) : bool	Algorithm tests the user agent and IP address against known robots to determine if this request is from a search engine indexer or web site crawler bot.
Navigation_Object ( ) : System	Constructor for a new instance of the SobekCM_Navigation_Object which stores all of the information about an individual request.
Set_Robot_Flag ( string UserAgent, string IP ) : bool	Algorithm tests the user agent and IP address against known robots to determine if this request is from a search engine indexer or web site crawler bot. This returns the value and also sets an internal robot flag.
ShouldSerializeDateRange_Date1 ( ) : bool	Method suppresses XML Serialization of the DateRange_Date1 property if it is NULL
ShouldSerializeDateRange_Date2 ( ) : bool	Method suppresses XML Serialization of the DateRange_Date2 property if it is NULL
ShouldSerializeDateRange_Year1 ( ) : bool	Method suppresses XML Serialization of the DateRange_Year1 property if it is NULL
ShouldSerializeDateRange_Year2 ( ) : bool	Method suppresses XML Serialization of the DateRange_Year2 property if it is NULL
ShouldSerializeFolderID ( ) : bool	Method suppresses XML Serialization of the FolderID property if it is NULL
ShouldSerializeInvalid_Item ( ) : bool	Method suppresses XML Serialization of the Invalid_Item property if it is NULL
ShouldSerializeItemID_DEPRECATED ( ) : bool	Method suppresses XML Serialization of the ItemID_DEPRECATED property if it is NULL
ShouldSerializeMissing ( ) : bool	Method suppresses XML Serialization of the Missing flag property if it is NULL
ShouldSerializePage ( ) : bool	Method suppresses XML Serialization of the Page property if it is NULL
ShouldSerializeShow_Selection_Panel ( ) : bool	Method suppresses XML Serialization of the Show_Selection_Panel property if it is NULL
ShouldSerializeSize_Of_Thumbnails ( ) : bool	Method suppresses XML Serialization of the Size_Of_Thumbnails property if it is NULL
ShouldSerializeSort ( ) : bool	Method suppresses XML Serialization of the Sort property if it is NULL
ShouldSerializeSubPage ( ) : bool	Method suppresses XML Serialization of the SubPage property if it is NULL
ShouldSerializeThumbnails_Per_Page ( ) : bool	Method suppresses XML Serialization of the Thumbnails_Per_Page property if it is NULL
ShouldSerializeWebContentID ( ) : bool	Method suppresses XML Serialization of the WebContentID property if it is NULL

Private Methods

Method	Description
Constructor_Helper ( ) : void

Method Details

Is_UserAgent_IP_Robot() public static method

Algorithm tests the user agent and IP address against known robots to determine if this request is from a search engine indexer or web site crawler bot.

public static Is_UserAgent_IP_Robot ( string UserAgent, string IP ) : bool
UserAgent	string	User Agent string from the HTTP request
IP	string	IP address from the HTTP request
return	bool

Navigation_Object() public method

Constructor for a new instance of the SobekCM_Navigation_Object which stores all of the information about an individual request.

public Navigation_Object ( ) : System
return	System

Set_Robot_Flag() public method

Algorithm tests the user agent and IP address against known robots to determine if this request is from a search engine indexer or web site crawler bot. This returns the value and also sets an internal robot flag.

public Set_Robot_Flag ( string UserAgent, string IP ) : bool
UserAgent	string	User Agent string from the HTTP request
IP	string	IP address from the HTTP request
return	bool

ShouldSerializeDateRange_Date1() public method

Method suppresses XML Serialization of the DateRange_Date1 property if it is NULL

public ShouldSerializeDateRange_Date1 ( ) : bool
return	bool

ShouldSerializeDateRange_Date2() public method

Method suppresses XML Serialization of the DateRange_Date2 property if it is NULL

public ShouldSerializeDateRange_Date2 ( ) : bool
return	bool

ShouldSerializeDateRange_Year1() public method

Method suppresses XML Serialization of the DateRange_Year1 property if it is NULL

public ShouldSerializeDateRange_Year1 ( ) : bool
return	bool

ShouldSerializeDateRange_Year2() public method

Method suppresses XML Serialization of the DateRange_Year2 property if it is NULL

public ShouldSerializeDateRange_Year2 ( ) : bool
return	bool

ShouldSerializeFolderID() public method

Method suppresses XML Serialization of the FolderID property if it is NULL

public ShouldSerializeFolderID ( ) : bool
return	bool

ShouldSerializeInvalid_Item() public method

Method suppresses XML Serialization of the Invalid_Item property if it is NULL

public ShouldSerializeInvalid_Item ( ) : bool
return	bool

ShouldSerializeItemID_DEPRECATED() public method

Method suppresses XML Serialization of the ItemID_DEPRECATED property if it is NULL

public ShouldSerializeItemID_DEPRECATED ( ) : bool
return	bool

ShouldSerializeMissing() public method

Method suppresses XML Serialization of the Missing flag property if it is NULL

public ShouldSerializeMissing ( ) : bool
return	bool

ShouldSerializePage() public method

Method suppresses XML Serialization of the Page property if it is NULL

public ShouldSerializePage ( ) : bool
return	bool

ShouldSerializeShow_Selection_Panel() public method

Method suppresses XML Serialization of the Show_Selection_Panel property if it is NULL

public ShouldSerializeShow_Selection_Panel ( ) : bool
return	bool

ShouldSerializeSize_Of_Thumbnails() public method

Method suppresses XML Serialization of the Size_Of_Thumbnails property if it is NULL

public ShouldSerializeSize_Of_Thumbnails ( ) : bool
return	bool

ShouldSerializeSort() public method

Method suppresses XML Serialization of the Sort property if it is NULL

public ShouldSerializeSort ( ) : bool
return	bool

ShouldSerializeSubPage() public method

Method suppresses XML Serialization of the SubPage property if it is NULL

public ShouldSerializeSubPage ( ) : bool
return	bool

ShouldSerializeThumbnails_Per_Page() public method

Method suppresses XML Serialization of the Thumbnails_Per_Page property if it is NULL

public ShouldSerializeThumbnails_Per_Page ( ) : bool
return	bool

ShouldSerializeWebContentID() public method

Method suppresses XML Serialization of the WebContentID property if it is NULL

public ShouldSerializeWebContentID ( ) : bool
return	bool