CustomActionDefinition complexType
(AppHostWebFeatures)
Note
The string app
appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed.
Type information
Name | Value |
---|---|
Namespace | http://schemas.microsoft.com/sharepoint/ |
Schema file | apphostwebfeatures.xsd |
Extension base | None |
Definition
<xs:complexType name="CustomActionDefinition">
<xs:all>
<xs:element name="UrlAction" type="UrlActionDefinition" minOccurs="0" maxOccurs="1"></xs:element>
<xs:element name="CommandUIExtension" type="CommandUIExtensionType" minOccurs="0" maxOccurs="1"></xs:element>
</xs:all>
<xs:attribute name="Description" type="LocalizableString" />
<xs:attribute name="GroupId" type="xs:string" />
<xs:attribute name="Id" type="UniqueIdentifier" />
<xs:attribute name="ImageUrl" type="LocalizableString" />
<xs:attribute name="Location" type="CustomActionLocations" use="optional" />
<xs:attribute name="RegistrationType" type="CustomActionRegistrationType" />
<xs:attribute name="RegistrationId" type="xs:string" />
<xs:attribute name="RequireSiteAdministrator" type="TRUEFALSE" />
<xs:attribute name="Rights" type="xs:string" />
<xs:attribute name="Sequence" type="Sequence" />
<xs:attribute name="ShowInReadOnlyContentTypes" type="TRUEFALSE" />
<xs:attribute name="ShowInSealedContentTypes" type="TRUEFALSE" />
<xs:attribute name="Title" type="LocalizableString" />
<xs:attribute name="UIVersion" type="UIVersion" />
<xs:attribute name="HostWebDialog" type="TRUEFALSE" use="optional" />
<xs:attribute name="HostWebDialogHeight" type="xs:int" use="optional" />
<xs:attribute name="HostWebDialogWidth" type="xs:int" use="optional" />
</xs:complexType>
Elements and attributes
If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.
Child elements
Element |
Type |
Description |
---|---|---|
Attributes
Attribute |
Type |
Required |
Description |
Possible values |
---|---|---|---|---|
Description |
LocalizableString |
optional |
Values of the LocalizableString type. |
|
GroupId |
xs:string |
optional |
Values of the xs:string type. |
|
HostWebDialog |
TRUEFALSE |
optional |
Values of the TRUEFALSE type. |
|
HostWebDialogHeight |
xs:int |
optional |
Values of the xs:int type. |
|
HostWebDialogWidth |
xs:int |
optional |
Values of the xs:int type. |
|
Id |
UniqueIdentifier |
optional |
Values of the UniqueIdentifier type. |
|
ImageUrl |
LocalizableString |
optional |
Values of the LocalizableString type. |
|
Location |
optional |
Values of the CustomActionLocations type. |
||
RegistrationId |
xs:string |
optional |
Values of the xs:string type. |
|
RegistrationType |
optional |
Values of the CustomActionRegistrationType type. |
||
RequireSiteAdministrator |
TRUEFALSE |
optional |
Values of the TRUEFALSE type. |
|
Rights |
xs:string |
optional |
Values of the xs:string type. |
|
Sequence |
Sequence |
optional |
Values of the Sequence type. |
|
ShowInReadOnlyContentTypes |
TRUEFALSE |
optional |
Values of the TRUEFALSE type. |
|
ShowInSealedContentTypes |
TRUEFALSE |
optional |
Values of the TRUEFALSE type. |
|
Title |
LocalizableString |
optional |
Values of the LocalizableString type. |
|
UIVersion |
optional |
Values of the UIVersion type. |