CachedDataItem.SerializeDataInstance – metoda

  • Článek

Řadí data do mezipaměti objektu, který je zastoupen CachedDataItem.

Obor názvů:  Microsoft.VisualStudio.Tools.Applications
Sestavení:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (v Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntaxe

'Deklarace
Public Sub SerializeDataInstance ( _
    value As Object _
)

public void SerializeDataInstance(
    Object value
)

Parametry

  • value
    Typ: System.Object
    Objekt, který obsahuje data, která chcete uložit na objekt v mezipaměti data.

Poznámky

Použití SerializeDataInstance metodu inicializace nebo změnit hodnotu data uložená v mezipaměti objektu.Tato metoda se řadí value parametr do mezipaměti objektů, CachedDataItem představuje.Konkrétní hodnoty dat v objektu komplexní data v mezipaměti, jako například provádět změny DataSet nebo DataTablerekonstruovat reprezentaci XML dat uložených v mezipaměti do nové instance objektu v mezipaměti, měnit tuto kopii a potom použít SerializeDataInstance metoda serializace změny zpět do mezipaměti data.Další informace naleznete v tématu Přístup k datům v dokumentech na serveru a Návod: Změna dat uložených v mezipaměti sešitu na serveru.

Tato metoda používá formát DiffGram formát serializace DataSet, DataTable, zapsány do mezipaměti data objektů dataset.Tím zajistíte, že změny dat mezipaměť offline dokumentu jsou správně odeslána na server.

Příklady

Následující kód například používá SerializeDataInstance metoda změňte hodnotu řetězce, který je uložen do mezipaměti listu sešitu aplikace Excel.

Tento příklad vyžaduje:

  • Úroveň dokumentu přizpůsobení aplikace Excel, který má Sheet1 třídy v ExcelWorkbook1 oboru názvů a řetězec v mezipaměti Sheet1 třídu s názvem CachedString.

  • Projekt aplikace konzoly nebo některé jiné-Office project.

  • Odkazy na následující sestavení:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll

    • Microsoft.VisualStudio.Tools.Applications.Runtime.dll

  • Imports(pro Visual Basic) nebo using (pro C#) výkazy pro Microsoft.VisualStudio.Tools.Applications a Microsoft.VisualStudio.Tools.Applications.Runtime obory názvů v horní části kódu souboru.

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

Zabezpečení rozhraní .NET Framework

Viz také

Referenční dokumentace

CachedDataItem Třída

Microsoft.VisualStudio.Tools.Applications – obor názvů

Další zdroje

Přístup k datům v dokumentech na serveru