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

[This is preliminary documentation and is subject to change.]

This abstract class acts as a base class for document type management for the Content Studio components.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingDocumentBase
        More...

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

public abstract class DocumentBase : ActiveScriptingBase

The DocumentBase type exposes the following members.

Constructors

  NameDescription
Protected methodDocumentBase
Constructs a new instance of the DocumentBase class.
Protected methodDocumentBase(SiteBase)
Constructs a new instance of the DocumentBase class.
Protected methodDocumentBase(UserControlBase)
Constructs a new instance of the DocumentBase class.
Protected methodDocumentBase(SiteBase, UserControlBase)
Constructs a new instance of the DocumentBase class.
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyComponentName
Gets the name of the component
(Inherited from ActiveScriptingBase.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Inherited from ActiveScriptingBase.)
Protected 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.
(Inherited from CodeBase.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Inherited from ActiveScriptingBase.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Protected propertyPage
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Protected propertyRunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
Top
Methods

  NameDescription
Protected methodBuildHTMLComponentException
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGenerateLinkTargetAttribute
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.)
Protected methodGetCorrectField
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodReadFromApplicationCache
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodSetApplicationCache
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodSyncronizeMLC
Provides support for components that needs to be MLC aware, by localizing the supplied category or presentation template from the current document, or the preferred language of the visitor.
(Inherited from ActiveScriptingBase.)
Public methodToString (Inherited from Object.)
Protected methodWriteAttribute(TextWriter, String, String)
Writes an attribute string to the supplied stream, unless Value is an empty string or null
(Inherited from ActiveScriptingBase.)
Protected methodWriteAttribute(TextWriter, String, String, Boolean)
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.)
Top
See Also

Reference

Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingDocumentBase
        ContentStudio.Site.ActiveScripting.DocumentCountChildren
        ContentStudio.Site.ActiveScripting.DocumentDeleteDocument
        ContentStudio.Site.ActiveScripting.DocumentDocumentInformation
        ContentStudio.Site.ActiveScripting.DocumentDocumentLevelInformation
        ContentStudio.Site.ActiveScripting.DocumentInsertAuthor
        ContentStudio.Site.ActiveScripting.DocumentInsertBacklink
        ContentStudio.Site.ActiveScripting.DocumentInsertChildren
        ContentStudio.Site.ActiveScripting.DocumentInsertCommaSeparatedDocuments
        ContentStudio.Site.ActiveScripting.DocumentInsertDocument
        ContentStudio.Site.ActiveScripting.DocumentInsertDocumentFromURL
        ContentStudio.Site.ActiveScripting.DocumentInsertMultipleDocuments
        ContentStudio.Site.ActiveScripting.DocumentInsertNumberOfChildren
        ContentStudio.Site.ActiveScripting.DocumentLastModified
        ContentStudio.Site.ActiveScripting.DocumentListChildren
        ContentStudio.Site.ActiveScripting.DocumentListDocuments20
        ContentStudio.Site.ActiveScripting.DocumentOpenWindow
        ContentStudio.Site.ActiveScripting.DocumentRandomizeDocuments
        ContentStudio.Site.ActiveScripting.DocumentRotateDocuments