CachedDataItem.SerializeDataInstance Метод (2007 System)

Статья
11/16/2008

Обновлен: Ноябрь 2007

Выполняет сериализацию данных в кэшированный объект данных, который представлен элементом CachedDataItem.

Пространство имен: Microsoft.VisualStudio.Tools.Applications
Сборка: Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0 (в Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll)

Синтаксис

'Декларация
Public Sub SerializeDataInstance ( _
    value As Object _
)
'Применение
Dim instance As CachedDataItem
Dim value As Object

instance.SerializeDataInstance(value)

public void SerializeDataInstance(
    Object value
)

Параметры

value
Тип: System.Object
Объект, содержащий данные, которые необходимо сохранить в объект в кэше данных.

Заметки

Используйте метод SerializeDataInstance для инициализации или изменения кэшированного объекта данных. Этот метод выполняет сериализацию параметра value в объект кэшированных данных, представленный элементом CachedDataItem. Чтобы изменить сложный кэшированный объект данных, например DataSet или DataTable, необходимо выполнить десериализацию XML-представления кэшированных данных в новый экземпляр объекта кэшированных данных, внести изменения в эту копию, а затем с помощью метода SerializeDataInstance выполнить сериализацию изменений обратно в кэш данных. Дополнительные сведения см. в разделах Доступ к данным в документах на сервере и Практическое руководство. Изменение кэшированных данных в книге на сервере.

Этот метод использует формат DiffGram для сериализации в кэш данных объектов DataSet, DataTable и объектов типизированного набора данных. Это гарантирует, что изменения, внесенные в кэш данных автономного документа, будут корректно переданы серверу. Дополнительные сведения см. в разделе Объекты DiffGram (ADO.NET).

Примеры

Следующий пример демонстрирует использование метода SerializeDataInstance для изменения значения строки, кэшированной на листе книги Excel.

Для этого примера требуются ссылки на сборки Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll, Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll и операторы Imports (в Visual Basic) или using (в C#) для пространств имен Microsoft.VisualStudio.Tools.Applications и Microsoft.VisualStudio.Tools.Applications.Runtime в начале файла с кодом. Также предполагается, что в указанной рабочей книге есть настройка с классом Sheet1 в пространстве имен ExcelWorkbook1, а также кэшированная строка в классе Sheet1 с именем CachedString.

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

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.