CachedDataItem.Xml プロパティ (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

CachedDataItem によって表される、キャッシュされたデータオブジェクトの XML 表記を取得または設定します。

名前空間 : Microsoft.VisualStudio.Tools.Applications
アセンブリ : Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0 (Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll 内)

構文

'宣言
Public Property Xml As String
'使用
Dim instance As CachedDataItem
Dim value As String

value = instance.Xml

instance.Xml = value

public string Xml { get; set; }

プロパティ値

型 : System.String

CachedDataItem によって表される、キャッシュされたデータオブジェクトの XML 表記。

解説

キャッシュデータオブジェクトの値を取得するには、Xml プロパティを使用して、キャッシュデータの XML 表現を、キャッシュデータオブジェクトの新しいインスタンスとして逆シリアル化します。このコピーに変更を加えた後、シリアル化して、再びデータキャッシュに戻すことができます。

ほとんどの場合は、変更したオブジェクトをデータキャッシュにシリアル化する際に、SerializeDataInstance メソッドを使用できます。キャッシュされたデータの変更に対して独自のシリアル化を実行する必要がある場合は、Xml プロパティに直接書き込むこともできます。ただし、DataSet、DataTable に変更を加える場合、または DataAdapter を使用してデータベースへの更新が行われる、型指定されたデータセットに変更を加える場合は、キャッシュされたデータに変更を書き込むときに DiffGram 形式を指定してください。指定しなかった場合、DataSet または DataTable への変更が、変更された行ではなく新しい行としてデータベースに追加されます。詳細については、「サーバー上のドキュメント内のデータへのアクセス」を参照してください。

例

次のコード例では、Xml プロパティを使用して、Excel ブックのワークシートにキャッシュされている文字列の値を取得します。この値は、メッセージボックスに表示されます。

この例では、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# の場合) が必要です。この例では、指定したブックにカスタマイズが含まれ、ExcelWorkbook1 名前空間の Sheet1 クラス、さらに CachedString という名前の Sheet1 クラスにキャッシュされた文字列が含まれていることも前提としています。

Private Sub ReadCachedStringValue(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

                Using stringReader As New System.IO.StringReader(dataItem1.Xml)
                    Dim serializer As New System.Xml.Serialization.XmlSerializer(GetType(String))
                    Dim cachedString As String = serializer.Deserialize(stringReader)
                    MessageBox.Show("The value of CachedString is: " + cachedString)
                End Using
            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 ReadCachedStringValue(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))
            {
                using (System.IO.StringReader stringReader =
                    new System.IO.StringReader(dataItem1.Xml))
                {
                    System.Xml.Serialization.XmlSerializer serializer =
                        new System.Xml.Serialization.XmlSerializer(typeof(string));
                    string cachedString = serializer.Deserialize(stringReader) as string;
                    MessageBox.Show("The value of CachedString is: " + cachedString);
                }
            }
        }
        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();
    }
}

Xml プロパティを使用して、キャッシュされた DataSet を変更およびシリアル化するコード例については、「方法 : サーバー上のブックでキャッシュされたデータを変更する」を参照してください。