CachedDataItem.SerializeDataInstance メソッド

データを CachedDataItem によって表されるキャッシュ データ オブジェクトとしてシリアル化します。

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

構文

'宣言
Public Sub SerializeDataInstance ( _
    value As Object _
)

public void SerializeDataInstance(
    Object value
)

パラメーター

• value
  型: System.Object
  対象データ (データ キャッシュ内のオブジェクトとして保存するデータ) が格納されているオブジェクト。

解説

SerializeDataInstance メソッドは、キャッシュ データ オブジェクトの値を初期化または変更するときに使用します。 このメソッドでは、value パラメーターが、CachedDataItem によって表されるキャッシュ データ オブジェクトとしてシリアル化されます。 DataSet や DataTable など、複雑なキャッシュ データ オブジェクト内の特定のデータの値に変更を加える場合は、そのキャッシュ データの XML 表現を、キャッシュ オブジェクトの新しいインスタンスとして逆シリアル化し、このコピーに対して変更を加えた後で、SerializeDataInstance メソッドを使って、再度データ キャッシュとしてシリアル化するようにします。 詳細については、「サーバー上のドキュメント内のデータへのアクセス」および「方法 : サーバー上のブックでキャッシュされたデータを変更する」を参照してください。

このメソッドでは、DataSet、DataTable、および型指定されたデータセット オブジェクトをデータ キャッシュ内でシリアル化する際に DiffGram 形式を使用します。 これにより、オフライン ドキュメントのデータ キャッシュに対する変更がサーバーに正しく送信されるようになります。 詳細については、「DiffGrams (ADO.NET)」を参照してください。

例

次のコード例では、SerializeDataInstance メソッドを使用して、Excel ブックのワークシートにキャッシュされている文字列の値を変更します。

この例には、次の項目が必要です。

• ExcelWorkbook1 名前空間に Sheet1 クラスを持ち、CachedString という名前の Sheet1 クラスにキャッシュされた文字列を持つ、Excel のドキュメント レベルのカスタマイズ。

• コンソール アプリケーション プロジェクトまたはその他の Office 以外のプロジェクト。

• 次のアセンブリへの参照。

  • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll および Microsoft.VisualStudio.Tools.Applications.Runtime.dll (プロジェクトが .NET Framework 4 を対象とする場合)。

    または

  • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll および Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (プロジェクトが .NET Framework 3.5 を対象とする場合)。

• コード ファイルの先頭に、Microsoft.VisualStudio.Tools.Applications 名前空間および Microsoft.VisualStudio.Tools.Applications.Runtime 名前空間に対する Imports ステートメント (Visual Basic の場合) または using ステートメント (C# の場合) を追加します。

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 セキュリティ

• 直前の呼び出し元に対する完全な信頼。 このメンバーは、部分的に信頼されているコードから使用することはできません。 詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

参照

CachedDataItem クラス

Microsoft.VisualStudio.Tools.Applications 名前空間

その他の技術情報

サーバー上のドキュメント内のデータへのアクセス