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

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

Writes information about a document that is a part of an indexed hierarchy to the supplied stream or the default response stream. Developers inheriting from this class can override the RenderInfo and FormatInfoString methods to create their own information style. The TreeInfo class acts as the underlying engine for the Tree info AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScripting.MenuTreeInfoComponent
        ContentStudio.Site.ActiveScripting.MenuTreeInfo

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

public class TreeInfo : TreeInfoComponent

The TreeInfo type exposes the following members.

Constructors

  NameDescription
Public methodTreeInfo
Constructs a new instance of the TreeInfo class that writes to the default response stream
Public methodTreeInfo(Stream)
Constructs a new instance of the TreeInfo class that writes to the supplied stream
Top
Properties

  NameDescription
Protected propertyActualDocumentID
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.)
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
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
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.)
Protected propertyDocumentName
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.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
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 propertyIndex
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.)
Public propertyInformationString
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.
Protected propertyLevelInformation
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.)
Protected propertyoutput
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.)
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.)
Protected propertySiblingIndex
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.)
Protected propertyTotal
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.)
Protected propertyTreeID
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.)
Public propertyUseRoot
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.)
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 methodFormatInformationString
Returns a string where current values are inserted in the InformationString template. Derived classes can override this method to implement their own formatting mechanism.
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.)
Public methodInvoke
Invokes the component and writes its content into the specified stream
(Overrides TreeInfoComponentInvoke.)
Protected methodLoadDynamicData
Loads dynamic data properties, based on the ActualDocumentID property.
(Inherited from TreeInfoComponent.)
Protected methodLoadDynamicData(Int32)
Loads dynamic data properties.
(Inherited from TreeInfoComponent.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodReadFromApplicationCache
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodRenderInfo
Renders the actual output from the component, as defined by the FormatInformationString method. Derived classes can override this method to implement their own rendering.
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
Remarks

To use this class, create an instance of this object, 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.
See Also

Reference