NavBarItem Element (ISV.Config)

Article
06/03/2015
2 minutes to read

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Represents a side tab added to the navigation pane in the main window of the Microsoft Dynamics CRM application.

Element Information

Number of occurrences	One or more
Parent elements	NavBar
Child elements	Titles
XPath	//IsvConfig/configuration/Entities/Entity/NavBar/NavBarItem

Attributes

Name	Description	Type	Required
Icon	Specifies the file name icon to be displayed on the side tab. The icon should be 16x16 pixels.	String	Yes
Url	Specifies the URL to be opened.	String	Yes
Id	Specifies the ID of the side tab.	String	Yes
PassParams	Specifies whether information about the record and language context are passed to the URL. See Passing Parameters to a URL using ISV.Config. Valid values: 0 = do not pass parameters [default] 1 = pass parameters	Boolean	No
Area	Specifies which area to include the element. See Remarks.	String	No
AvailableOffline	Set this to true if the control does not depend on the user being connected to the organization's network. Valid values: true = control is displayed when offline [default] false = control is not displayed when offline	Boolean	No
Client	Specifies the intended client for the control. The default is blank which shows in both. Valid values: Web Outlook	String	No

Remarks

It is recommended that all IDs for NavBarItem elements be unique throughout the whole file.

For each entity element there is an Area attribute on the navigation bar element for the specified entity. This corresponds to the expandable areas in the left navigation pane on a detail form. You can add a new NavBarItem to each area described here.

The possible values are shown in the following table.

Value	Description
<blank>	The item is added under Details.
Info	The item is added under Details. This is the default.
Sales	The item is added under Sales.
Service	The item is added under Service.
Marketing	The item is added under Marketing.

Example

The following code sample shows the use of the NavBarItem element.

<NavBarItem Icon="/_imgs/ico_18_debug.gif" 
  Url="https://www.microsoft.com"
  Id="navIsv1">
    <Titles>
      <Title LCID="1033" Text=" ISV Test 1" />
    </Titles>
</NavBarItem>

See Also

Concepts

Adding Client Extension Controls

Tasks

Sample ISV Configuration File

Other Resources