Del via


<tab> (FormXml)

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Specifies a tab element in the organization of a form.

Syntax

<tab
 addedby="String"
 availableforphone=["0" | "1" | "true" | "false"]
 expanded =["0" | "1" | "true" | "false"]
 group="String"
 id="String"
 IsUserDefined="String"
 labelid="String"
 locklevel="Non Negative Integer"
 name="String"
 showlabel =["0" | "1" | "true" | "false"]
 verticallayout =["0" | "1" | "true" | "false"]
 visible= =["0" | "1" | "true" | "false"]>
 <columns />
 <events />
 <labels />
</tab>

Attributes and Elements

The following describes the attributes, child elements, and parent elements.

Attributes

Attribute

Description

Type

Usage

addedby

Identifies the name of the ISV or customizer that added the element.

String

Optional

availableforphone

Whether the element is available for Dynamics 365 for Phones client.

Boolean

Optional

expanded

Specifies whether the tab should be expanded by default.

Boolean

Optional

group

Not used.

String

Optional

id

Unique ID for the tab.

See Remarks.

String (FormGuidType)

Required

IsUserDefined

"1" indicates a custom tab.

"0" indicates a default tab.

String

Optional

labelid

A unique id value for the tab label.

String (FormGuidType)

Optional

Sometimes Required. See Remarks.

locklevel

Prevents the tab from being deleted from the form or having its properties modified.

0 = Do not lock

1= Locked

Non Negative Integer

Optional

name

The name of the tab.

String

Optional

showlabel

Deprecated

Boolean

Optional

verticallayout

Not used.

Boolean

Optional

visible

Specifies whether the tab is visible by default.

Boolean

Optional

Child Elements

Element

Description

<labels> (FormXml)

Contains form label definitions.

<columns> (FormXml)

Contains the columns within a tab.

<events> (FormXml)

Contains all the event definitions for a cell or form.

Parent Elements

Element

Description

<tabs> (FormXml)

Contains the tab definitions for a form.

Remarks

If you create a new <tab> (FormXML), <section> (FormXml) or <cell> (FormXml) element by copying from an existing form definition or by manually editing an exported customization.xml file you should create a new GUID value for the id attribute. You should use a tool like guidgen.exe to guarantee a unique valid GUID value. The guidgen.exe is included as part of the Windows SDK.

If you do not specify a new GUID value for the element id, you must create a new GUID value for the labelid attribute and add the labelid attribute. If you have duplicate element id values AND do not specify a unique labelid attribute value you will not be able to uninstall your solution. To address this issue you must export the default solution containing the form definitions, edit each element in the existing forms to add a unique labelid value, and then import those modified form definitions.

Element Information

Schema Type

complexType

Validation File

FormXml.xsd

Number of Occurrences

1 to 100

XPath

//FormXml/forms/systemform/form/tabs/tab

See Also

Customize entity forms
Form XML reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright