CachedDataItem Class

Represents a cached data object in a document-level customization that was created by using the Office development tools in Visual Studio.

Namespace: Microsoft.VisualStudio.Tools.Applications
Assembly: Microsoft.VisualStudio.Tools.Applications.ServerDocument (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Inheritance Hierarchy

System::Object
Microsoft.VisualStudio.Tools.Applications::CachedDataNodeBase
Microsoft.VisualStudio.Tools.Applications::CachedDataItem

Syntax

C++

[PermissionSetAttribute(SecurityAction::Demand, Name = "FullTrust")]
public ref class CachedDataItem sealed : CachedDataNodeBase

Properties

	Name	Description
	DataType	Gets or sets the assembly-qualified name of the type of the cached data object.
	Id	Gets or sets the name of the cached data object that is represented by the CachedDataItem.
	Schema	Gets or sets a schema that describes the cached data object that is represented by the CachedDataItem, if the cached data object is a DataSet or DataTable.
	Xml	Gets or sets the XML representation of the cached data object that is represented by the CachedDataItem.

Methods

	Name	Description
	Equals(Object^)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	SerializeDataInstance(Object^)	Serializes data to the cached data object that is represented by the CachedDataItem.
	ToString()	(Inherited from Object.)

Remarks

For more information about caching data in document-level customizations, see Caching Data and Accessing Data in Documents on the Server.

Examples

The following code example examines each CachedDataItem in the data cache of an Excel workbook and displays the name of each cached data object.

This example requires:

A console application project or some other non-Office project.
References to the following assemblies:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll
- Microsoft.VisualStudio.Tools.Applications.Runtime.dll
Imports (for Visual Basic) or using (for C#) statements for Microsoft.VisualStudio.Tools.Applications and Microsoft.VisualStudio.Tools.Applications.Runtime namespaces at the top of your code file.

C++

No code example is currently available or this language may not be supported.

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.