Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingDocumentBase
ContentStudio.Site.ActiveScripting.DocumentDocumentLevelInformation
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
To use this class, create an instance of this object, set up the
properties and call the Invoke method with an appropriate set of parameters.
This class can throw exceptions, thus your code should be wrapped
within try/catch statements in order to avoid the entire page to crash.
This class generates inline code, thus you must wrap it into a block
element to make the page validate according to the HTML/XHTML
regulations.
The generated code is fully HTML/XHTML strict compatible.
[This is preliminary documentation and is subject to change.]
Inserts level dependent information for a certain document This class
writes code to the supplied stream or the default response stream.
The DocumentLevelInformation class acts as the underlying engine
for the Document level information AS component.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingDocumentBase
ContentStudio.Site.ActiveScripting.DocumentDocumentLevelInformation
Namespace: ContentStudio.Site.ActiveScripting.Document
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The DocumentLevelInformation type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DocumentLevelInformation |
Constructs a new instance of the DocumentLevelInformation class
that writes to the default response stream
| |
DocumentLevelInformation(Stream) |
Constructs a new instance of the DocumentLevelInformation class
that writes to the supplied stream
|
Properties
Name | Description | |
---|---|---|
BackwardsComponentCompatibilityMode |
Sets or gets a value that indicates whether the code runs in backwards
compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.) | |
ClassName |
Sets or gets the name of a CSS class that is used to supply text
formatting. The default value is an empty string
| |
ComponentName | Gets the name of the component (Overrides ActiveScriptingBaseComponentName.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.) | |
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.
(Inherited from CodeBase.) | |
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.) | |
Encoding |
Sets or gets the encoding the component uses. The default encoding is
the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.) | |
Page |
A reference to the current context page.
This will initialize in the constructor of this class.
(Inherited from CodeBase.) | |
RootStartLevel |
Sets or gets the root document's level. Logically, this value is always
1 but can be any integer value. Set this parameter blank or zero to
omit the root level. The default value is zero
| |
RunningUserControl |
Gets the current running user control.
(Inherited from CodeBase.) | |
UseRootDocument |
Sets or gets a value that specifies if you want to use the root
document information. This is true if you use this component in
an included document. The default value is false |
Methods
Name | Description | |
---|---|---|
BuildHTMLComponentException |
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GenerateLinkTargetAttribute |
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.) | |
GetCorrectField |
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.) | |
GetHashCode | (Inherited from Object.) | |
GetLevelData |
Gets the level data in the format 1.3.4.2 | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component and writes its content into the specified stream
| |
MemberwiseClone | (Inherited from Object.) | |
ReadFromApplicationCache |
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.) | |
RenderLevelInfo |
Renders the level information passed in. Derived classes can override
this method to supply their own rendering logic. It is also possible to
change the LevelInfo retrieved from the GetLevelData
method to a customized format (ex. i.ii.ix)
| |
SetApplicationCache |
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.) | |
SyncronizeMLC |
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.) | |
ToString | (Inherited from Object.) | |
WriteAttribute(TextWriter, String, String) |
Writes an attribute string to the supplied stream, unless Value is
an empty string or null (Inherited from ActiveScriptingBase.) | |
WriteAttribute(TextWriter, String, String, Boolean) |
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.) |
Remarks
See Also