Edit

ClientWebPartProperty complexType

  • Article

(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

Information Location
Namespace http://schemas.microsoft.com/sharepoint/
Schema File apphostwebfeatures.xsd
Extension Base None

Definition

    <xs:complexType name="ClientWebPartProperty">
        <xs:all>
            <xs:element name="EnumItems" type="ClientWebPartEnumItems" minOccurs="0" maxOccurs="1"></xs:element>
        </xs:all>
        <xs:attribute name="Name" type="xs:string" use="required" />
        <xs:attribute name="Type" type="ClientWebPartPropertyType" use="required" />
        <xs:attribute name="RequiresDesignerPermission" type="xs:boolean" use="required" />
        <xs:attribute name="DefaultValue" type="xs:string" use="required" />
        <xs:attribute name="PersonalizationScope" type="WebPartPersonalizationScope" use="optional" />
        <xs:attribute name="PersonalizableIsSensitive" type="xs:boolean" use="optional" />
        <xs:attribute name="WebBrowsable" type="xs:boolean" use="optional" />
        <xs:attribute name="WebDisplayName" type="xs:string" use="optional" />
        <xs:attribute name="WebDescription" type="xs:string" use="optional" />
        <xs:attribute name="WebCategory" type="xs:string" use="optional" />
        <xs:attribute name="ManagedLinkFixup" type="xs:boolean" use="optional" />
        <xs:attribute name="ManagedLinkConvertServerLinksToRelative" type="xs:boolean" use="optional" />
        <xs:attribute name="Multilingual" type="xs:boolean" 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

EnumItems

ClientWebPartEnumItems


Attributes

Attribute Type Required Description Possible values
DefaultValue xs:string required Values of the xs:string type.
ManagedLinkConvertServerLinksToRelative xs:boolean optional Values of the xs:boolean type.
ManagedLinkFixup xs:boolean optional Values of the xs:boolean type.
Multilingual xs:boolean optional Values of the xs:boolean type.
Name xs:string required Values of the xs:string type.
PersonalizableIsSensitive xs:boolean optional Values of the xs:boolean type.
PersonalizationScope WebPartPersonalizationScope optional Values of the WebPartPersonalizationScope type.
RequiresDesignerPermission xs:boolean required Values of the xs:boolean type.
Type ClientWebPartPropertyType required Values of the ClientWebPartPropertyType type.
WebBrowsable xs:boolean optional Values of the xs:boolean type.
WebCategory xs:string optional Values of the xs:string type.
WebDescription xs:string optional Values of the xs:string type.
WebDisplayName xs:string optional Values of the xs:string type.