Share via

2.2.29 TaskPaneApp

  • Article

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

Specifies an Office Add-in that is displayed in a task pane to enhance the viewing and authoring experience.

Child Elements:

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

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

Version: A Version element (section 2.3.8) that specifies the version of the Office Add-in.

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

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

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

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

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

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

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

VersionOverrides: An element that specifies elements for use in future versions of the Office Add-in platform. These elements MAY be overrides to previously defined elements or new elements.

Capabilities: A CT_Capabilities1 element (section 2.2.28) that specifies the capabilities that are required by this task pane add-in; the host application will look for at least one match before activating the task pane add-in.

DefaultSettings: A TaskPaneAppSettings element (section 2.2.10) that specifies control settings that are applied whenever this task pane add-in is used.

Permissions: An ST_Permissions1 element (section 2.3.20) that specifies the subset of the API that are available to this task pane add-in at runtime; the application implementer has permissions based on least privilege.

Dictionary: A Dictionary element (section 2.2.25) that specifies control settings that apply to a task pane add-in that implements additional dictionary support.

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

 <xs:complexType name="TaskPaneApp">
   <xs:complexContent>
     <xs:extension base="OfficeApp">
       <xs:sequence>
         <xs:element name="Capabilities" minOccurs="1" maxOccurs="1" type="ver:CT_Capabilities1"/>
         <xs:element name="DefaultSettings" type="TaskPaneAppSettings" minOccurs="1" maxOccurs="1"/>
         <xs:element name="Permissions" minOccurs="1" maxOccurs="1" type="ver:ST_Permissions1"/>
         <xs:element name="Dictionary" type="Dictionary" minOccurs="0" maxOccurs="1"/>
         <xs:any id="TaskPaneAppSignature" 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.1 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).