Content Studio Web Content Management System
SystemObject
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIUserControl
System.Web.UIMasterPage
ContentStudio.SiteMasterPageBase
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This abstract (MustInherit in Visual Basic) class acts as
the base class of a Content Studio master page document.
Inheritance Hierarchy
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIUserControl
System.Web.UIMasterPage
ContentStudio.SiteMasterPageBase
Namespace: ContentStudio.Site
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The MasterPageBase type exposes the following members.
Constructors
Name | Description | |
---|---|---|
MasterPageBase |
Creates a new instance of a SiteBase class.
|
Properties
Name | Description | |
---|---|---|
Adapter | (Inherited from Control.) | |
AdminUrl |
Gets the Url for the administrative interface.
| |
Application | (Inherited from UserControl.) | |
AppRelativeTemplateSourceDirectory | (Inherited from Control.) | |
AppRelativeVirtualPath | (Inherited from TemplateControl.) | |
Attributes | (Inherited from UserControl.) | |
AutoHandlers | Obsolete. (Inherited from TemplateControl.) | |
BindingContainer | (Inherited from Control.) | |
Cache | (Inherited from UserControl.) | |
CachePolicy | (Inherited from UserControl.) | |
ChildControlsCreated | (Inherited from Control.) | |
ClientID | (Inherited from Control.) | |
ClientIDSeparator | (Inherited from Control.) | |
ContentPlaceHolders | (Inherited from MasterPage.) | |
ContentTemplates | (Inherited from MasterPage.) | |
Context | (Inherited from Control.) | |
Controls | (Inherited from Control.) | |
CS_ConnectionId |
Gets a value that uniquely identifies the current web site.
| |
CS_DataFields |
Gets a EPTXmlParser that contains a collection of EPT field definitions and values.
This property is the replacement for the obsolete EPT_GetFieldName(String) and EPT_GetFieldValue(String) methods.
| |
CS_DocumentType |
Gets the Document Type of the current document
| |
CS_EditDataFields |
Gets an object that contains the EPT field definitions for an edit
eemplate or any document that edits an EPT document.
When in an edit template, a EPTXmlParser
that contains the EPT fields that defines the editing schema; otherwise
null (Nothing in Visual Basic).
| |
CS_EditId |
Gets a the edit ID.
| |
CS_HasMetaData |
Gets a value that indicates if the current document has meta data.
| |
CS_InsertedCategoryId |
Gets the category ID of the current document
| |
CS_InsertedDocumentId |
Gets the document ID for the current document. In a presentation
template, this is the presented document.
| |
CS_IsInAdmin |
Gets a value that indicates whether the current user is logged on to
Content Studio administration site.
| |
CS_IsInPreView |
Gets a value that tells if the current page is in preview mode
| |
CS_IsInWebView |
Gets a value that indicates if the current user is logged on to Content
Studio administration site, and that the current page is displayed in
web view mode
| |
CS_LiveObjectData |
Gets the complete set of parameters connected to a Live Object in a DictionaryTKey, TValue structure.
| |
CS_LiveObjectXML |
Gets or sets an XML definition that contains the parameter definition
for a Live Object.
| |
CS_MLCPageLanguage |
Gets the MLC language code for the current page.
| |
CS_MLCPreferredLanguage |
Gets the preferred MLC language code.
| |
CS_PreviewDate |
Gets a value that is used in the web view to preview documents on
another date. This value will be DateTime.MinValue if preview is
not used.
| |
CS_QueryStringPrefix |
Gets a value that defines the page identifier part of a query string.
This value is also used for the id part of the ptid query
string member.
| |
CS_RootDocumentId |
Gets a value that contains the root document ID retrieved from a query
string.
| |
CS_RootPresentationTemplateId |
Gets the root presentation template ID retrieved from a query string.
| |
CS_RootRefId |
Gets the root referrer document ID retrieved from a query string.
| |
CS_UserSessionId |
Gets value that identifies the caller's session. For authenticated
callers the value is randomly generated for each new session opened and
unique for each caller on a particular web site.
For anonymous (not authenticated) callers this value always is CS_ANONYMOUS_SESSION_IDENTIFIER.
| |
CS_ViewState |
Gets the view state from the current page.
| |
CS_XHTML |
Gets a value that indicates whether or not the current page is written in XHtml />.
| |
CS_XHTML_TRAIL |
Gets a value that is a slash ("/") if the page uses XHTML, otherwise it is an empty string.
| |
CS_XHTMLStrict |
Gets a value that indicates whether or not the current page is written in XHtml 1.0 Strict or XHtml 1.1/>.
| |
DesignMode | (Inherited from Control.) | |
EnableTheming | (Inherited from TemplateControl.) | |
EnableViewState | (Inherited from Control.) | |
EPTDocumentID |
Setting this property to a valid EPT document id will cause this user control to act as a presentation template. CS_DataFields, EPT_GetFieldValue(String) and EPT_GetFieldName(String) will be filled with data from th chosen ept document.
| |
Events | (Inherited from Control.) | |
HasChildViewState | (Inherited from Control.) | |
HtmlLangAttribute |
Gets or sets the HTML language attribute.
| |
ID | (Inherited from Control.) | |
IdSeparator | (Inherited from Control.) | |
IsChildControlStateCleared | (Inherited from Control.) | |
IsPostBack | (Inherited from UserControl.) | |
IsTrackingViewState | (Inherited from Control.) | |
IsViewStateEnabled | (Inherited from Control.) | |
LoadViewStateByID | (Inherited from Control.) | |
Master | (Inherited from MasterPage.) | |
MasterPageFile | (Inherited from MasterPage.) | |
NamingContainer | (Inherited from Control.) | |
Page |
Gets a reference to the Page instance that contains the server control.
| |
Parent | (Inherited from Control.) | |
Request | (Inherited from UserControl.) | |
Response | (Inherited from UserControl.) | |
RewriteAppRelativeVirtualPath |
Gets or sets a value indicating whether cs should rewrite the AppRelativeVirtualPath path to ~/default.aspx.
| |
Server | (Inherited from UserControl.) | |
Session | (Inherited from UserControl.) | |
Site | (Inherited from Control.) | |
SkinID | (Inherited from Control.) | |
SupportAutoEvents | (Inherited from TemplateControl.) | |
TemplateControl | (Inherited from Control.) | |
TemplateSourceDirectory | (Inherited from Control.) | |
Trace | (Inherited from UserControl.) | |
UniqueID | (Inherited from Control.) | |
ViewState | (Inherited from Control.) | |
ViewStateIgnoresCase | (Inherited from Control.) | |
Visible | (Inherited from Control.) |
Methods
Name | Description | |
---|---|---|
AddContentTemplate | (Inherited from MasterPage.) | |
AddedControl | (Inherited from Control.) | |
AddParsedSubObject | (Inherited from Control.) | |
ApplyStyleSheetSkin | (Inherited from Control.) | |
BuildHTMLException(String, String, Boolean) |
Returns HTML code for a CS exception.
| |
BuildHTMLException(String, CSException, Boolean, Boolean) |
Returns HTML code for a CS exception.
| |
BuildHTMLException(String, CSException, Boolean, Boolean, CSApplicationSupportedLanguages) |
Returns HTML code for a CS exception.
| |
BuildProfileTree | (Inherited from Control.) | |
BuildQueryString(String) |
Returns a query string from a Request.QueryString with an '&' (ampersand) at the end.
| |
BuildQueryString(NameValueCollection, String) |
Returns a query string from a collection with an '&' (ampersand) at
the end.
| |
ClearChildControlState | (Inherited from Control.) | |
ClearChildState | (Inherited from Control.) | |
ClearChildViewState | (Inherited from Control.) | |
Construct | (Inherited from TemplateControl.) | |
CreateChildControls | (Inherited from Control.) | |
CreateControlCollection | (Inherited from Control.) | |
CreateResourceBasedLiteralControl | (Inherited from TemplateControl.) | |
CS_AddLiveObjectParameterValue |
Adds a parameter value to a Live Object
| |
CS_ClearLiveObjectParameterValues |
Clear all data parameters from a Live Object
| |
CS_CreateEditIcon(CategoryId, DocumentId, String) |
Returns HTML code for displaying a standard edit icon in web view,
without any permission checks.
| |
CS_CreateEditIcon(CategoryId, DocumentId, String, Boolean) |
Returns HTML code for displaying a standard edit icon in web view.
| |
CS_CreateEditIcon(CategoryId, DocumentId, DocumentId, String, Boolean, SiteBaseCS_EditIconTypes) |
Returns HTML code for displaying an edit icon in web view.
| |
CS_FixJavaString |
Returns a string where the escape character sequences is adjusted to
be used with Javascript.
| |
CS_GetAnyEPTDocument |
Returns the published content of any XML document as an EPTXmlTextParser.
| |
CS_GetParentPage |
Returns a reference to the parent document page.
| |
CS_GetParentPage(SiteBase) |
Returns a reference to the parent document page.
| |
CS_GetRootPage |
Returns a reference to the root document page.
| |
CS_GetRootPage(SiteBase) |
Returns a reference to the root document page.
| |
CS_ReadFromApplicationCache |
Returns the data from the application cache
| |
CS_ReadLiveObjectParameterValue |
Returns the value that has been added to a Live Object with the
supplied key.
| |
CS_ReplaceRelativeUrls |
Returns a string where all occurrences of relative URL's in a string
containing HTML is replaced with absolute URL's.
| |
CS_SetApplicationCache |
Stores a string in cache.
| |
CS_TranslateMessage(CSException) |
Returns a translated error message.
| |
CS_TranslateMessage(CSApplicationSupportedLanguages, CSException) |
Returns a translated error message.
| |
CSF_TranslateMessage |
Returns a translated error message.
| |
DataBind | (Inherited from Control.) | |
DataBind(Boolean) | (Inherited from Control.) | |
DataBindChildren | (Inherited from Control.) | |
DesignerInitialize | (Inherited from UserControl.) | |
Dispose | (Inherited from Control.) | |
EnsureChildControls | (Inherited from Control.) | |
EnsureID | (Inherited from Control.) | |
EPT_GetFieldName | Obsolete.
Gets the value of a specified field in an EPT document.
This method is only applicable to edit templates and
presentation templates, and for all other type of documents this method
always returns null.
| |
EPT_GetFieldValue | Obsolete.
When overriden in derived classes, obtains the value of a certain field in an EPT-document.
| |
Equals | (Inherited from Object.) | |
Eval(String) | (Inherited from TemplateControl.) | |
Eval(String, String) | (Inherited from TemplateControl.) | |
Finalize | (Inherited from Object.) | |
FindControl(String) | (Inherited from Control.) | |
FindControl(String, Int32) | (Inherited from Control.) | |
Focus | (Inherited from Control.) | |
FrameworkInitialize | (Inherited from TemplateControl.) | |
GetActualControlName |
This method is useful to determine the actual name attribute for a server control that will be used in EPT and that has a name property. ASP.net servercontrols will sometimes generate a name attribute with $ in it. This method will translate the name to the same that is used in EPT.
| |
GetCookie(String) |
Returns an HTTP cookie
| |
GetCookie(String, String) |
Returns an HTTP cookie
| |
GetCredentialCache |
Returns the a System.Net.CredentialCache object used when
making HTTPrequests.
| |
GetDesignModeState | (Inherited from Control.) | |
GetGlobalResourceObject(String, String) | (Inherited from TemplateControl.) | |
GetGlobalResourceObject(String, String, Type, String) | (Inherited from TemplateControl.) | |
GetHashCode | (Inherited from Object.) | |
GetLocalResourceObject(String) | (Inherited from TemplateControl.) | |
GetLocalResourceObject(String, Type, String) | (Inherited from TemplateControl.) | |
GetType | (Inherited from Object.) | |
GetWebRequest(String, String) |
Returns a WebRequest containing the response to the request to
a Uniform Resource Identifier (URI).
All cookies and credentials are
stored in session variables.
| |
GetWebRequest(String, String, String, String, Boolean, String) |
Returns a WebRequest containing the response to the request to
a Uniform Resource Identifier (URI).
| |
GetWebResponse(String, String) |
Returns a WebResponse containing the response to the request to
a Uniform Resource Identifier (URI).
All cookies and credentials are
stored in session variables.
| |
GetWebResponse(String, String, String, String, Boolean, String) |
Returns a WebResponse containing the response to the request to
a Uniform Resource Identifier (URI).
| |
HasControls | (Inherited from Control.) | |
HasEvents | (Inherited from Control.) | |
InitializeAsUserControl | (Inherited from UserControl.) | |
IsLiteralContent | (Inherited from Control.) | |
LoadControl(String) | (Inherited from TemplateControl.) | |
LoadControl(Type, Object) | (Inherited from TemplateControl.) | |
LoadControlState | (Inherited from Control.) | |
LoadTemplate | (Inherited from TemplateControl.) | |
LoadViewState | (Inherited from UserControl.) | |
MapPath | (Inherited from UserControl.) | |
MapPathSecure | (Inherited from Control.) | |
MemberwiseClone | (Inherited from Object.) | |
OnAbortTransaction | (Inherited from TemplateControl.) | |
OnBubbleEvent | (Inherited from Control.) | |
OnCommitTransaction | (Inherited from TemplateControl.) | |
OnDataBinding | (Inherited from Control.) | |
OnError | (Inherited from TemplateControl.) | |
OnInit |
Raises the Init event.
(Overrides UserControlOnInit(EventArgs).) | |
OnLoad | (Inherited from Control.) | |
OnPreRender | (Inherited from Control.) | |
OnUnload | (Inherited from Control.) | |
OpenFile | (Inherited from Control.) | |
ParseControl(String) | (Inherited from TemplateControl.) | |
ParseControl(String, Boolean) | (Inherited from TemplateControl.) | |
RaiseBubbleEvent | (Inherited from Control.) | |
ReadStringResource | (Inherited from TemplateControl.) | |
RemovedControl | (Inherited from Control.) | |
Render | (Inherited from Control.) | |
RenderChildren | (Inherited from Control.) | |
RenderControl(HtmlTextWriter) | (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | (Inherited from Control.) | |
ResolveAdapter | (Inherited from Control.) | |
ResolveClientUrl | (Inherited from Control.) | |
ResolveEptDocument |
Resolves the ept document.
| |
ResolveUrl | (Inherited from Control.) | |
SaveControlState | (Inherited from Control.) | |
SaveViewState | (Inherited from UserControl.) | |
SendMail |
Sends a mail through the mail server on the web server.
| |
SetCookie(String, String) |
Sets the value of an HTTP cookie.
| |
SetCookie(String, String, DateTime) |
Sets the value of an HTTP cookie with a specific expiration value.
| |
SetCookie(String, String, String) |
Sets the value of an HTTP cookie with a sub-cookie.
| |
SetCookie(String, String, String, DateTime) |
Sets the value of an HTTP cookie with a specific expiration value.
| |
SetDesignModeState | (Inherited from Control.) | |
SetRenderMethodDelegate | (Inherited from Control.) | |
SetStringResourcePointer | (Inherited from TemplateControl.) | |
TestDeviceFilter | (Inherited from TemplateControl.) | |
ToString | (Inherited from Object.) | |
TrackViewState | (Inherited from Control.) | |
WriteUTF8ResourceString | (Inherited from TemplateControl.) | |
XPath(String) | (Inherited from TemplateControl.) | |
XPath(String, IXmlNamespaceResolver) | (Inherited from TemplateControl.) | |
XPath(String, String) | (Inherited from TemplateControl.) | |
XPath(String, String, IXmlNamespaceResolver) | (Inherited from TemplateControl.) | |
XPathSelect(String) | (Inherited from TemplateControl.) | |
XPathSelect(String, IXmlNamespaceResolver) | (Inherited from TemplateControl.) |
Events
Name | Description | |
---|---|---|
AbortTransaction | (Inherited from TemplateControl.) | |
CommitTransaction | (Inherited from TemplateControl.) | |
DataBinding | (Inherited from Control.) | |
Disposed | (Inherited from Control.) | |
Error | (Inherited from TemplateControl.) | |
Init | (Inherited from Control.) | |
Load | (Inherited from Control.) | |
PreRender | (Inherited from Control.) | |
Unload | (Inherited from Control.) |
Fields
Name | Description | |
---|---|---|
CS_ANONYMOUS_SESSION_IDENTIFIER |
Defines the session identifier for an anonymous user.
|
See Also