Propriedade CachedDataItem.Xml

Artigo
08/01/2011

Obtém ou define a representação XML do objeto de dados em cache que é representado pela CachedDataItem.

Namespace: Microsoft.VisualStudio.Tools.Applications
Assembly: Microsoft.VisualStudio.Tools.Applications.ServerDocument (em Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Sintaxe

'Declaração
Public Property Xml As String
    Get
    Set

public string Xml { get; set; }

Valor de propriedade

Tipo: System.String
A representação XML do objeto de dados em cache que é representado pela CachedDataItem.

Comentários

Para obter o valor de um objeto de dados em cache, use o Xml propriedade desserializar a representação XML dos dados armazenados em cache em uma nova instância do objeto de dados em cache. Você pode fazer as alterações esta cópia e serializar as alterações de volta para o cache de dados.

Na maioria dos casos, você pode usar o SerializeDataInstance método para serializar o objeto alterado para o cache de dados. Se você quiser executar seu próprio de serialização para alterações de dados em cache, você também pode escrever diretamente para o Xml propriedade. No entanto, se você estiver fazendo alterações em um DataSet, DataTable, ou em um dataset tipado que será atualizado para um banco de dados usando um DataAdapter, especifique o formato de DiffGram ao gravar as alterações de dados em cache. Caso contrário, as alterações para o DataSet ou DataTable será adicionado ao banco de dados, como novas linhas em vez de linhas alteradas. For more information, see Acesso a dados em documentos no servidor.

Exemplos

O seguinte exemplo de código usa a Xml a propriedade para obter o valor de uma seqüência que é armazenado em cache em uma planilha de uma pasta de trabalho do Excel. O exemplo exibe o valor em uma caixa de mensagem.

This example requires:

Uma personalização em nível de documento para o Excel tem um Sheet1 classe na ExcelWorkbook1 namespace e uma seqüência de caracteres armazenados em cache na Sheet1 classe nomeada CachedString.
Um projeto de aplicativo de console ou algum outro projeto de não-Office.
Referências aos assemblies seguintes:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se os destinos do projeto de .NET Framework 4).
  
  or
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se os destinos do projeto a.NET Framework 3.5).
Imports(para Visual Basic) ou using (para C#) instruções para Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime namespaces no topo do seu arquivo de código.

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

Para obter um exemplo de código demonstra como usar o Xml propriedade para modificar e serializar as alterações em um cache DataSet, consulte Como: Alterar dados em uma pasta de trabalho em um servidor de cache.

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

CachedDataItem Classe

Namespace Microsoft.VisualStudio.Tools.Applications

Compartilhar via