ServerDocument.IsCacheEnabled أسلوب

الحصول على القيمة تشير إلى ما إذا كان مستند المحدد يحتوي بيانات ذاكرة تخزين مؤقت.

مساحة الاسم:  Microsoft.VisualStudio.Tools.Applications
التجميع:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (في Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

بناء الجملة

'إقرار
Public Shared Function IsCacheEnabled ( _
    documentPath As String _
) As Boolean

public static bool IsCacheEnabled(
    string documentPath
)

المعلمات

• documentPath
  النوع: System.String
  مسار الكامل للمستند الذي تريد إلى فحص.

القيمة المُرجعة

النوع: System.Boolean
trueإذا كان مستند المحدد لبيانات ذاكرة تخزين مؤقت؛ وإلاfalse.

استثناءات

استثناء:	شرط
ArgumentNullException	documentPathمعلمة هو nullمرجع خالٍ (لا شيء في Visual Basic)أو فارغة أو consهوts من أحرف المسافات البيضاء.
FileNotFoundException	ملف المحدد بواسطة documentPathغير موجود.
DocumentCustomizedWithPreviousRuntimeException	ملف المحدد مع documentPathله تخصيص التي لم يتم تاريخ الإنشاء مع Visual Studio Tools لـ Office Runtimeأو أدوات ‏‫Visual Studio لنظام Microsoft المكتب 2010 Suite (الإصدار 3.0 وقت التشغيل).

ملاحظات

وهذا أسلوب يشير إلى فقط ما إذا كان مستند يحتوي على ذاكرة التخزين مؤقت بيانات غير ما إذا كانت ذاكرة تخزين مؤقت للبيانات فعلياً يحتوي على بيانات. إذا كان مستند للتخزين مؤقت لبيانات لا يحتوي على بيانات فيه، ما زال هذا الأسلوب بإرجاع true.

أمثلة

يلي تعليمات برمجية المثال، يتم إنشاء جديد ServerDocument، ثم يستخدم CachedDataخاصية لعرض محتويات ذاكرة تخزين مؤقت للبيانات. المثال أول يستخدم IsCacheEnabledأسلوب للتحقق من أن يحتوي مصنف ذاكرة التخزين المؤقتة للبيانات.

يتطلب هذا المثال:

• مشروع تطبيقات وحدة تحكم أو بعض المشاريع بخلاف المكتب الأخرى.

• مراجع إلى تجميعات التالية:

  • Microsoft.VisualStudio.أدوات.Applications.ServerDocument.dll و Microsoft.VisualStudio.أدوات.Applications.وقت التشغيل.dll (إذا كان مشروع تستهدف .NET Framework 4).

    أو

  • Microsoft.VisualStudio.أدوات.Applications.ServerDocument.v10.0.dll و Microsoft.VisualStudio.أدوات.Applications.وقت التشغيل.v9.0.dll (إذا كان مشروع تستهدف 3.5 إطار عمل.NET).

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

أمن NET Framework.

• الثقة الكاملة للمتصل الفوري. يتعذر استخدام هذا العضو بواسطة التعليمات البرمجية الموثوق بها جزئيًا. لمزيد من المعلومات، راجع باستخدام مكتبات من تعليمات برمجية موثوق بها جزئي.

راجع أيضًَا

المرجع

ServerDocument الفئة

ServerDocument الأعضاء

Microsoft.VisualStudio.Tools.Applications مساحة الاسم