TreeNavigatorComponent Properties Content Studio 5.7 SDK
Content Studio Web Content Management System

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

The TreeNavigatorComponent type exposes the following members.

Properties

  Name Description
Protected property 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.)
Public property AllowNavigateToRoot
Sets or gets a value that specifies if a navigator is allowed to navigate to the tree root document. The default value is false.
Public property 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.)
Protected property CanHaveFirst
Gets a value that indicates if there is a first document in the hierarchy related to the position of ActualDocumentID. This is a dynamic property that returns false until data has been loaded
Protected property CanHaveLast
Gets a value that indicates if there is a last document in the hierarchy related to the position of ActualDocumentID. This is a dynamic property that returns false until data has been loaded
Protected property CanHaveNext
Gets a value that indicates if there is a next document in the hierarchy related to the position of ActualDocumentID. This is a dynamic property that returns false until data has been loaded
Protected property CanHavePrevious
Gets a value that indicates if there is a previous document in the hierarchy related to the position of ActualDocumentID. This is a dynamic property that returns false until data has been loaded
Public property ComponentName
Gets the name of the component
(Inherited from ActiveScriptingBase.)
Public property Conformance
Gets a value which specifies which type of code a component can generate.
(Inherited from ActiveScriptingBase.)
Protected property Code example 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.)
Protected property 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.)
Public property ElementType
Gets a value which specifies the type of outer element the component generates.
(Inherited from ActiveScriptingBase.)
Public property Encoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Protected property 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.)
Protected property 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.)
Protected property 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.)
Protected property Page
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Public property PresentationTemplate
Sets or gets a value that specifies an optional presentation template to use. This property is only relevant to use with EPT. The default value is zero (no presentation template).
Protected property RunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
Protected property 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.)
Protected property 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.)
Protected property 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.)
Public property 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.)
Top
See Also

Reference