Content Studio Web Content Management System
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
[This is preliminary documentation and is subject to change.]
Invokes the component and writes its content into the specified stream.
Namespace: ContentStudio.Site.ActiveScripting.Menu
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public void Invoke( Stream stream, string menuName, bool useSessionCache, int rootDocumentId, int presentationTemplateId, string httpSourceLocation, string xmlSource, bool shouldRootBeClickable, string target, string cssMenuClassPrefix, string menuXslPath, bool enableViewState, bool displayRoot, bool displayParent, string rootLevels, string parentLinkText, string parentTagName, int documentToMarkIfNotFound, string defaultParentField, bool useApplicationCache, int applicationTimeout, bool overrideCookie, bool useSmartMenuRendering, bool performAccessCheck, bool usePublishStatus, bool doNotUseCacheInCSAdmin )
Parameters
- stream
- Type: System.IOStream
Stream to write to. Use null to write to the current response stream. - menuName
- Type: SystemString
The name of the menu, which must be unique within the web site. - useSessionCache
- Type: SystemBoolean
A value indicating if the menu should be cached using session variables. Security permissions are preserved per user, which makes this suitable on an intranet or where there are security permissions set on the menu items. The cache is not used in Content Studio Admin except when UseCacheInCSAdmin is set. - rootDocumentId
- Type: SystemInt32
The root document ID. - presentationTemplateId
- Type: SystemInt32
An optional presentation template ID to be used. - httpSourceLocation
- Type: SystemString
Specification of the location to fetch custom XML data from. It can be an URL or UNC, and the path can be absolute or relative. - xmlSource
- Type: SystemString
A string containing the custom XML data in string format to use. This value is not used if httpSourceLocation is used. - shouldRootBeClickable
- Type: SystemBoolean
A value indicating if the root document should be clickable (usable for navigation). - target
- Type: SystemString
The default target attribute for all links. - cssMenuClassPrefix
- Type: SystemString
The prefix for all classes in the menu. Standard values to use are CS_DefaultHorizontalMenu, CS_DefaultVerticalMenu, and CS_DefaultTreeMenu - menuXslPath
- Type: SystemString
Link to a specific XSL stylesheet to use. - enableViewState
- Type: SystemBoolean
A value indicating if the attribute enableviewstate should be used. This is not available for custom XML source. - displayRoot
- Type: SystemBoolean
A value indicating if the root document in hierarchy should be displayed. - displayParent
- Type: SystemBoolean
A value indicating if the link to the parent document should be displayed. - rootLevels
- Type: SystemString
A comma separated list of levels that will will build its own roots (for example "2, 3, 5, 7"). This is not available for custom XML source. - parentLinkText
- Type: SystemString
Text for the optional parent document link - parentTagName
- Type: SystemString
Tag name for container of the optional parent document link - documentToMarkIfNotFound
- Type: SystemInt32
The ID of a document to be marked if the requested document not is in the document hierarchy. This is not available for custom XML source. - defaultParentField
- Type: SystemString
The field name containing the document ID in the document that should be marked. This is only available in presentation templates. - useApplicationCache
- Type: SystemBoolean
A value indicating if the menu should be cached using application variables. Security permissions are not preserved per user, which makes this option unsuitable if there are security permissions set on the menu items. The cache is not used in Content Studio Admin except when UseCacheInCSAdmin is set. - applicationTimeout
- Type: SystemInt32
The timeout, measured in minutes, for the application cache. If this is set to zero, no timeout will be raised. - overrideCookie
- Type: SystemBoolean
A value indicating if the cookie remembering the last menu item marked should be - useSmartMenuRendering
- Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. If this parameter is set to true this method will only return the relevant part of the document hierarchy. This parameter is only useful when rendering menus that has a tree lookalike style. - performAccessCheck
- Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. This method does not return any sensitive information, therefore it is possible to turn off the access check for each document in the hierarchy to increase the performance. - usePublishStatus
- Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. By setting this parameter to false publish date, archivedate and published will be ignored to increase performance. - doNotUseCacheInCSAdmin
- Type: SystemBoolean
Do not use application or session cache in Content Sudio Admin.
See Also