UserControlBase Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[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 user control.
Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        ContentStudio.SiteUserControlBase

Namespace: ContentStudio.Site
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public abstract class UserControlBase : UserControl, 
	IUserSessionObject

The UserControlBase type exposes the following members.

Constructors

  NameDescription
Protected methodUserControlBase
Initializes the current user control.
Top
Properties

  NameDescription
Protected propertyAdapter (Inherited from Control.)
Public propertyAdminUrl
Gets the Url for the administrative interface.
Public propertyApplication (Inherited from UserControl.)
Public propertyAppRelativeTemplateSourceDirectory (Inherited from Control.)
Public propertyAppRelativeVirtualPath (Inherited from TemplateControl.)
Public propertyAttributes (Inherited from UserControl.)
Protected propertyAutoHandlers Obsolete. (Inherited from TemplateControl.)
Public propertyBindingContainer (Inherited from Control.)
Public propertyCache (Inherited from UserControl.)
Public propertyCachePolicy (Inherited from UserControl.)
Protected propertyChildControlsCreated (Inherited from Control.)
Public propertyClientID (Inherited from Control.)
Protected propertyClientIDSeparator (Inherited from Control.)
Protected propertyContext (Inherited from Control.)
Public propertyControls (Inherited from Control.)
Public propertyCS_ConnectionId
Gets a value that uniquely identifies the current web site.
Public propertyCode exampleCS_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.
Public propertyCS_DocumentType
Gets the Document Type of the current document
Public propertyCS_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).
Public propertyCS_EditId
Gets a the edit ID.
Public propertyCS_HasMetaData
Gets a value that indicates if the current document has meta data.
Public propertyCS_InsertedCategoryId
Gets the category ID of the current document
Public propertyCS_InsertedDocumentId
Gets the document ID for the current document. In a presentation template, this is the presented document.
Public propertyCS_IsInAdmin
Gets a value that indicates whether the current user is logged on to Content Studio administration site.
Public propertyCS_IsInPreView
Gets a value that tells if the current page is in preview mode
Public propertyCS_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
Public propertyCS_LiveObjectData
Public propertyCS_LiveObjectXML
Gets or sets an XML definition that contains the parameter definition for a Live Object.
Public propertyCS_MLCPageLanguage
Gets the MLC language code for the current page.
Public propertyCS_MLCPreferredLanguage
Gets the preferred MLC language code.
Public propertyCS_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.
Public propertyCS_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.
Public propertyCS_RootDocumentId
Gets a value that contains the root document ID retrieved from a query string.
Public propertyCS_RootPresentationTemplateId
Gets the root presentation template ID retrieved from a query string.
Public propertyCS_RootRefId
Gets the root referrer document ID retrieved from a query string.
Public propertyCS_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.
Public propertyCS_ViewState
Gets the view state from the current page.
Public propertyCS_XHTML
Gets a value that indicates whether or not the current page is written in XHtml.
Public propertyCS_XHTML_TRAIL
Gets a value that is a slash ("/") if the page uses XHTML, otherwise it is an empty string.
Public propertyCS_XHTMLStrict
Gets a value that indicates whether or not the current page is written in XHtml 1.0 Strict or XHtml 1.1.
Protected propertyDesignMode (Inherited from Control.)
Public propertyEnableTheming (Inherited from TemplateControl.)
Public propertyEnableViewState (Inherited from Control.)
Public propertyEPTDocumentID
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.
Protected propertyEvents (Inherited from Control.)
Protected propertyHasChildViewState (Inherited from Control.)
Public propertyID (Inherited from Control.)
Protected propertyIdSeparator (Inherited from Control.)
Protected propertyIsChildControlStateCleared (Inherited from Control.)
Public propertyIsPostBack (Inherited from UserControl.)
Protected propertyIsTrackingViewState (Inherited from Control.)
Protected propertyIsViewStateEnabled (Inherited from Control.)
Protected propertyLoadViewStateByID (Inherited from Control.)
Public propertyNamingContainer (Inherited from Control.)
Public propertyPage
Gets a reference to the Page instance that contains the server control.
Public propertyParent (Inherited from Control.)
Public propertyRequest (Inherited from UserControl.)
Public propertyResponse (Inherited from UserControl.)
Public propertyRewriteAppRelativeVirtualPath
Gets or sets a value indicating whether cs should rewrite the AppRelativeVirtualPath path to ~/default.aspx.
Public propertyServer (Inherited from UserControl.)
Public propertySession (Inherited from UserControl.)
Public propertySite (Inherited from Control.)
Public propertySkinID (Inherited from Control.)
Protected propertySupportAutoEvents (Inherited from TemplateControl.)
Protected propertyTagKey
Gets the HtmlTextWriterTag value that corresponds to this Web user control. This property is used primarily by control developers.
Protected propertyTagName
Gets the name of the control tag. This property is used primarily by control developers.
Public propertyTemplateControl (Inherited from Control.)
Public propertyTemplateSourceDirectory (Inherited from Control.)
Public propertyTrace (Inherited from UserControl.)
Public propertyUniqueID (Inherited from Control.)
Protected propertyViewState (Inherited from Control.)
Protected propertyViewStateIgnoresCase (Inherited from Control.)
Public propertyVisible (Inherited from Control.)
Top
Methods

  NameDescription
Protected methodAddedControl (Inherited from Control.)
Protected methodAddParsedSubObject (Inherited from Control.)
Public methodApplyStyleSheetSkin (Inherited from Control.)
Public methodBuildHTMLException(String, String, Boolean)
Returns HTML code for a CS exception.
Public methodBuildHTMLException(String, CSException, Boolean, Boolean)
Returns HTML code for a CS exception.
Public methodBuildHTMLException(String, CSException, Boolean, Boolean, CSApplicationSupportedLanguages)
Returns HTML code for a CS exception.
Protected methodBuildProfileTree (Inherited from Control.)
Public methodBuildQueryString(String)
Returns a query string from a Request.QueryString with an '&' (ampersand) at the end.
Public methodBuildQueryString(NameValueCollection, String)
Returns a query string from a collection with an '&' (ampersand) at the end.
Protected methodClearChildControlState (Inherited from Control.)
Protected methodClearChildState (Inherited from Control.)
Protected methodClearChildViewState (Inherited from Control.)
Protected methodConstruct (Inherited from TemplateControl.)
Protected methodCreateChildControls (Inherited from Control.)
Protected methodCreateControlCollection (Inherited from Control.)
Protected methodCreateResourceBasedLiteralControl (Inherited from TemplateControl.)
Public methodCS_AddLiveObjectParameterValue
Adds a parameter value to a Live Object
Public methodCS_ClearLiveObjectParameterValues
Clear all data parameters from a Live Object
Public methodCS_CreateEditIcon(CategoryId, DocumentId, String)
Returns HTML code for displaying a standard edit icon in web view, without any permission checks.
Public methodCS_CreateEditIcon(CategoryId, DocumentId, String, Boolean)
Returns HTML code for displaying a standard edit icon in web view.
Public methodCS_CreateEditIcon(CategoryId, DocumentId, DocumentId, String, Boolean, SiteBaseCS_EditIconTypes)
Returns HTML code for displaying an edit icon in web view.
Public methodCS_FixJavaString
Returns a string where the escape character sequences is adjusted to be used with Javascript.
Public methodCode exampleCS_GetAnyEPTDocument
Returns the published content of any XML document as an EPTXmlTextParser.
Public methodCS_GetParentPage
Returns a reference to the parent document page.
Public methodCS_GetParentPage(SiteBase)
Returns a reference to the parent document page.
Public methodCS_GetRootPage
Returns a reference to the root document page.
Public methodCS_GetRootPage(SiteBase)
Returns a reference to the root document page.
Public methodCS_ReadFromApplicationCache
Returns the data from the application cache
Public methodCS_ReadLiveObjectParameterValue
Returns the value that has been added to a Live Object with the supplied key.
Public methodCS_ReplaceRelativeUrls
Returns a string where all occurrences of relative URL's in a string containing HTML is replaced with absolute URL's.
Public methodCS_SetApplicationCache
Stores a string in cache.
Public methodCS_TranslateMessage(CSException)
Returns a translated error message.
Public methodCS_TranslateMessage(CSApplicationSupportedLanguages, CSException)
Returns a translated error message.
Public methodDataBind (Inherited from Control.)
Protected methodDataBind(Boolean) (Inherited from Control.)
Protected methodDataBindChildren (Inherited from Control.)
Public methodDesignerInitialize (Inherited from UserControl.)
Public methodDispose (Inherited from Control.)
Protected methodEnsureChildControls (Inherited from Control.)
Protected methodEnsureID (Inherited from Control.)
Public methodEPT_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.
Public methodEPT_GetFieldValue Obsolete.
When overriden in derived classes, obtains the value of a certain field in an EPT-document.
Public methodEquals (Inherited from Object.)
Protected methodEval(String) (Inherited from TemplateControl.)
Protected methodEval(String, String) (Inherited from TemplateControl.)
Protected methodFinalize (Inherited from Object.)
Public methodFindControl(String) (Inherited from Control.)
Protected methodFindControl(String, Int32) (Inherited from Control.)
Public methodFocus (Inherited from Control.)
Protected methodFrameworkInitialize (Inherited from TemplateControl.)
Public methodGetActualControlName
This method is usefull 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.
Public methodGetCookie(String)
Returns an HTTP cookie
Public methodGetCookie(String, String)
Returns an HTTP cookie
Public methodGetCredentialCache
Returns the a System.Net.CredentialCache object used when making HTTPrequests.
Protected methodGetDesignModeState (Inherited from Control.)
Protected methodGetGlobalResourceObject(String, String) (Inherited from TemplateControl.)
Protected methodGetGlobalResourceObject(String, String, Type, String) (Inherited from TemplateControl.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetLocalResourceObject(String) (Inherited from TemplateControl.)
Protected methodGetLocalResourceObject(String, Type, String) (Inherited from TemplateControl.)
Public methodGetType (Inherited from Object.)
Public methodGetWebRequest(String, String)
Returns a WebReques containing the response to the request to a Uniform Resource Identifier (URI). All cookies and credentials are stored in session variables.
Public methodGetWebRequest(String, String, String, String, Boolean, String)
Returns a WebRequest containing the response to the request to a Uniform Resource Identifier (URI).
Public methodGetWebResponse(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.
Public methodGetWebResponse(String, String, String, String, Boolean, String)
Returns a WebResponse containing the response to the request to a Uniform Resource Identifier (URI).
Public methodHasControls (Inherited from Control.)
Protected methodHasEvents (Inherited from Control.)
Public methodInitializeAsUserControl (Inherited from UserControl.)
Protected methodIsLiteralContent (Inherited from Control.)
Public methodLoadControl(String) (Inherited from TemplateControl.)
Public methodLoadControl(Type, Object) (Inherited from TemplateControl.)
Protected methodLoadControlState (Inherited from Control.)
Public methodLoadTemplate (Inherited from TemplateControl.)
Protected methodLoadViewState (Inherited from UserControl.)
Public methodMapPath (Inherited from UserControl.)
Protected methodMapPathSecure (Inherited from Control.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnAbortTransaction (Inherited from TemplateControl.)
Protected methodOnBubbleEvent (Inherited from Control.)
Protected methodOnCommitTransaction (Inherited from TemplateControl.)
Protected methodOnDataBinding (Inherited from Control.)
Protected methodOnError (Inherited from TemplateControl.)
Protected methodOnInit
Raises the Init event.
(Overrides UserControlOnInit(EventArgs).)
Protected methodOnLoad (Inherited from Control.)
Protected methodOnPreRender (Inherited from Control.)
Protected methodOnUnload (Inherited from Control.)
Protected methodOpenFile (Inherited from Control.)
Public methodParseControl(String) (Inherited from TemplateControl.)
Public methodParseControl(String, Boolean) (Inherited from TemplateControl.)
Protected methodRaiseBubbleEvent (Inherited from Control.)
Public methodReadStringResource (Inherited from TemplateControl.)
Protected methodRemovedControl (Inherited from Control.)
Protected methodRender (Inherited from Control.)
Protected methodRenderChildren (Inherited from Control.)
Public methodRenderControl(HtmlTextWriter) (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Protected methodResolveAdapter (Inherited from Control.)
Public methodResolveClientUrl (Inherited from Control.)
Protected methodResolveEptDocument
Resolves the ept document.
Public methodResolveUrl (Inherited from Control.)
Protected methodSaveControlState (Inherited from Control.)
Protected methodSaveViewState (Inherited from UserControl.)
Public methodSendMail
Sends a mail through the mail server on the web server.
Public methodSetCookie(String, String)
Sets the value of an HTTP cookie.
Public methodSetCookie(String, String, DateTime)
Sets the value of an HTTP cookie with a specific expiration value.
Public methodSetCookie(String, String, String)
Sets the value of an HTTP cookie with a sub-cookie.
Public methodSetCookie(String, String, String, DateTime)
Sets the value of an HTTP cookie with a specific expiration value.
Protected methodSetDesignModeState (Inherited from Control.)
Public methodSetRenderMethodDelegate (Inherited from Control.)
Protected methodSetStringResourcePointer (Inherited from TemplateControl.)
Public methodTestDeviceFilter (Inherited from TemplateControl.)
Public methodToString (Inherited from Object.)
Protected methodTrackViewState (Inherited from Control.)
Protected methodWriteUTF8ResourceString (Inherited from TemplateControl.)
Protected methodXPath(String) (Inherited from TemplateControl.)
Protected methodXPath(String, IXmlNamespaceResolver) (Inherited from TemplateControl.)
Protected methodXPath(String, String) (Inherited from TemplateControl.)
Protected methodXPath(String, String, IXmlNamespaceResolver) (Inherited from TemplateControl.)
Protected methodXPathSelect(String) (Inherited from TemplateControl.)
Protected methodXPathSelect(String, IXmlNamespaceResolver) (Inherited from TemplateControl.)
Top
Events

  NameDescription
Public eventAbortTransaction (Inherited from TemplateControl.)
Public eventCommitTransaction (Inherited from TemplateControl.)
Public eventDataBinding (Inherited from Control.)
Public eventDisposed (Inherited from Control.)
Public eventError (Inherited from TemplateControl.)
Public eventInit (Inherited from Control.)
Public eventLoad (Inherited from Control.)
Public eventPreRender (Inherited from Control.)
Public eventUnload (Inherited from Control.)
Top
Fields

  NameDescription
Public fieldStatic memberCS_ANONYMOUS_SESSION_IDENTIFIER
Defines the session identifier for an anonymous user.
Top
See Also

Reference