CachedDataItem.Xml-Eigenschaft
Ruft die XML-Darstellung des durch CachedDataItem dargestellten zwischengespeicherten Datenobjekts ab, oder legt diese fest.
Namespace: Microsoft.VisualStudio.Tools.Applications
Assembly: Microsoft.VisualStudio.Tools.Applications.ServerDocument (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)
Syntax
'Declaration
Public Property Xml As String
public string Xml { get; set; }
Eigenschaftswert
Typ: System.String
Die XML-Darstellung des durch CachedDataItem dargestellten zwischengespeicherten Datenobjekts.
Hinweise
Um den Wert eines zwischengespeicherten Datenobjekts zu erhalten, verwenden Sie die Xml-Eigenschaft, um die XML-Darstellung der zwischengespeicherten Daten in eine neue Instanz des zwischengespeicherten Datenobjekts zu deserialisieren.Sie können dann Änderungen an dieser Kopie vornehmen und die Änderungen zurück in den Datencache serialisieren.
Meistens kann die SerializeDataInstance-Methode zum Serialisieren des bearbeiteten Objekts in den Datencache verwendet werden.Wenn Sie eine eigene Serialisierung für Änderungen an zwischengespeicherten Daten durchführen möchten, können Sie auch direkt in die Xml-Eigenschaft schreiben.Wenn Sie jedoch Änderungen an einem DataSet-Objekt, einem DataTable-Objekt oder einem typisierten DataSet-Objekt vornehmen, das unter Verwendung von DataAdapter in eine Datenbank aktualisiert wird, geben Sie beim Schreiben der Änderungen in die zwischengespeicherten Daten das DiffGram-Format an.Die Änderungen am DataSet oder an der DataTable werden der Datenbank sonst anstelle von geänderten Zeilen als neue Zeilen hinzugefügt.Weitere Informationen finden Sie unter Zugreifen auf Daten in Dokumenten auf dem Server.
Beispiele
Im folgenden Codebeispiel wird die Xml-Eigenschaft zum Abrufen des Werts einer Zeichenfolge verwendet, die in einem Arbeitsblatt einer Excel-Arbeitsmappe zwischengespeichert ist.Im Beispiel wird der Wert in einem Meldungsfeld angezeigt.
Dieses Beispiel setzt Folgendes voraus:
Eine Anpassung auf Dokumentebene für Excel, die über eine Sheet1-Klasse im ExcelWorkbook1-Namespace verfügt und eine zwischengespeicherte Zeichenfolge in der Sheet1-Klasse CachedString.
Ein Konsolenanwendungsprojekt oder ein anderes Nicht-Office-Projekt.
Verweise auf die folgenden Assemblys:
Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll
Microsoft.VisualStudio.Tools.Applications.Runtime.dll
Imports-Anweisungen (für Visual Basic) oder using-Anweisungen (für C#) für Microsoft.VisualStudio.Tools.Applications- und Microsoft.VisualStudio.Tools.Applications.Runtime-Namespaces am Anfang der Codedatei.
Private Sub ReadCachedStringValue(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
Using stringReader As New System.IO.StringReader(dataItem1.Xml)
Dim serializer As New System.Xml.Serialization.XmlSerializer(GetType(String))
Dim cachedString As String = serializer.Deserialize(stringReader)
MessageBox.Show("The value of CachedString is: " + cachedString)
End Using
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 ReadCachedStringValue(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))
{
using (System.IO.StringReader stringReader =
new System.IO.StringReader(dataItem1.Xml))
{
System.Xml.Serialization.XmlSerializer serializer =
new System.Xml.Serialization.XmlSerializer(typeof(string));
string cachedString = serializer.Deserialize(stringReader) as string;
MessageBox.Show("The value of CachedString is: " + cachedString);
}
}
}
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();
}
}
Ein Codebeispiel, das die Verwendung der Xml-Eigenschaft zum Bearbeiten und Serialisieren von Änderungen an einem zwischengespeicherten DataSet demonstriert, finden Sie unter Exemplarische Vorgehensweise: Ändern zwischengespeicherter Daten in einer Arbeitsmappe auf einem Server.
.NET Framework-Sicherheit
- Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.