C# Class SobekCM.Core.WebContent.HTML_Based_Content

Mostrar archivo Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
Apply_Settings_To_Static_Text ( string Display_Text, Item_Aggregation Aggregation, string Web_Skin_Code, string Base_Skin_Code, string Base_URL, string URL_Options, Custom_Tracer Tracer ) : string

Apply the individual user settings to this static text, replacing all directives with the actual data from this HTTP request

This actually reads the HTML file each time this is requested

Can_Delete ( User_Object CurrentUser ) : bool

Check to see if a user has the rights to DELETE an existing content page or redirect

Can_Edit ( User_Object CurrentUser ) : bool

Check to see if a user has the rights to EDIT an existing content page or redirect

HTML_Based_Content ( ) : System

Constructor for a new instance of the base_HTML_Content_Object class

HTML_Based_Content ( string Code ) : System

Constructor for a new instance of the base_HTML_Content_Object class

HTML_Based_Content ( string Text, string Title ) : System

Constructor for a new instance of the base_HTML_Content_Object class

This constructor is mostly used with passing back errors to be displayed.

HTML_Based_Content ( string Text, string Title, string Source ) : System

Constructor for a new instance of the base_HTML_Content_Object class

This constructor is mostly used with passing back errors to be displayed.

Save_To_File ( string File ) : bool

Saves all this data to a file

URL ( string BaseURL ) : string

Gets the URL for this web content page, based on the system base URL

Method Details

Apply_Settings_To_Static_Text() public method

Apply the individual user settings to this static text, replacing all directives with the actual data from this HTTP request
This actually reads the HTML file each time this is requested
public Apply_Settings_To_Static_Text ( string Display_Text, Item_Aggregation Aggregation, string Web_Skin_Code, string Base_Skin_Code, string Base_URL, string URL_Options, Custom_Tracer Tracer ) : string
Display_Text string Display text to apply the individual request's settings to
Aggregation SobekCM.Core.Aggregations.Item_Aggregation Current item aggregation, used for any custom directives which may exist
Web_Skin_Code string Code for the current web skin
Base_Skin_Code string Code for the base web skin from which the current web skin inherits
Base_URL string Base URL for the current request
URL_Options string Current URL Options
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return string

Can_Delete() public method

Check to see if a user has the rights to DELETE an existing content page or redirect
public Can_Delete ( User_Object CurrentUser ) : bool
CurrentUser SobekCM.Core.Users.User_Object Current user
return bool

Can_Edit() public method

Check to see if a user has the rights to EDIT an existing content page or redirect
public Can_Edit ( User_Object CurrentUser ) : bool
CurrentUser SobekCM.Core.Users.User_Object Current user
return bool

HTML_Based_Content() public method

Constructor for a new instance of the base_HTML_Content_Object class
public HTML_Based_Content ( ) : System
return System

HTML_Based_Content() public method

Constructor for a new instance of the base_HTML_Content_Object class
public HTML_Based_Content ( string Code ) : System
Code string SobekCM code for this html content-based object
return System

HTML_Based_Content() public method

Constructor for a new instance of the base_HTML_Content_Object class
This constructor is mostly used with passing back errors to be displayed.
public HTML_Based_Content ( string Text, string Title ) : System
Text string Static text to use for this item
Title string Title to display with this item
return System

HTML_Based_Content() public method

Constructor for a new instance of the base_HTML_Content_Object class
This constructor is mostly used with passing back errors to be displayed.
public HTML_Based_Content ( string Text, string Title, string Source ) : System
Text string Static text to use for this item
Title string Title to display with this item
Source string Source file for this static web-based content object
return System

Save_To_File() public method

Saves all this data to a file
public Save_To_File ( string File ) : bool
File string Name (and path) of the file to save
return bool

URL() public method

Gets the URL for this web content page, based on the system base URL
public URL ( string BaseURL ) : string
BaseURL string System base URL to use for this web content URL
return string