Content Studio Web Content Management System
Top
[This is preliminary documentation and is subject to change.]
The TreeInfo type exposes the following members.
Properties
Name | Description | |
---|---|---|
ActualDocumentID |
Gets the document ID to display information for. This property returns
different result depending on whether the document is an included
document or not, and depending on the value of the UseRoot
property.
(Inherited from TreeInfoComponent.) |
|
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.) |
|
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.) |
|
DocumentName |
Gets name of the document indicated by the ActualDocumentID
property.
This is a dynamic property that gets its value after that the LoadDynamicData
method is called. The initial value is an empty string.
(Inherited from TreeInfoComponent.) |
|
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.) |
|
Index |
Gets the index (ordinal number) in the indexed tree of the document
indicated by the ActualDocumentID property. The index of the
root document of the hierarchy is zero.
This is a dynamic property that gets its value after that the LoadDynamicData
method is called. The initial value is zero.
(Inherited from TreeInfoComponent.) |
|
InformationString |
Sets or gets the string that acts as a template to describe content of
a document tree. The string may contain any of the constants below,
which when used by FormatInformationString will be replaced with
the corresponding current values.
The default value is "$pageno$ of $total$"
$pageno$ The ordinal (page) number of the document within the
hierarchy, not including the root document.
$total$ The total number of documents in the hierarchy, not
including the root document.
$label$ The numeric level information, not including the root
document. Example: "2.2.8"$name$ The name of the document
$position$ The position of this document relative its siblings.
|
|
LevelInformation |
Gets level information text of document indicated by the ActualDocumentID
property (example: "1.2.4").
This is a dynamic property that gets its value after that the LoadDynamicData
method is called. The initial value is an empty string.
(Inherited from TreeInfoComponent.) |
|
output |
Gets the stream that the component writes to. This property is
initialized in inherited classes constructors, and returns null if
the component are writing to the default response stream. The default
value is null.
(Inherited from TreeInfoComponent.) |
|
Page |
A reference to the current context page.
This will initialize in the constructor of this class.
(Inherited from CodeBase.) |
|
RunningUserControl |
Gets the current running user control.
(Inherited from CodeBase.) |
|
SiblingIndex |
Gets the index (position) of the document indicated by the ActualDocumentID
property relative to its siblings.
This is a dynamic property that gets its value after that the LoadDynamicData
method is called. The initial value is zero.
(Inherited from TreeInfoComponent.) |
|
Total |
Gets the total number of documents in the indexed tree, not including
the root document.
This is a dynamic property that gets its value after that the LoadDynamicData
method is called. The initial value is zero.
(Inherited from TreeInfoComponent.) |
|
TreeID |
Gets the ultimate root document ID of the indexed tree. If this
property is set to zero, the document is not a part of an indexed tree.
This is a dynamic property that gets its value after that the LoadDynamicData
method is called. The initial value is zero.
(Inherited from TreeInfoComponent.) |
|
UseRoot |
Sets or gets a value that indicates whether this component is used in a
document that is included in another document. This will cause the
component to use the document that this document is included in rather
than the current document. The default value is false.
(Inherited from TreeInfoComponent.) |
See Also