Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingMenuBase
ContentStudio.Site.ActiveScripting.MenuInsertMenu20
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
To use this class, create an instance of this object, set the
properties that does not have the values you expect, and call the Invoke
method.
The generated code is not XHTML validation compatible since the
generated code partly consists of Javascript code.
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 is preliminary documentation and is subject to change.]
Writes a menu based on XML source or auto generated from a document
hierarchy to the supplied stream or the default response stream. It is
possible to cache the menu using session variables.
The InsertMenu20 class acts as the underlying engine for the Insert
Menu 2.0 AS component.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingMenuBase
ContentStudio.Site.ActiveScripting.MenuInsertMenu20
Namespace: ContentStudio.Site.ActiveScripting.Menu
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The InsertMenu20 type exposes the following members.
Constructors
Name | Description | |
---|---|---|
InsertMenu20 |
Constructs a new instance of the InsertMenu20 class that writes
to the default response stream
| |
InsertMenu20(Stream) |
Constructs a new instance of the InsertMenu20 class that writes
to the supplied stream
|
Properties
Name | Description | |
---|---|---|
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.) | |
ClickableRoots |
Sets or gets a value indicating if the root document should be
clickable. The default value is false.
| |
ComponentName | Gets the name of the component (Overrides ActiveScriptingBaseComponentName.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.) | |
DocId |
Sets or gets the root document ID The default value is zero.
| |
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.) | |
Encoding |
Sets or gets the encoding the component uses. The default encoding is
the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.) | |
HttpSource |
Sets or gets a HTTP URL that specifies a location to fetch XML data.
The default value is an empty string (no HTTP source is used)
| |
MenuHeaderClassName |
Sets or gets the CSS class for menu headers. The default value is an
empty string (no CSS class is used)
| |
MenuHeaderHighlightColor |
Sets or gets the background color for highlighted menu headers. The
default value is "#FFFFFF"
| |
MenuHeaderHighlightTextColor |
Sets or gets the text color for highlighted menu headers. The default
value is "#000000"
| |
MenuHeaderLowlightColor |
Sets or gets the background color for not highlighted menu headers The
default value is "#FFFFFF"
| |
MenuHeaderLowlightTextColor |
Sets or gets the text color for not highlighted menu headers. The
default value is "#000000"
| |
MenuHeaderPaddingHeight |
Sets or gets the top and bottom padding for menu headers. The default
value is 5.
| |
MenuHeaderPaddingWidth |
Sets or gets the left and right padding for menu headers. The default
value is 10.
| |
MenuHeaderWidth |
Sets or gets the table width in pixels for menu headers. The default
value is an empty string (no fixed width is specified).
| |
MenuItemBorder |
Sets or gets the border width in pixels for menu items The default
value is 1.
| |
MenuItemBorderColor |
Sets or gets the border color for menu items. The default value is
"#000000"
| |
MenuItemClassName |
Sets or gets the CSS class for menu items. The default value is an
empty string (no class is specified).
| |
MenuItemHighlightColor |
Sets or gets the background color for highlighted menu items The
default value is "#CCCCCC"
| |
MenuItemHighlightTextColor |
Sets or gets the text color for highlighted menu items. The default
value is "#000000"
| |
MenuItemLowlightColor |
Sets or gets the background color for not highlighted menu items The
default value is "#FFFFFF"
| |
MenuItemLowlightTextColor |
Sets or gets the text color for not highlighted menu items The default
value is "#000000"
| |
MenuItemPadding |
Sets or gets the padding for menu items. The default value is 4
| |
MenuItemPaddingRight |
Sets or gets the right side padding for menu items. The default value
is 5.
| |
MenuItemPaddingTop |
Sets or gets the top padding for menu items. The default value is 20.
| |
MenuItemsContainerClassName |
Sets or gets the CSS class for the container of menu items. The default
value is an empty string (no class is specified).
| |
MenuItemWidth |
Sets or gets the cell width in pixels for menu items. The default value
is 170.
| |
MenuName |
Sets or gets the name of the menu, which must be unique within the web
site. The default value is "Mainmenu"
| |
PTId |
Sets or gets an optional presentation template ID. The default value is
zero (no presentation template is specified)
| |
StringSource |
Sets or gets a string containing the XML data to use. This value is not
used if HttpSource is used. The default value is an empty
string.
| |
Target |
Sets or gets the default target for all links. The default value is an
empty string (no target attribute is used)
| |
UseSession |
Sets or gets a value indicating if the menu should be cached. The data
is stored in session variables. The default value is false.
| |
VerticalMenu |
Sets or gets a value indicating if a vertical menu should be used. The
default value is false (use a horizontal menu).
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component and writes its content into the specified stream
| |
ToString | (Inherited from Object.) |
Remarks
See Also