CachedDataItem-Klasse

Artikel
05/07/2013

Stellt ein zwischengespeichertes Datenobjekt in einer Anpassung auf Dokumentebene dar, die mithilfe der Office-Entwicklungstools in Visual Studio erstellt wurde.

Vererbungshierarchie

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

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

Syntax

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

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

Der CachedDataItem-Typ macht die folgenden Member verfügbar.

Eigenschaften

	Name	Beschreibung
	DataType	Ruft den durch die Assembly qualifizierten Typnamen des zwischengespeicherten Datenobjekts ab, oder legt diesen fest.
	Id	Ruft den Namen des durch CachedDataItem dargestellten zwischengespeicherten Datenobjekts ab oder legt den Namen fest.
	Schema	Ruft ein Schema ab, welches das durch CachedDataItem dargestellte zwischengespeicherte Datenobjekt beschreibt, sofern es sich bei dem zwischengespeicherten Datenobjekt um DataSet oder DataTable handelt, oder legt dieses Schema fest.
	Xml	Ruft die XML-Darstellung des durch CachedDataItem dargestellten zwischengespeicherten Datenobjekts ab, oder legt diese fest.

Zum Seitenanfang

Methoden

	Name	Beschreibung
	Equals	Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist. (Von Object geerbt.)
	GetHashCode	Fungiert als Hashfunktion für einen bestimmten Typ. (Von Object geerbt.)
	GetType	Ruft den Type der aktuellen Instanz ab. (Von Object geerbt.)
	SerializeDataInstance	Serialisiert Daten an dem zwischengespeicherten Datenobjekt, das durch das CachedDataItem dargestellt wird.
	ToString	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Von Object geerbt.)

Zum Seitenanfang

Hinweise

Weitere Informationen über das Zwischenspeichern von Daten in Anpassungen auf Dokumentebene finden Sie unter Zwischenspeichern von Daten und unter Zugreifen auf Daten in Dokumenten auf dem Server

Beispiele

Im folgenden Codebeispiel wird jedes CachedDataItem im Datencache einer Excel-Arbeitsmappe untersucht, und die Namen der einzelnen zwischengespeicherten Datenobjekte werden angezeigt.

Dieses Beispiel setzt Folgendes voraus:

Ein Konsolenanwendungsprojekt oder ein anderes Nicht-Office-Projekt.
Verweise auf die folgenden Assemblys:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll
- Microsoft.VisualStudio.Tools.Applications.Runtime.dll
Imports-Anweisungen (für Visual Basic) oder using-Anweisungen (für C#) für Microsoft.VisualStudio.Tools.Applications- und Microsoft.VisualStudio.Tools.Applications.Runtime-Namespaces am Anfang der Codedatei.

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();
    }
}

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.