Expand Minimize

OfficeApp complexType (app manifest schema v1.1)

An abstract type that defines an app for Office.

Last modified: February 05, 2014

Namespace

http://schemas.microsoft.com/office/appforoffice/1.0

Schema file

offappmanifest.xsd

Extension base

None

<xs:complexType name="OfficeApp" abstract="true">
    <xs:sequence>
        <xs:element name="Id" type="UUID" minOccurs="1" maxOccurs="1"></xs:element>
        <xs:element name="AlternateId" type="AlternateId" minOccurs="0" maxOccurs="1"></xs:element>
        <xs:element name="Version" type="Version" minOccurs="1" maxOccurs="1"></xs:element>
        <xs:element name="ProviderName" type="ShortString" minOccurs="1" maxOccurs="1"></xs:element>
        <xs:element name="DefaultLocale" type="CultureName" minOccurs="1" maxOccurs="1"></xs:element>
        <xs:element name="DisplayName" type="ShortLocaleAwareSetting" minOccurs="1" maxOccurs="1"></xs:element>
        <xs:element name="Description" type="LongLocaleAwareSetting" minOccurs="1" maxOccurs="1"></xs:element>
        <xs:element name="IconUrl" type="URLLocaleAwareSetting" minOccurs="0" maxOccurs="1"></xs:element>
        <xs:element name="SupportUrl" type="URLLocaleAwareSetting" minOccurs="0" maxOccurs="1"></xs:element>
        <xs:element name="AppDomains" type="AppDomains" minOccurs="0" maxOccurs="1"></xs:element>
    </xs:sequence>
</xs:complexType>

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

Child elements

Element

Type

Description

AlternateId

AlternateId

Specifies the alternate ID for the app as issued by the Office Store.

AppDomains

AppDomains

Specifies additional domains that this app will use to load pages.

DefaultLocale

CultureName

Specifies the default culture name of the locale used by strings in this manifest.

Description

LongLocaleAwareSetting

Specifies a more verbose description of the app.

DisplayName

ShortLocaleAwareSetting

Specifies a short name for the app.

IconUrl

URLLocaleAwareSetting

Specifies the URL of the image that is used to represent the app.

Id

UUID

Specifies the unique ID of the app.

ProviderName

ShortString

Specifies the name of the individual or company that developed the app.

SupportUrl

URLLocaleAwareSetting

Specifies the URL of a page that provides support information for the app.

Version

Version

Specifies the version of the app.

HighResolutionIconUrl

URLLocaleAwareSetting

Specifies the URL of the image that is used to represent the app on high dpi screens.

Hosts

Hosts

Specifies the Office client application where the app for Office will activate.

Attributes

None.

Note that the child elements of this type follow a specific sequence. When adding these child elements to a manifest, refer to the Definition section for the appropriate order.

Because OfficeApp is an abstract type, when specifying an OfficeApp element in a manifest, use the xsi:type attribute to specify the exact type which extends this OfficeApp abstract type. An exact type is one of the following: the ContentApp, MailApp, or TaskPaneApp complex type.

The following is an example of the OfficeApp element in a manifest of a mail app.

<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:ver="http://schemas.microsoft.com/office/appforoffice/1.0"
xsi:type="MailApp">
Show:
© 2014 Microsoft