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

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

The TreeNavigator 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.
(Inherited from TreeNavigatorComponent.)
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
(Inherited from TreeNavigatorComponent.)
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
(Inherited from TreeNavigatorComponent.)
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
(Inherited from TreeNavigatorComponent.)
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
(Inherited from TreeNavigatorComponent.)
Public property ComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public property Conformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
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.)
Public property DisplayFirst
Sets or gets a value that specifies whether to displays a link (button) to the first document in the hierarchy The default value is true.
Public property DisplayLast
Sets or gets a value that specifies whether to displays a link (button) to the last document in the hierarchy The default value is true.
Public property DisplayNavigatorFrame
Sets or gets a value that specifies whether to display a frame (field set) around the navigator or not. The default value is false.
Public property DisplayNext
Sets or gets a value that specifies whether to displays a link (button) to the next document in the hierarchy or not. The default value is true.
Public property DisplayPrevious
Sets or gets a value that specifies whether to displays a link (button) to the previous document in the hierarchy or not. The default value is true.
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.
(Overrides ActiveScriptingBaseElementType.)
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.)
Public property FirstImage
Sets or gets the location of an image to insert for the First link. The default value is an empty string (no image is used).
Public property FirstImageAlt
Sets or gets a value the ALT attribute of the image of the First link (button) item. If this property is an empty string, the value of FirstText is used. The default value is an empty string.
Public property FirstImageStyle
Sets or gets a value the STYLE attribute of the image of the First link (button) item. If this property is an empty string the attribute is not used. The default value is an empty string.
Public property FirstText
Sets or gets the text to display in the First link (button). The default value is "First".
Public property FrameStyle
Sets or gets the STYLE attribute of the frame (field set) surrounding the navigator elements. The default value is an empty string. This property is relevant only if DisplayNavigatorFrame is set to true.
Public property FrameText
Sets or gets the text to display in the frame (legend). The default value is an empty string. This property is relevant only if DisplayNavigatorFrame is set to true.
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.)
Public property LastImage
Sets or gets the location of an image to insert for the Last link. The default value is an empty string (no image is used).
Public property LastImageAlt
Sets or gets a value the ALT attribute of the image of the Last link (button) item. If this property is an empty string, the value of LastText is used. The default value is an empty string.
Public property LastImageStyle
Sets or gets a value the STYLE attribute of the image of the Next link (button) item. If this property is an empty string the attribute is not used. The default value is an empty string.
Public property LastText
Sets or gets the text to display in the Last link (button). The default value is "Last"
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.)
Public property LinkClass
Sets or gets the CLASS attribute to be applied on each link (button). The default value is an empty string (the attribute is not used).
Public property NavigatorClass
Sets or gets the CLASS attribute of DIV element hosting the navigator. This is useful in an EPT presentation template only. The default value is an empty string (the attribute is not used).
Public property NavigatorIsButton
Sets or gets a value that specifies if the navigator should be a button (rather than a plain link). Setting this property to true requires Javascript to be activated in the client browser software. The default value is false.
Public property NavigatorStaticClass
Sets or gets the CLASS attribute to be applied on block element surrounding the navigator. This is useful in an EPT presentation template only. The default value is an empty string (the attribute is not used). This value is ignored if the NavigatorClass property is specified.
Public property NavigatorStyle
Sets or gets the STYLE attribute of the DIV element hosting the navigator. The default value is an empty string
Public property NextImage
Sets or gets the location of an image to insert for the Next link. The default value is an empty string (no image is used).
Public property NextImageAlt
Sets or gets a value the ALT attribute of the image of the Next link (button) item. If this property is an empty string, the value of NextText is used. The default value is an empty string.
Public property NextImageStyle
Sets or gets a value the STYLE attribute of the image of the Next link (button) item. If this property is an empty string the attribute is not used. The default value is an empty string.
Public property NextText
Sets or gets the text to display in the Next link (button). The default value is "Next"
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).
(Inherited from TreeNavigatorComponent.)
Public property PreviousImage
Sets or gets the location of an image to insert for the Previous link. The default value is an empty string (no image is used).
Public property PreviousImageAlt
Sets or gets a value the ALT attribute of the image of the Previous link (button) item. If this property is an empty string, the value of PreviousText is used. The default value is an empty string.
Public property PreviousImageStyle
Sets or gets a value the STYLE attribute of the image of the Previous link (button) item. If this property is an empty string the attribute is not used. The default value is an empty string.
Public property PreviousText
Sets or gets the text to display in the Previous link (button). The default value is "Previous"
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