CachedDataItem.SerializeDataInstance(Object) Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Sérialise les données dans l’objet de données en cache représenté par le CachedDataItem.
public void SerializeDataInstance (object value);
Paramètres
- value
- Object
Objet qui contient les données que vous souhaitez enregistrer dans un objet du cache de données.
Exemples
L’exemple de code suivant utilise la SerializeDataInstance méthode pour modifier la valeur d’une chaîne mise en cache dans une feuille de calcul d’un classeur Excel.
Cet exemple nécessite :
Une personnalisation au niveau du document pour Excel qui a une
Sheet1classe dans l'ExcelWorkbook1espace de noms et une chaîne mise en cache dans laSheet1classe nomméeCachedString.Projet d’application console ou autre projet non-Office.
Références aux assemblys suivants :
Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll
Microsoft.VisualStudio.Tools.Applications.Runtime.dll
Imports(pour Visual Basic) ouusing(pour C#) des instructions pour les Microsoft.VisualStudio.Tools.Applications Microsoft.VisualStudio.Tools.Applications.Runtime espaces de noms et en haut de votre fichier de code.
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();
}
}
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
Remarques
Utilisez la SerializeDataInstance méthode pour initialiser ou modifier la valeur d’un objet de données mis en cache. Cette méthode sérialise le value paramètre dans l’objet de données mis en cache représenté par le CachedDataItem . Pour apporter des modifications à des valeurs de données spécifiques dans un objet de données mis en cache complexe, tel qu’un DataSet ou 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 SerializeDataInstance méthode pour sérialiser à nouveau les modifications dans le cache de données. Pour plus d’informations, consultez accès aux données dans les documents sur le serveur et procédure pas à pas : modification des données mises en cache dans un classeur sur un serveur.
Cette méthode utilise le format DiffGram pour sérialiser DataSet DataTable les objets DataSet typés, et 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.