Microsoft.VisualStudio.Tools.Applications.Runtime Namespace

The Microsoft.VisualStudio.Tools.Applications.Runtime namespace contains classes that support data caching in documents, and classes that are part of the Visual Studio Tools for Office runtime .

Classes

AddInException

The exception that is thrown when an exception is passed between an add-in and the host application.

CacheAlreadyLoadedException

The exception that is thrown when a document-level customization attempts to load the data cache in a document after the data cache has already been loaded.

CachedAttribute

Instructs the Visual Studio Tools for Office runtime to add the specified data object to the data cache in the document.

CachedDataCouldNotBeSerializedException

The exception that is thrown when an attempt to serialize cached data in a document-level customization fails.

CachedDataTypeMismatchException

The exception that is thrown when the XML serialized state of an object in the data cache does not match the type information for the object in the cached data manifest.

CannotCacheInNonStartupException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

CannotCreateCustomizationDomainException

The exception that is thrown when an application domain cannot be created and the assembly for an Office solution cannot be loaded.

CannotCreateStartupObjectException

The exception that is thrown when a host item class in an Office solution assembly cannot be instantiated.

CannotFindMemberException

The exception that is thrown when you try to programmatically add or remove an object from the data cache in a document-level customization, but the specified object is not declared in the specified host item class.

CannotFindObjectToFillException

The exception that is thrown when the Visual Studio Tools for Office runtime cannot locate an object in the data cache of a document-level customization.

CannotFindStartupObjectAssemblyException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

CannotLoadManifestException

The exception that is thrown when the manifest in the document cannot be loaded.

CannotRetrieveAppInfoException
CannotRetrieveCachedDataException

The exception that is thrown when the cached data in the document is corrupted or missing.

ControlCouldNotBeInitializedException

The exception that is thrown when a control that was added to a document in an Office solution could not be initialized.

ControlNotFoundException

The exception that is thrown when an attempt is made to reference a control in a document-level customization, but the control does not exist.

DocumentAlreadyCustomizedException

The exception that is thrown when you attempt to attach a customization to a document that is already part of a document-level customization that was created by using Office development tools in Visual Studio.

DocumentAlreadyLoadedException
DocumentClosedException

The exception that is thrown when you attempt to perform an operation using the ServerDocument class on a closed document.

DocumentCustomizedWithPreviousRuntimeException

The exception that is thrown when you attempt to use the ServerDocument class to perform an operation on a document-level customization that was created by using an earlier version of the Office development tools in Visual Studio.

DocumentNotCustomizedException

The exception that is thrown when you try to perform an invalid operation on a document by using the ServerDocument class.

DocumentNotLoadedException
HostAssemblyAttribute

Specifies that the assembly in which this attribute appears contains proxy types for the types exposed by the host application.

HostEventAttribute

Relates an event in a proxy type to an event in the host application.

HostMemberAttribute

Sets the way that methods and properties in the proxy are bound to the corresponding members in the host application's object model.

HostTypeAttribute

Specifies the relationship between a type and its canonical name.

InvalidDeployManifestException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

InvalidManifestException

This exception is thrown when the application manifest or cached data manifest for the Office solution is not valid.

InvalidNewApplicationManifestException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

ItemAlreadyInCacheException

The exception that is thrown when an attempt is made to add an item to the data cache in a document-level customization, but the item already exists in the cache.

ItemNotInCacheException

The exception that is thrown when an attempt is made to retrieve an item from the data cache in a document-level customization, but the item does not exist.

ManifestNotExecutedException
MissingDataIdException

The exception that is thrown when a ServerDocument object is saved while the cached data manifest contains a CachedDataItem with an Id property that is null or an empty string.

MissingHostItemIdException

The exception that is thrown when a ServerDocument object is saved while the cached data manifest contains a CachedDataHostItem with an Id property that is null or an empty string.

MissingTypeException

The exception that is thrown when a ServerDocument object is saved while the cached data manifest contains a CachedDataItem with a DataType property that is null or an empty string.

MultipleCachedDataCouldNotBeSerializedException

The exception that is thrown when more than one cached data object could not be serialized in a document-level customization.

NonCacheableTypeException

The exception that is thrown when an attempt is made to cache an object in a document-level customization, but the type of the object is not a DataSet, DataTable, or a type that meets the requirements specified in Caching Data.

NoStartupObjectsException

This exception is thrown when a solution assembly that was created by using Office development tools in Visual Studio does not contain a startup object.

NotAvailableOfflineException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

NotAvailableOnlineException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

RuntimeException

Provides the base class for exceptions in Visual Studio Tools for Office runtime.

SafeArrayDefaultRankAttribute

Defines the default rank of an array.

StartupObjectAttribute
UnknownCustomizationFileException

The exception that is thrown when you pass a file with an extension that is not supported by Office development tools in Visual Studio to a ServerDocument constructor or method.

UpdateFailedException

This exception is not used by the Visual Studio 2010 Tools for Office Runtime. It is included in this version of the runtime to maintain compatibility with code that was compiled using earlier versions of the runtime.

Interfaces

IAppInfo
IAppInfoDocument
ICachedType

Customizes the caching behavior of a type in document-level customizations.

IComAddInAutomationServiceProviderCallback

Enums

HostEventMethodType

Indicates the type of the method in the host application that corresponds to a method in an add-in.

Remarks

The Microsoft.VisualStudio.Tools.Applications.Runtime namespace contains the following classes:

  • CachedAttribute. Use this attribute to add an object in a document-level customization to the data cache in the document. For more information, see Caching Data.

  • The ICachedType interface. You can optionally implement this interface on objects that you add to the data cache in a document. Implement this interface if you want to gain greater control over the caching behavior of the object.

  • Exceptions that can be thrown by the Visual Studio Tools for Office runtime.

  • Other classes that are part of the Visual Studio infrastructure, and are not intended to be used directly by your code.