Content Studio Web Content Management System

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

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

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

The WebMapAZ type exposes the following members.

	Name	Description
	WebMapAZ	Constructs a new instance of the WebMapAZ class that writes to the default response stream
	WebMapAZ(Stream)	Constructs a new instance of the WebMapAZ class that writes to the supplied stream

Top

	Name	Description
	ApplicationCacheTimeOut	Sets or gets the timeout (in minutes) for the application cache to live before it is refreshed. The default value is 240.
	BackwardsComponentCompatibilityMode	Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false. (Inherited from ActiveScriptingBase.)
	CacheName	Sets or gets a value that identifies the component on the entire web site. This name MUST be unique within the site since it is used to store application or session cache data. The default value is WebMapAZ1
	CacheType	Sets or gets the the type of caching to use for the web map. The default value is CacheTypes.None
	ComponentCount	Sets or gets the ordinal number of the component on the page. This value can be used by the component internally to make sure that it can generate unique values for example ID on HTML elements.
	ComponentName	Gets the name of the component (Overrides ActiveScriptingBaseComponentName.)
	Conformance	Gets a value which specifies which type of code a component can generate. (Overrides ActiveScriptingBaseConformance.)
	CS_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.)
	CSSPrefix	Sets or gets the prefix of the CSS classes that are generated. The default value is "CS_DefaultWebMap".
	DocumentID	Sets or gets the id of the document that acts as the root of the generated web tree. The root document is normally not included in the web map. The default value is zero in wich case the root document is determined from the passed in identifier in the query string.
	ElementType	Gets a value which specifies the type of outer element the component generates. (Overrides ActiveScriptingBaseElementType.)
	Encoding	Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark. (Inherited from ActiveScriptingBase.)
	HeaderLevel	Sets or gets the header level. This property regulates the level of the head (h) tag written. This header holds the first letter of a found item one for each found start letter. Ex. HeaderLevel 2 generates a <h2> tag The default value is 2 and values can be in the interval 1 - 6.
	Page	A reference to the current context page. This will initialize in the constructor of this class. (Inherited from CodeBase.)
	RunningUserControl	Gets the current running user control. (Inherited from CodeBase.)
	SkipToContentText	Sets or gets the text that is shown in the skip to content link at the top of the control. The default value is "Skip to content".
	SortCulture	Sets or gets a value that identifies the culture to use when sorting the entries found. The default value is an empty string which causes WebMapAZ to use the culture of the current thread. For more information see the .NET documentation about the System.Globalization.CultureInfo class.

Top

	Name	Description
	BuildHTMLComponentException	Returns an component exception in HTML format. (Inherited from ActiveScriptingBase.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GenerateLinkTargetAttribute	Returns the attribute string to be written to the link. (Inherited from ActiveScriptingBase.)
	GetCorrectField	Extracts the correct value from a passed in EPT field name and a static field value. (Inherited from ActiveScriptingBase.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Invoke	Invokes the component and writes its content into the specified stream. The output (sort order etc.) of this method depends on the available cultural information. The WriteOverview(TextWriter, String, StringComparer) and WriteSections(TextWriter, String, StringComparer) methods are called to render the actual web map.
	MemberwiseClone	(Inherited from Object.)
	ReadFromApplicationCache	Returns data that is read from the application cache. (Inherited from ActiveScriptingBase.)
	SetApplicationCache	Stores a string in the application cache. (Inherited from ActiveScriptingBase.)
	SyncronizeMLC	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.)
	ToString	(Inherited from Object.)
	WriteAttribute(TextWriter, String, String)	Writes an attribute string to the supplied stream, unless Value is an empty string or null (Inherited from ActiveScriptingBase.)
	WriteAttribute(TextWriter, String, String, Boolean)	Writes an attribute string to the supplied stream. (Inherited from ActiveScriptingBase.)
	WriteOverview	Writes the overview part of the web map. This method is called via the Invoke method. Inheriting classes can override this method to supply their own rendering code
	WriteSections	Write sections of document, grouped on their first letter, for the web map. This method is called via the Invoke method. Inheriting classes can override this method to supply their own rendering code

Top The generated code consists of a list at the top with a SkipToContent link followed by a series of links to each one of the letter sections that follows. The skip link leads to the first of the letter sections. There will be 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.
The letter sections consist of a header with the first letter of the following documents and all documents starting with the same letter. The source document is a hierarchy of documents, and the root document of this hierarchy must be specified.
The WebMapAZ class acts as the underlying engine for the Web map A-Z 2.0 AS component. 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.
The generated code is fully HTML/XHTML strict compatible.
During rendering, a number of CSS classes are inserted to enable formatting of the generated web map. Make sure that the following classes exists in your CSS stylesheet:

CSS Class	Description
CSSPrefix_Index	Applies on the UL list that builds the index at the top.
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.

• CSSPrefix is a placeholder for the CSSPrefix parameter.
  To prevent these classes from beeing written out omit or set the CSSPrefix property to Empty.

Reference