ServerDocument.CachedData Property

Gets a CachedData object that represents the cached data that is contained in the document.

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

public CachedData CachedData { get; }

Property Value

Type: Microsoft.VisualStudio.Tools.Applications.CachedData
The cached data that is contained in the document.

The cached data in a document is stored in a hierarchy of objects. The CachedData object returned by this property is the first object in that hierarchy. For more information, see Accessing Data in Documents on the Server.

The following code example creates a new ServerDocument, and then uses the CachedData property to display the names of the objects in the data cache.

This example requires:

  • A console application project or some other non-Office project.

  • References to the following assemblies:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll and Microsoft.VisualStudio.Tools.Applications.Runtime.dll (if the project targets the .NET Framework 4).


    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll and Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (if the project targets the .NET Framework 3.5).

  • 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.

private void DisplayDataCacheContents(string documentPath)
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);

        if (runtimeVersion != 3)
            MessageBox.Show("This document does not have a Visual Studio Tools for " +
                "Office customization, or it has a customization that was created with " +
                "a version of the runtime that is incompatible with this version of the " +
                "ServerDocument class.");

        if (ServerDocument.IsCacheEnabled(documentPath))
            serverDocument1 = new ServerDocument(documentPath);
            System.Text.StringBuilder stringBuilder1 =
                new System.Text.StringBuilder();

            // Display all of the cached data items 
            // in the document.
            foreach (CachedDataHostItem hostItem1 in
                stringBuilder1.Append("\nNamespace and class: ");
                stringBuilder1.Append(hostItem1.Id + "\n");
                foreach (CachedDataItem dataItem1 in
                    stringBuilder1.Append("     Data item: ");
                    stringBuilder1.Append(dataItem1.Id + "\n");
            MessageBox.Show("The specified document does not have cached data.");
    catch (System.IO.FileNotFoundException)
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
    catch (UnknownCustomizationFileException)
        System.Windows.Forms.MessageBox.Show("The specified document has a file " +
            "extension that is not supported by Visual Studio Tools for Office.");
        if (serverDocument1 != null)

Community Additions