Freigeben über


CachedDataItem.DataType-Eigenschaft

Ruft den durch die Assembly qualifizierten Typnamen des zwischengespeicherten Datenobjekts ab, oder legt diesen fest.

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

Syntax

'Declaration
Public Property DataType As String
    Get
    Set
public string DataType { get; set; }

Eigenschaftswert

Typ: System.String
Der durch die Assembly qualifizierte Typname des zwischengespeicherten Datenobjekts.

Hinweise

Die DataType-Eigenschaft gibt einen durch die Assembly qualifizierten Namen des Typs der zwischengespeicherten Daten zurück, der zum Erstellen einer neuen Instanz eines benutzerdefinierten Typs im Datencache verwendet werden kann. Beispielsweise können Sie den Type eines benutzerdefinierten Datentyps abrufen, indem Sie den durch die Assembly qualifizierten Typnamen an die GetType-Methode übergeben. Sie können dann eine Instanz des benutzerdefinierten Typs erstellen, indem Sie diesen Type als Parameter an die Activator.CreateInstance-Methode übergeben.

Ausführliche Informationen zum Format der von der DataType-Eigenschaft zurückgegebenen, durch eine Assembly qualifizierten Typzeichenfolge finden Sie in der Beschreibung der Type.AssemblyQualifiedName-Eigenschaft.

Beispiele

Im folgenden Codebeispiel wird die SerializeDataInstance-Methode zum Ändern des Werts einer Zeichenfolge verwendet, die in einem Arbeitsblatt einer Excel-Arbeitsmappe zwischengespeichert ist. Der Code verwendet die DataType-Eigenschaft, um vor dem Ändern zu überprüfen, dass das zwischengespeicherte Datenobjekt eine Zeichenfolge ist.

Für dieses Beispiel sind erforderlich:

  • Eine Anpassung auf Dokumentebene für Excel, die über eine Sheet1-Klasse im ExcelWorkbook1-Namespace verfügt und eine zwischengespeicherte Zeichenfolge in der Sheet1-Klasse CachedString.

  • Ein Konsolenanwendungsprojekt oder ein anderes Nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt auf .NET Framework 4 abzielt)

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf .NET Framework 3.5 abzielt).

  • 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 ModifyCachedString(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 hostItem1 As CachedDataHostItem = _
                serverDocument1.CachedData.HostItems("ExcelWorkbook1.Sheet1")
            Dim dataItem1 As CachedDataItem = hostItem1.CachedData("CachedString")

            If dataItem1 IsNot Nothing AndAlso _
                Type.GetType(dataItem1.DataType).Equals(GetType(String)) Then

                dataItem1.SerializeDataInstance("This is the new cached string value.")
                serverDocument1.Save()
            End If
        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 ModifyCachedString(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);
            CachedDataHostItem hostItem1 = 
                serverDocument1.CachedData.HostItems["ExcelWorkbook1.Sheet1"];
            CachedDataItem dataItem1 = hostItem1.CachedData["CachedString"];

            if (dataItem1 != null &&
                Type.GetType(dataItem1.DataType) == typeof(string))
            {
                dataItem1.SerializeDataInstance("This is the new cached string value.");
                serverDocument1.Save();
            }
        }
        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-Sicherheit

Siehe auch

Referenz

CachedDataItem Klasse

Microsoft.VisualStudio.Tools.Applications-Namespace