CachedDataItem.SerializeDataInstance, méthode

Article
08/10/2011

Sérialise les données dans l'objet de données mis en cache représenté par le CachedDataItem.

Espace de noms : Microsoft.VisualStudio.Tools.Applications
Assembly : Microsoft.VisualStudio.Tools.Applications.ServerDocument (dans Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntaxe

'Déclaration
Public Sub SerializeDataInstance ( _
    value As Object _
)

public void SerializeDataInstance(
    Object value
)

Paramètres

value
Type : System.Object
Objet qui contient les données à enregistrer dans un objet du cache de données.

Notes

Utilisez la méthode SerializeDataInstance pour initialiser ou modifier la valeur d'un objet de données mis en cache. Cette méthode sérialise le paramètre value dans l'objet de données mis en cache que le CachedDataItem représente. Pour apporter des modifications à des valeurs de données spécifiques dans un objet de données mis en cache complexe, comme un DataSet ou un DataTable, désérialisez la représentation XML des données mises en cache dans une nouvelle instance de l'objet mis en cache, apportez les modifications à cette copie, puis utilisez la méthode SerializeDataInstance pour sérialiser de nouveau les modifications dans le cache de données. Pour plus d'informations, consultez Accès aux données des documents sur le serveur et Comment : modifier les données mises en cache dans un classeur sur un serveur.

Cette méthode utilise le format DiffGram pour sérialiser le DataSet, le DataTable et les objets d'un groupe de données typé dans le cache de données. Cela garantit que les modifications apportées au cache de données dans un document hors connexion sont envoyées correctement au serveur. Pour plus d'informations, consultez DiffGrams (ADO.NET).

Exemples

L'exemple de code suivant utilise la méthode SerializeDataInstance pour modifier la valeur d'une chaîne mise en cache dans une feuille de calcul d'un classeur Excel.

Cet exemple nécessite les actions ou les éléments suivants :

Une personnalisation au niveau du document pour Excel qui a une classe Sheet1 dans l'espace de noms ExcelWorkbook1, et une chaîne mise en cache dans la classe Sheet1 nommée CachedString.
Projet d'application console ou un autre projet non-Office.
Références aux assemblys suivants :
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si le projet cible .NET Framework 4).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si le projet cible le .NET Framework 3.5).
Instructions Imports (pour Visual Basic) ou using pour C#) pour les espaces de noms Microsoft.VisualStudio.Tools.Applications et Microsoft.VisualStudio.Tools.Applications.Runtime au haut de votre fichier de code.

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

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.