CachedDataItem 클래스(2007 시스템)

아티클
08/22/2008

업데이트: 2007년 11월

Visual Studio Tools for Office를 사용하여 만든 문서 수준 사용자 지정의 캐시된 데이터 개체를 나타냅니다.

네임스페이스: Microsoft.VisualStudio.Tools.Applications
어셈블리: Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0(Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll)

구문

<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public NotInheritable Class CachedDataItem _
    Inherits CachedDataNodeBase

Dim instance As CachedDataItem

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

설명

문서 수준 사용자 지정에서의 데이터 캐시에 대한 자세한 내용은 데이터 캐싱 및 서버에 있는 문서의 데이터 액세스를 참조하십시오.

참고:
이 클래스는 Microsoft Office Word 2007 및 Microsoft Office Excel 2007용 솔루션에만 사용할 수 있습니다. Word 2003 및 Excel 2003용 솔루션의 캐시된 데이터에 액세스하려면 Visual Studio 2005 Tools for Office Second Edition 런타임에서 Microsoft.VisualStudio.Tools.Applications.Runtime 네임스페이스의 CachedDataItem 클래스를 사용합니다. 자세한 내용은 ServerDocument 클래스를 사용하여 서버의 문서 관리를 참조하십시오.

이 클래스는 Microsoft Office Word 2007 및 Microsoft Office Excel 2007용 솔루션에만 사용할 수 있습니다. Word 2003 및 Excel 2003용 솔루션의 캐시된 데이터에 액세스하려면 Visual Studio 2005 Tools for Office Second Edition 런타임에서 Microsoft.VisualStudio.Tools.Applications.Runtime 네임스페이스의 CachedDataItem 클래스를 사용합니다. 자세한 내용은 ServerDocument 클래스를 사용하여 서버의 문서 관리를 참조하십시오.

예제

다음 코드 예제에서는 Excel 통합 문서의 데이터 캐시에서 각 CachedDataItem을 검사하고 캐시된 각 데이터 개체의 이름을 표시합니다.

이 예제를 사용하려면 Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll과 Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll 어셈블리에 대한 참조, Microsoft.VisualStudio.Tools.Applications 및 Microsoft.VisualStudio.Tools.Applications.Runtime 네임스페이스에 대한 Imports(Visual Basic) 또는 using(C#) 문을 코드 파일 맨 위에 추가해야 합니다.

Private Sub DisplayDataCacheContents(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion <> 3 Then
            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.")
            Return
        End If

        If ServerDocument.IsCacheEnabled(documentPath) Then
            serverDocument1 = New ServerDocument(documentPath)
            Dim stringBuilder1 As New System.Text.StringBuilder()

            ' Display all of the cached data items 
            ' in the document.
            Dim hostItem1 As CachedDataHostItem
            For Each hostItem1 In serverDocument1.CachedData.HostItems
                stringBuilder1.Append(vbLf & "Namespace and class: ")
                stringBuilder1.Append(hostItem1.Id & vbLf)
                Dim dataItem1 As CachedDataItem
                For Each dataItem1 In hostItem1.CachedData
                    stringBuilder1.Append("     Data item: ")
                    stringBuilder1.Append(dataItem1.Id & vbLf)
                Next dataItem1
            Next hostItem1
            MessageBox.Show(stringBuilder1.ToString())
        Else
            MessageBox.Show("The specified document does not have cached data.")
        End If

    Catch ex As System.IO.FileNotFoundException
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
    Catch ex As UnknownCustomizationFileException
        System.Windows.Forms.MessageBox.Show("The specified document has a file " & _
            "extension that is not supported by Visual Studio Tools for Office.")
    Finally
        If Not (serverDocument1 Is Nothing) Then
            serverDocument1.Close()
        End If
    End Try
End Sub

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

    try
    {
        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.");
            return;
        }

        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
                serverDocument1.CachedData.HostItems)
            {
                stringBuilder1.Append("\nNamespace and class: ");
                stringBuilder1.Append(hostItem1.Id + "\n");
                foreach (CachedDataItem dataItem1 in
                    hostItem1.CachedData)
                {
                    stringBuilder1.Append("     Data item: ");
                    stringBuilder1.Append(dataItem1.Id + "\n");
                }
            }
            MessageBox.Show(stringBuilder1.ToString());
        }
        else
        {
            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.");
    }
    finally
    {
        if (serverDocument1 != null)
            serverDocument1.Close();
    }
}