InsertMenu30 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 or application variables. The InsertMenu30 class acts as the underlying engine for the Insert Menu 3.0 AS component.
Inheritance Hierarchy

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

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

public class InsertMenu30 : MenuBase

The InsertMenu30 type exposes the following members.

Constructors

  NameDescription
Public methodInsertMenu30
Constructs a new instance of the InsertMenu30 class.
Public methodInsertMenu30(MasterPageBase)
Constructs a new instance of the InsertMenu30 class.
Public methodInsertMenu30(SiteBase)
Constructs a new instance of the InsertMenu30 class.
Public methodInsertMenu30(UserControlBase)
Constructs a new instance of the InsertMenu30 class.
Public methodInsertMenu30(SiteBase, UserControlBase)
Constructs a new instance of the InsertMenu30 class.
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 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 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.)
Protected propertyPage
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Protected propertyRunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
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.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke(String, Boolean, Int32, Int32, String, String, Boolean, String, String, String, Boolean, Boolean, Boolean, String, String, String, Int32, String, Boolean, Int32, Boolean)
Invokes the component and writes its content into the default response stream.
Public methodInvoke(Stream, String, Boolean, Int32, Int32, String, String, Boolean, String, String, String, Boolean, Boolean, Boolean, String, String, String, Int32, String, Boolean, Int32, Boolean)
Invokes the component and writes its content into the specified stream.
Public methodInvoke(String, Boolean, Int32, Int32, String, String, Boolean, String, String, String, Boolean, Boolean, Boolean, String, String, String, Int32, String, Boolean, Int32, Boolean, Boolean, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream.
Public methodInvoke(Stream, String, Boolean, Int32, Int32, String, String, Boolean, String, String, String, Boolean, Boolean, Boolean, String, String, String, Int32, String, Boolean, Int32, Boolean, Boolean, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodReadFromApplicationCache
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.)
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