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

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

Writes a HTML navigator that can be used to navigate within an indexed hierarchy, to the supplied stream or the default response stream. The TreeNavigator class acts as the underlying engine for the Tree navigator AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScripting.MenuTreeInfoComponent
        ContentStudio.Site.ActiveScripting.MenuTreeNavigatorComponent
          ContentStudio.Site.ActiveScripting.MenuTreeNavigator

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

public class TreeNavigator : TreeNavigatorComponent

The TreeNavigator type exposes the following members.

Constructors

  NameDescription
Public methodTreeNavigator
Constructs a new instance of the TreeNavigator class that writes to the default response stream.
Public methodTreeNavigator(Stream)
Constructs a new instance of the TreeNavigator 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 propertyAllowNavigateToRoot
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 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.)
Protected propertyCanHaveFirst
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 propertyCanHaveLast
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 propertyCanHaveNext
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 propertyCanHavePrevious
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 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.)
Public propertyDisplayFirst
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 propertyDisplayLast
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 propertyDisplayNavigatorFrame
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 propertyDisplayNext
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 propertyDisplayPrevious
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 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.)
Public propertyFirstImage
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 propertyFirstImageAlt
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 propertyFirstImageStyle
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 propertyFirstText
Sets or gets the text to display in the First link (button). The default value is "First".
Public propertyFrameStyle
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 propertyFrameText
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 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 propertyLastImage
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 propertyLastImageAlt
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 propertyLastImageStyle
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 propertyLastText
Sets or gets the text to display in the Last link (button). The default value is "Last"
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.)
Public propertyLinkClass
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 propertyNavigatorClass
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 propertyNavigatorIsButton
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 propertyNavigatorStaticClass
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 propertyNavigatorStyle
Sets or gets the STYLE attribute of the DIV element hosting the navigator. The default value is an empty string
Public propertyNextImage
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 propertyNextImageAlt
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 propertyNextImageStyle
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 propertyNextText
Sets or gets the text to display in the Next link (button). The default value is "Next"
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.)
Public propertyPresentationTemplate
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 propertyPreviousImage
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 propertyPreviousImageAlt
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 propertyPreviousImageStyle
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 propertyPreviousText
Sets or gets the text to display in the Previous link (button). The default value is "Previous"
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 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.)
Protected methodGetFirstDocument
Returns the ID of first document in the document hierarchy, related to the position of ActualDocumentID.
(Inherited from TreeNavigatorComponent.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetHref
Returns an URL encoded hyperlink reference (link) to the document to navigate to. Query string values are preserved.
(Inherited from TreeNavigatorComponent.)
Protected methodGetLastDocument
Returns the ID of last document in the document hierarchy, related to the position of ActualDocumentID.
(Inherited from TreeNavigatorComponent.)
Protected methodGetNextDocument
Returns the ID of next document in the document hierarchy, related to the position of ActualDocumentID.
(Inherited from TreeNavigatorComponent.)
Protected methodGetPreviousDocument
Returns the ID of previous document in the document hierarchy, related to the position of ActualDocumentID.
(Inherited from TreeNavigatorComponent.)
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 methodRenderNavigationItem
Renders the HTML code that creates a navigation element. Derived classes can override this method to implement their own rendering.
(Overrides TreeNavigatorComponentRenderNavigationItem(StreamWriter, TreeNavigatorComponentNavigatorElement).)
Protected methodRenderNavigator
Renders the HTML code that creates the navigator. Derived classes can override this method to implement their own rendering.
(Overrides TreeNavigatorComponentRenderNavigator(StreamWriter).)
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