Sdílet prostřednictvím

ServerDocument.IsCacheEnabled-Methode (2007 System)

  • Článek

Aktualisiert: November 2007

Ruft einen Wert ab, der angibt, ob das angegebene Dokument einen Datencache besitzt.

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

Syntax

'Declaration
Public Shared Function IsCacheEnabled ( _
    documentPath As String _
) As Boolean
'Usage
Dim documentPath As String
Dim returnValue As Boolean

returnValue = ServerDocument.IsCacheEnabled(documentPath)

public static bool IsCacheEnabled(
    string documentPath
)

Parameter

  • documentPath
    Typ: System.String

    Der vollständige Pfad zu dem Dokument, das Sie überprüfen möchten.

Rückgabewert

Typ: System.Boolean

true , wenn das angegebene Dokument über einen Datencache verfügt, andernfalls false.

Ausnahmen

Ausnahme Bedingung
ArgumentNullException

Der documentPath-Parameter ist entweder nullNULL-Verweis (Nothing in Visual Basic) oder leer, oder er besteht nur aus Leerzeichen.
FileNotFoundException

Die in documentPath angegebene Datei ist nicht vorhanden.
DocumentCustomizedWithPreviousRuntimeException

Die in documentPath angegebene Datei verfügt über eine Anpassung, die mit einer früheren Version der Visual Studio Tools for Office-Laufzeit erstellt wurde.

Hinweise

Diese Methode gibt nur an, ob das Dokument einen Datencache hat. Angaben darüber, ob der Datencache aktuell Daten enthält, erfolgen nicht. Wenn das Dokument einen Datencache hat, der keine Daten enthält, gibt diese Methode dennoch true zurück.

Beispiele

Im folgenden Codebeispiel wird ein neues ServerDocument erstellt und anschließend die CachedData-Eigenschaft verwendet, um den Inhalt des Datencaches anzuzeigen. Im Beispiel wird zuerst die IsCacheEnabled-Methode verwendet, um zu prüfen, ob die Arbeitsmappe einen Datencache hat.

Für dieses Beispiel ist am Anfang der Codedatei ein Verweis auf die Assemblys Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll sowie auf die Anweisung Imports (für Visual Basic) oder using (für C#) für die Namespaces Microsoft.VisualStudio.Tools.Applications und Microsoft.VisualStudio.Tools.Applications.Runtime erforderlich.

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

Berechtigungen

Siehe auch

Referenz

ServerDocument-Klasse

ServerDocument-Member

Microsoft.VisualStudio.Tools.Applications-Namespace