This documentation is archived and is not being maintained.

SiteMapCustomizer Class

Forefront

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Modifies the SiteMap XML in a Microsoft Dynamics CRM customization file.

The SiteMapCustomizer class exposes the following members.

Constructor	Description
SiteMapCustomizer	Initializes a new instance of the SiteMapCustomizer class.

Instance Method	Description
AddArea	Adds an area element to the SiteMap XML.
AddGroup	Adds a group element to the SiteMap XML.
AddPrivilegeNode	Adds a privilege to a subarea.
AddSubArea	Adds a subarea to a group element in the SiteMap XML.
RemoveArea	Removes an area element from the SiteMap XML.
RemoveGroup	Removes a group element from the SiteMap XML.
RemovePrivilegeNode	Removes a privilege from a subarea.
RemoveSubArea	Removes a subarea from a group element in the SiteMap XML.

Instance Property	Description
Xml	Gets the XML document that contains the SiteMap configuration.

Remarks

This class provides methods that add and remove areas, groups, and subareas to the SiteMap. These methods enable customization of the SiteMap to customize navigation of features of an ISV add-in component.

Generally, the methods build the required XML structure required by the method. For example, if you try to add a global toolbar button and the global toolbar is not yet defined in the XML schema, it will be added and then the button will be added to it.

Example

The following partial code sample shows how to use the SiteMapCustomizer class. The sample code first loads a test customization XML file that contains a SiteMap. Next, the code adds an area, group, subarea, and privilege to the SiteMap. The code saves the changes to a new customization XML file.

Remarks

For more information, see the SiteMap XML Reference.

Requirements

Namespace: Microsoft.Crm.Sdk.IsvReadiness

Assembly: Microsoft.Crm.Sdk.IsvReadiness.dll

See Also

Reference

Microsoft.Crm.Sdk.IsvReadiness Classes