<customization> Element (Office Development in Visual Studio)

  • Article

The customization element of the vstov4 namespace describes a specific Office solution. The child elements are different for document-level customizations and application-level add-ins.

Syntax for Document-Level Customizations

<customization
  id
  <document
    solutionId
  />
</customization>

Syntax for Application-Level Add-Ins

<customization
  id
  <appAddin
    application
    loadBehavior
    keyName>
  <friendlyName></friendlyName>
  <description></description>
  <formRegions></formRegions>
</customization>

Elements and Attributes

The customization element contains customization-specific information. This element must be in the following namespace: vstov4=urn:schemas-microsoft-com:vsto.v4. There is one customization element for each Office solution. For example, if you deploy three Office solutions in a multi-project deployment, there are three customization elements in the application manifest.

Child elements of the assembly must also be in this namespace.

The customization element has the following attribute.

Attribute

Description

id

Required for multi-project deployment. The id element uniquely identifies an Office solution.

Document-Level Customizations

The customization element has the following child element.

document

The document element in the vstov4 namespace is defined in <document> Element (Office Development in Visual Studio).

Application-Level Add-Ins

The customization element has the following child element.

appAddin

The appAddin element in the vstov4 namespace is defined in <appAddin> Element (Office Development in Visual Studio).

Example of a Document-Level Customization

Description

The following code example illustrates the customization element for a document-level customization. This code example is part of a larger example provided in Application Manifests for Office Solutions.

Code

      <vstov4:customization>
        <vstov4:document 
          solutionId="73e" />
      </vstov4:customization>

Example of an Application-Level Add-In

Description

The following code example illustrates the customization element for an application-level add-in. This is an Outlook add-in that includes form regions. This code example is part of a larger example provided in Application Manifests for Office Solutions.

Code

      <vstov4:customization>
        <vstov4:appAddIn 
          application="Outlook" 
          loadBehavior="3" 
          keyName="ContosoOutlookAddIn">
          <vstov4:friendlyName>
            ContosoOutlookAddIn
          </vstov4:friendlyName>
          <vstov4:description>
            ContosoOutlookAddIn - Outlook add-in 
            created with Visual Studio Tools for Office
          </vstov4:description>
          <vstov4:formRegions>
            <vstov4:formRegion
                name="OutlookAddIn1.FormRegion1">
              <vstov4:messageClass name="IPM.Note" />
              <vstov4:messageClass name="IPM.Contact" />
              <vstov4:messageClass name="IPM.Appointment" />
            </vstov4:formRegion>
          </vstov4:formRegions>
        </vstov4:appAddIn>
      </vstov4:customization>

See Also

Reference

Application Manifests for Office Solutions

Deployment Manifests for Office Solutions

ClickOnce Application Manifest