Share via

Microsoft.VisualStudio.Tools.Applications.Runtime Namespace

  • Article

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.

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.

Classes

  Class Description
Public class AddInException The exception that is thrown when an exception is passed between an add-in and the host application.
Public class 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.
Public class CachedAttribute Instructs the Visual Studio Tools for Office runtime to add the specified data object to the data cache in the document.
Public class CachedDataCouldNotBeSerializedException The exception that is thrown when an attempt to serialize cached data in a document-level customization fails.
Public class 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.
Public class 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.
Public class CannotCreateCustomizationDomainException The exception that is thrown when an application domain cannot be created and the assembly for an Office solution cannot be loaded.
Public class CannotCreateStartupObjectException The exception that is thrown when a host item class in an Office solution assembly cannot be instantiated.
Public class 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.
Public 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.
Public class 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.
Public class CannotLoadManifestException The exception that is thrown when the manifest in the document cannot be loaded.
Public class CannotRetrieveAppInfoException Infrastructure.
Public class CannotRetrieveCachedDataException The exception that is thrown when the cached data in the document is corrupted or missing.
Public class ControlCouldNotBeInitializedException The exception that is thrown when a control that was added to a document in an Office solution could not be initialized.
Public class 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.
Public class 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.
Public class DocumentAlreadyLoadedException Infrastructure.
Public class DocumentClosedException The exception that is thrown when you attempt to perform an operation using the ServerDocument class on a closed document.
Public class 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.
Public class DocumentNotCustomizedException The exception that is thrown when you try to perform an invalid operation on a document by using the ServerDocument class.
Public class DocumentNotLoadedException Infrastructure.
Public class HostAssemblyAttribute Specifies that the assembly in which this attribute appears contains proxy types for the types exposed by the host application.
Public class HostEventAttribute Relates an event in a proxy type to an event in the host application.
Public class HostMemberAttribute Sets the way that methods and properties in the proxy are bound to the corresponding members in the host application's object model.
Public class HostTypeAttribute Specifies the relationship between a type and its canonical name.
Public class 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.
Public class InvalidManifestException This exception is thrown when the application manifest or cached data manifest for the Office solution is not valid.
Public class 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.
Public class 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.
Public class 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.
Public class ManifestNotExecutedException Infrastructure.
Public class 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 nulla null reference (Nothing in Visual Basic) or an empty string.
Public class 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 nulla null reference (Nothing in Visual Basic) or an empty string.
Public class 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 nulla null reference (Nothing in Visual Basic) or an empty string.
Public class MultipleCachedDataCouldNotBeSerializedException The exception that is thrown when more than one cached data object could not be serialized in a document-level customization.
Public class 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.
Public class 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.
Public class 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.
Public class 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.
Public class RuntimeException Provides the base class for exceptions in Visual Studio Tools for Office runtime.
Public class SafeArrayDefaultRankAttribute Defines the default rank of an array.
Public class StartupObjectAttribute Infrastructure.
Public class 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.
Public class 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

  Interface Description
Public interface IAppInfo Infrastructure.
Public interface IAppInfoDocument Infrastructure.
Public interface ICachedType Customizes the caching behavior of a type in document-level customizations.
Public interface IComAddInAutomationServiceProviderCallback Infrastructure.

Enumerations

  Enumeration Description
Public enumeration HostEventMethodType Indicates the type of the method in the host application that corresponds to a method in an add-in.

See Also

Reference

Other Resources

Caching Data