Expand Minimize

TaskPaneApp complexType (app manifest schema v1.1)

Defines an app that is displayed in a task pane to enhance the viewing and authoring experience.

Last modified: February 05, 2014

Namespace

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

Schema file

offappmanifest.xsd

Extension base

OfficeApp

<xs:complexType name="TaskPaneApp">
    <xs:complexContent>
        <xs:extension base="OfficeApp">
            <xs:sequence>
                <xs:element name="DefaultSettings" type="TaskPaneAppSettings" minOccurs="1" maxOccurs="1"></xs:element>
                <xs:element name="Permissions" minOccurs="1" maxOccurs="1">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Restricted" />
                            <xs:enumeration value="ReadDocument" />
                            <xs:enumeration value="ReadAllDocument" />
                            <xs:enumeration value="WriteDocument" />
                            <xs:enumeration value="ReadWriteDocument" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Dictionary" type="Dictionary" minOccurs="0" maxOccurs="1"></xs:element>
                <xs:any id="TaskPaneAppSignature" namespace="http://www.w3.org/2000/09/xmldsig#" processContents="lax" minOccurs="0" maxOccurs="1"></xs:any>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

Child elements

Element

Type

Description

DefaultSettings

TaskPaneAppSettings

Specifies control settings that are applied whenever this task pane app is used.

Dictionary

Dictionary

Specifies control settings that apply to a task pane app that implements additional dictionary support.

Permissions

xs:string

Controls the subset of the API that may be available to this task pane app at runtime; the developer should request permissions based on "least privilege".

Attributes

None.

You can specify an optional element to support a digital signature to sign the manifest when you submit the app to the Office Store. The element is part of the namespace http://www.w3.org/2000/09/xmldsig#, and the schema for the element follows the processing rules and syntax as specified by XML Signature Syntax and Processing (Second Edition).

The following is an example of a signature.

  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
      <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
      <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
      <Reference URI="">
        <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
          <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
        <DigestValue>0ZTx59WcgK4NKW4TKQNlQaHOYx8=</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>Encrypted data</SignatureValue>
    <KeyInfo>
      <KeyValue>
        <RSAKeyValue>
          <Modulus>Encrypted data</Modulus>
          <Exponent>AQAB</Exponent>
        </RSAKeyValue>
      </KeyValue>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
    </KeyInfo>
    <Object id="ts-countersig">
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <CounterSignature 
        xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003" 
        ts-format="cms-timestamp-message">Encrypted data</CounterSignature>
    </Object>
  </Signature>

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.

Community Additions

ADD
Show:
© 2014 Microsoft