Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScripting.MenuTreeInfoComponent
ContentStudio.Site.ActiveScripting.MenuTreeNavigatorComponent
ContentStudio.Site.ActiveScripting.MenuTreeNavigator
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This abstract class acts as a base class for components that implements
indexed tree navigation functionality.
Inheritance Hierarchy
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
The TreeNavigatorComponent type exposes the following members.
Constructors
Name | Description | |
---|---|---|
TreeNavigatorComponent |
Constructs a new instance of the TreeNavigatorComponent class
that writes to the default response stream.
| |
TreeNavigatorComponent(Stream) |
Constructs a new instance of the TreeNavigatorComponent class
that writes to the supplied stream.
|
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.) | |
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.
| |
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.) | |
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
| |
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
| |
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
| |
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
| |
ComponentName |
Gets the name of the component
(Inherited from ActiveScriptingBase.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Inherited from ActiveScriptingBase.) | |
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.
(Inherited from ActiveScriptingBase.) | |
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.) | |
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.) | |
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).
| |
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.) |
Methods
Name | Description | |
---|---|---|
BuildHTMLComponentException |
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GenerateLinkTargetAttribute |
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.) | |
GetCorrectField |
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.) | |
GetFirstDocument |
Returns the ID of first document in the document hierarchy, related to
the position of ActualDocumentID.
| |
GetHashCode | (Inherited from Object.) | |
GetHref |
Returns an URL encoded hyperlink reference (link) to the document to
navigate to. Query string values are preserved.
| |
GetLastDocument |
Returns the ID of last document in the document hierarchy, related to
the position of ActualDocumentID.
| |
GetNextDocument |
Returns the ID of next document in the document hierarchy, related to
the position of ActualDocumentID.
| |
GetPreviousDocument |
Returns the ID of previous document in the document hierarchy, related
to the position of ActualDocumentID.
| |
GetType | (Inherited from Object.) | |
Invoke |
Abstract method that should invoke the component and write its content
into the specified stream
(Inherited from TreeInfoComponent.) | |
LoadDynamicData |
Loads dynamic data properties, based on the ActualDocumentID
property.
(Inherited from TreeInfoComponent.) | |
LoadDynamicData(Int32) |
Loads dynamic data properties.
(Inherited from TreeInfoComponent.) | |
MemberwiseClone | (Inherited from Object.) | |
ReadFromApplicationCache |
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.) | |
RenderNavigationItem |
Renders a navigation element. Derived classes can override this method
to implement their own rendering.
| |
RenderNavigator |
Renders the HTML code that creates the actual navigator. Derived
classes can override this method to implement their own rendering.
| |
SetApplicationCache |
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.) | |
SyncronizeMLC |
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.) | |
ToString | (Inherited from Object.) | |
WriteAttribute(TextWriter, String, String) |
Writes an attribute string to the supplied stream, unless Value is
an empty string or null (Inherited from ActiveScriptingBase.) | |
WriteAttribute(TextWriter, String, String, Boolean) |
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.) |
See Also