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

[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

SystemObject
  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

public sealed class InsertMenu20 : MenuBase

The InsertMenu20 type exposes the following members.

Constructors

  NameDescription
Public methodInsertMenu20
Constructs a new instance of the InsertMenu20 class that writes to the default response stream
Public methodInsertMenu20(Stream)
Constructs a new instance of the InsertMenu20 class that writes to the supplied stream
Top
Properties

  NameDescription
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.)
Public propertyClickableRoots
Sets or gets a value indicating if the root document should be clickable. The default value is false.
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.)
Public propertyDocId
Sets or gets the root document ID The default value is zero.
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 propertyHttpSource
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)
Public propertyMenuHeaderClassName
Sets or gets the CSS class for menu headers. The default value is an empty string (no CSS class is used)
Public propertyMenuHeaderHighlightColor
Sets or gets the background color for highlighted menu headers. The default value is "#FFFFFF"
Public propertyMenuHeaderHighlightTextColor
Sets or gets the text color for highlighted menu headers. The default value is "#000000"
Public propertyMenuHeaderLowlightColor
Sets or gets the background color for not highlighted menu headers The default value is "#FFFFFF"
Public propertyMenuHeaderLowlightTextColor
Sets or gets the text color for not highlighted menu headers. The default value is "#000000"
Public propertyMenuHeaderPaddingHeight
Sets or gets the top and bottom padding for menu headers. The default value is 5.
Public propertyMenuHeaderPaddingWidth
Sets or gets the left and right padding for menu headers. The default value is 10.
Public propertyMenuHeaderWidth
Sets or gets the table width in pixels for menu headers. The default value is an empty string (no fixed width is specified).
Public propertyMenuItemBorder
Sets or gets the border width in pixels for menu items The default value is 1.
Public propertyMenuItemBorderColor
Sets or gets the border color for menu items. The default value is "#000000"
Public propertyMenuItemClassName
Sets or gets the CSS class for menu items. The default value is an empty string (no class is specified).
Public propertyMenuItemHighlightColor
Sets or gets the background color for highlighted menu items The default value is "#CCCCCC"
Public propertyMenuItemHighlightTextColor
Sets or gets the text color for highlighted menu items. The default value is "#000000"
Public propertyMenuItemLowlightColor
Sets or gets the background color for not highlighted menu items The default value is "#FFFFFF"
Public propertyMenuItemLowlightTextColor
Sets or gets the text color for not highlighted menu items The default value is "#000000"
Public propertyMenuItemPadding
Sets or gets the padding for menu items. The default value is 4
Public propertyMenuItemPaddingRight
Sets or gets the right side padding for menu items. The default value is 5.
Public propertyMenuItemPaddingTop
Sets or gets the top padding for menu items. The default value is 20.
Public propertyMenuItemsContainerClassName
Sets or gets the CSS class for the container of menu items. The default value is an empty string (no class is specified).
Public propertyMenuItemWidth
Sets or gets the cell width in pixels for menu items. The default value is 170.
Public propertyMenuName
Sets or gets the name of the menu, which must be unique within the web site. The default value is "Mainmenu"
Public propertyPTId
Sets or gets an optional presentation template ID. The default value is zero (no presentation template is specified)
Public propertyStringSource
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.
Public propertyTarget
Sets or gets the default target for all links. The default value is an empty string (no target attribute is used)
Public propertyUseSession
Sets or gets a value indicating if the menu should be cached. The data is stored in session variables. The default value is false.
Public propertyVerticalMenu
Sets or gets a value indicating if a vertical menu should be used. The default value is false (use a horizontal menu).
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Remarks

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.
See Also

Reference