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

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

Writes a simple menu to the supplied stream or the default response stream. The menu is a list of links to the document that forms the menu. It is generated in a TABLE with one row and one cell containing or within a DIV element closure. The InsertSimpleMenu class acts as the underlying engine for the Insert simple menu AS component. Create an instance of this object, set the properties that does not have their default values you expect and call the invoke method. The code generated is fully HTML/XHTML strict compatible.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingMenuBase
        ContentStudio.Site.ActiveScripting.MenuInsertSimpleMenu

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 InsertSimpleMenu : MenuBase

The InsertSimpleMenu type exposes the following members.

Constructors

  NameDescription
Public methodInsertSimpleMenu
Constructs a new instance of the InsertSimpleMenu class that writes to the default response stream
Public methodInsertSimpleMenu(Stream)
Constructs a new instance of the InsertSimpleMenu 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 propertyCellpadding
Sets or gets a value that indicates the cell padding to use with the generated table. The default value is zero.
Public propertyCellspacing
Sets or gets a value that indicates the cell spacing to use with the generated table. The default value is zero.
Public propertyClassName
Sets or gets the name of a CSS class name to use when formatting the menu. The value is inserted on the TD element in the old output syntax and on the DIV element when the new syntax is in use. The default value is an empty string (default formatting is applied to the list).
Public propertyClickableRoots
Sets or gets a value that indicates if the top level nodes 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 propertyDocumentID
Sets or gets a value with the document ID that will act as the root of the displayed tree. 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 propertyPresentationTemplate
Sets or gets a value that indicates the presentation template to use. The default value is zero (no presentation template is used).
Public propertyTableBorder
Sets or gets the border width of the generated table. The default value is zero (no border).
Public propertyTableCaption
Sets or gets the caption element connected to the the generated table. The default value is an empty string (the element is omitted).
Public propertyTableSummary
Sets or gets the summary attribute connected to the the generated table. The default value is an empty string (the attribute is omitted).
Public propertyTableWidth
Sets or gets a value that defines the width attribute of the generated table. The default value is 100%.
Public propertyUseNewOutputSyntax
Sets or gets a value that indicates whether to use the new (modern) code syntax. This means that the table is replaced with a DIV element. The default value is false.
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. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. The generated code is fully HTML/XHTML strict compatible. 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.
See Also

Reference