Share via

<appAddin> Element (2007 System)

  • Article

Note

Applies to

The information in this topic applies only to the specified Visual Studio Tools for Office projects and versions of Microsoft Office.

For more information, see Features Available by Application and Project Type.

Project type

  • Application-level projects

Microsoft Office version

  • 2007 Microsoft Office system

The appAddin element of the vstov3 namespace stores customization-specific information for application-level add-ins.

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

Elements and Attributes

The appAddin element is required and is in the vstov3 namespace. There is only one appAddin element defined in an application manifest.

The appAddin element has the following attributes.

Attribute

Description

application

Required. Identifies the Microsoft Office application. The value can be one of the following: Excel, InfoPath, Outlook, PowerPoint, Project, Visio, or Word.

loadBehavior

Optional. By default, the loadBehavior is enabled by setting this value to three. For debugging, the add-in can be disabled by setting the value to two. For more information, see the tabled titled LoadBehavior Values in Registry Entries for Application-Level Add-Ins.

keyName

Required. This value is the registry key name that will be used by the application to load the add-in. For more information, see Registry Entries for Application-Level Add-Ins.

The appAddin element has the following child elements.

friendlyName

The friendlyName element is explained in <friendlyName> Element (2007 System).

description

Optional. The description element is explained in <description> Element (2007 System).

formRegions

Required only for Outlook application-level add-ins that include form regions. The formRegions element is explained in <formRegions> Element (2007 System).

Remarks

You can manually edit application and deployment manifests in Visual Studio Tools for Office solutions. Application and deployment manifests must be re-signed by the Manifest Generation and Editing Tool (mage.exe and mageui.exe) after the manifests are edited. Sign the application manifest first and the deployment manifest next. For more information, see Manifest Generation and Editing Tool (Mage.exe) and Manifest Generation and Editing Tool, Graphical Client (MageUI.exe).

Application-Level Add-in Example

Description

The following code example illustrates appAddin elements in an Outlook solution deployed using ClickOnce. This code example is part of a larger example provided in Application Manifests for Office Solutions (2007 System).

Code

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

See Also

Reference

Application Manifests for Office Solutions (2007 System)

Deployment Manifests for Office Solutions (2007 System)

ClickOnce Application Manifest