CustomAction element (ElementDefinitionCollection complexType)

Article
06/29/2022

(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.

Element information

Name	Value
Element type	CustomActionDefinition
Namespace	`http://schemas.microsoft.com/sharepoint/`
Schema file	apphostwebfeatures.xsd

Definition

    <xs:element name="CustomAction" type="CustomActionDefinition"></xs:element>

Elements and attributes

If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.

Parent elements

Element	Type	Description
Elements	ElementDefinitionCollection

Child elements

Element	Type	Description
CommandUIExtension	CommandUIExtensionType
UrlAction	UrlActionDefinition

Attributes

Attribute	Type	Required	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	CustomActionLocations	optional	Values of the CustomActionLocations type.
RegistrationId	xs:string	optional	Values of the xs:string type.
RegistrationType	CustomActionRegistrationType	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	UIVersion	optional	Values of the UIVersion type.