CachedAttribute Class
Instructs the Visual Studio Tools for Office runtime to add the specified data object to the data cache in the document.
Inheritance Hierarchy
System.Object
System.Attribute
Microsoft.VisualStudio.Tools.Applications.Runtime.CachedAttribute
Namespace: Microsoft.VisualStudio.Tools.Applications.Runtime
Assembly: Microsoft.VisualStudio.Tools.Applications.Runtime (in Microsoft.VisualStudio.Tools.Applications.Runtime.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field)> _
Public NotInheritable Class CachedAttribute _
Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)]
public sealed class CachedAttribute : Attribute
The CachedAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
CachedAttribute | Initializes a new instance of the CachedAttribute class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
|
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
_Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
|
_Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
|
_Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
|
_Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Top
Remarks
This attribute can only be used in a document-level customization for Word or Excel created by using the Office development tools in Visual Studio.
To add an object to the data cache in a document, the object must have a public type that meets the requirements of XmlSerializer. For more information about adding objects to the data cache, see Caching Data. For more information about using attributes, see Extending Metadata Using Attributes.
If you want to have greater control over the caching behavior of the data object, you can implement the ICachedType interface in the type of the object.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Reference
Microsoft.VisualStudio.Tools.Applications.Runtime Namespace