Creates a web map.

Component properties
Category AS Menu
Version 1.0
Complies with Xhtml 1.0 / 1.1 rules Yes
Supported server programming languages C# Visual Basic.NET
Output content type block

When this component is used on a Web page the rendered Web tree might look like the follwing small sample:

The Web map A-Z 2.0 component

The xhtml source of the Web map above

When to use

This component is typically used to create a Web map based on a document hierarchy, for example the main menu of the web site. 

Detailed information

This component writes two sections implemented as UL-lists, starting with an index that contains links to the actual web map with links to documents grouped by their initial letters. During rendering a number of CSS classes will be inserted to be able to format the generated Web Map. Make sure that these classes exist in your CSS stylesheet.

CSS Class Description
CSSPrefix_Index Applies on the UL-list that builds the index
CSSPrefix_SkipLink Applies to the LI-element that contains the skip link that navigates to actual Web Map.
CSSPrefix_ContentLists Applies to the DIV element that contains the UL-list that forms the Web Map
* CSPrefix is a placeholder for the value of the CSS Prefix parameter. To omit these classes the CSS Prefix parameter should be empty.

Programming interface


Document id
Select the id of the document containing a hierarchy that will be the base of the web map. If this value is not specified or zero the value of the document id in the query string is used.
Text for skiplink
Text to be shown for the skiplink at the top. If omitted no skip link will be generated.
CSS Prefix
Prefix for css classes that are generated. If this value is empty, none of the CSS classes are generated.
Header level
The header level to be used for captions.
Culture for sorting
The name of the culture to use when sorting the list. If no culture is specified the culture of the system is used. The culture must be one of the names specified by the .NET CultureInfo class, for example "en-us" or "sv". Specifying a culture can be very valuable when making a web site that is ment for several cultures since different cultures uses different sort order.
Cache methods (caching is not effective in administrative mode)
Cache name
Cache key name. This name MUST be unique within the site since it is used to store application or session cache data
Cache settings
One of the following options:
  • No cache
    Do not cache the the webmap, the webmap will be rendered from the specified source each time it reloads.
  • Use session cache
    Cache webmap using session variables. Recommended for an intranet.
  • Use application cache
    Cache the webmap in the application. Should not be used in an intranet with security permissions set for the hiearchy items.
Application cache timeout
Timeout in minutes for application cache, 0 = no timeout


General remarks with menu components

Even though that this component does not appears as a menu it is driven by the Content Studio menu API and will stay 100% in sync with document hierarchy. Often this is the same tree structure that is used to build the main menu of the entire site so for this reason this component uses the same API as the regular menu components.

All menu driven components uses the Content Studio menu API:s and hierarchy document structures. The caller must have BROWSE permission to all items displayed and every item must be live and published. When the menu renders Content Studio traverses through the entire document tree and whenever there is a document that is not available to the caller the traverse operation breaks at this point. This have the effect that any object that is a child of a unavailable document will be left out since the tree is broken at that point.