Share via


2.2.34 ContentApp

Target namespace: http://schemas.microsoft.com/office/appforoffice/1.1

Defines a content add-in that is placed in-line with document content to provide a richer web-based experience.

Child Elements:

Id: A UUID element that specifies a unique identifier for the Office Add-in.

AlternateId: An AlternateId element that specifies an alternate identifier for the Office Add-in.

Version: A Version element that specifies the version of the Office Add-in.

ProviderName: A ShortString element that specifies the name of the individual or company that developed the Office Add-in.

DefaultLocale: A CultureName element that specifies the culture name of the locale used by default by strings in the Office Add-in manifest.

DisplayName: A ShortLocaleAwareSetting element that specifies a short name for the Office Add-in.

Description: A LongLocaleAwareSetting element that specifies a verbose description of the Office Add-in.

IconUrl: A URLLocaleAwareSetting element that specifies the Uniform Resource Locator (URL) of the image that is used to represent the Office Add-in.

HighResolutionIconUrl: A URLLocaleAwareSetting element that specifies the Uniform Resource Locator (URL) of the image that is used to represent the Office Add-in on high dpi screens.

SupportUrl: A URLLocaleAwareSetting element that specifies the Uniform Resource Locator (URL) of a page that provides support information for the Office Add-in.

AppDomains: An AppDomains element that specifies additional domains that this Office Add-in will use to load pages.

Hosts: A Hosts element that specifies the client applications where the Office Add-in will activate.

Requirements: A Requirements element that specifies the minimum set of JavaScript API requirements that the content add-in needs to activate.

DefaultSettings: A ContentAppSettings element that control settings that are applied whenever the content add-in is used.

Permissions: An ST_Permissions element that specifies the subset of the API that MAY be available to this content add-in at runtime; the implementer SHOULD request permissions based on "least privilege".

AllowSnapshot: A boolean ([XMLSCHEMA2] section 3.2.2) element that specifies whether a snapshot image of this content add-in is saved when the hosting document is saved.

contentor:VersionOverrides: A VersionOverridesV1_0 element that specifies a collection of client application types. Data defined in this element overrides the same data present in the parent node of this element in the manifest for client applications that support this extended manifest content. Content overrides are applicable specifically for content add-ins.

The following W3C XML Schema ([XMLSCHEMA1/2] section 2.1) fragment specifies the contents of this complex type.

 <xs:complexType name="ContentApp">
   <xs:complexContent>
     <xs:extension base="OfficeApp">
       <xs:sequence>
         <xs:element name="Requirements" type="Requirements" minOccurs="0" maxOccurs="1"/>
         <xs:element name="DefaultSettings" type="ContentAppSettings" minOccurs="1" maxOccurs="1"/>
         <xs:element name="Permissions" minOccurs="1" maxOccurs="1" type="ST_Permissions"/>
         <xs:element name="AllowSnapshot" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element ref="contentor:VersionOverrides" minOccurs="0" maxOccurs="1"/>
         <xs:any id="ContentAppSignature" minOccurs="0" maxOccurs="1" namespace="http://www.w3.org/2000/09/xmldsig#" processContents="lax"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

See section 5.2 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).