ServerDocument (Constructor) (String, Boolean) (2003 System)

Artículo
08/23/2008

Actualización: noviembre 2007

Inicializa una nueva instancia de la clase ServerDocument con la ruta de acceso del documento que se va a cargar y un valor que indica si se debe crear un control de almacenamiento en tiempo de ejecución cuando el documento no tenga una personalización de Visual Studio Tools para Office.

Espacio de nombres: Microsoft.VisualStudio.Tools.Applications.Runtime
Ensamblado: Microsoft.VisualStudio.Tools.Applications.Runtime (en Microsoft.VisualStudio.Tools.Applications.Runtime.dll)

Sintaxis

'Declaración
Public Sub New ( _
    documentPath As String, _
    onClient As Boolean _
)
'Uso
Dim documentPath As String
Dim onClient As Boolean

Dim instance As New ServerDocument(documentPath, _
    onClient)

public ServerDocument(
    string documentPath,
    bool onClient
)

Parámetros

documentPath
Tipo: System. . :: .String

Ruta de acceso al documento que se va a cargar en la clase.

onClient
Tipo: System. . :: .Boolean

true para crear un control de almacenamiento en tiempo de ejecución en el documento si el documento no tiene una personalización de Visual Studio Tools para Office; de lo contrario, false.

Excepciones

Excepción	Condición
ArgumentNullException	El parámetro documentPath es null Nothing nullptr referencia null (Nothing en Visual Basic) o está vacío, o se compone únicamente de caracteres de espacio en blanco.
FileNotFoundException	El archivo especificado por documentPath no existe.
IOException	El archivo especificado por documentPath es de sólo lectura o no se puede obtener acceso a él.
CannotLoadManifestException	El archivo especificado por documentPath no tiene una personalización de Visual Studio Tools para Office y onClient es false.

Comentarios

Use este constructor si desea abrir un documento que no tiene todavía una personalización de Visual Studio Tools para Office. Esto resulta útil si desea agregar los datos almacenados en memoria caché a un documento que no tiene todavía una personalización. Cuando se usa este constructor, el documento se abre con acceso de lectura y escritura desde el disco.

Si el documento especificado no tiene una personalización de Visual Studio Tools para Office, este constructor agrega un control de almacenamiento en tiempo de ejecución al documento si el parámetro onClient es true. Este proceso requiere que el documento esté en un equipo que tenga Word o Excel instalado. Si el documento está en un servidor, debe establecer onClient en false o usar el constructor ServerDocument..::.ServerDocument(String). Para obtener más información sobre el Control de almacenamiento en tiempo de ejecución, vea Información general acerca del control de almacenamiento del motor en tiempo de ejecución.

Ejemplos

En el ejemplo de código siguiente se utiliza el constructor ServerDocument(String, Boolean) para crear un nuevo ServerDocument y, a continuación, se muestran los nombres de todos los objetos de la caché de datos del documento. En este ejemplo se necesita una referencia al ensamblado Microsoft.VisualStudio.Tools.Applications.Runtime y una instrucción Imports (para Visual Basic) o using (para C#) para el espacio de nombres Microsoft.VisualStudio.Tools.Applications.Runtime al principio del archivo de código.

Private Sub CreateServerDocumentOnClient(ByVal fileName As String)
    If ServerDocument.IsCustomized(fileName) Then
        Dim serverDocument1 As ServerDocument = Nothing
        Try
            serverDocument1 = New ServerDocument(fileName, True)
            Dim stringBuilder1 As New System.Text.StringBuilder()

            ' Display all of the cached data items 
            ' in the document.
            Dim hostItem1 As CachedDataHostItem
            For Each hostItem1 In serverDocument1.CachedData.HostItems
                stringBuilder1.Append(vbLf + "Namespace and class: ")
                stringBuilder1.Append(hostItem1.Id + vbLf)
                Dim dataItem1 As CachedDataItem
                For Each dataItem1 In hostItem1.CachedData
                    stringBuilder1.Append("     Data item: ")
                    stringBuilder1.Append(dataItem1.Id + vbLf)
                Next dataItem1
            Next hostItem1
            MsgBox(stringBuilder1.ToString())
        Finally
            If Not serverDocument1 Is Nothing Then
                serverDocument1.Close()
            End If
        End Try
    Else
        MsgBox("The specified document is not " + _
            "customized.")
    End If
End Sub

private void CreateServerDocumentOnClient(string fileName)
{
    if (ServerDocument.IsCustomized(fileName))
    {
        ServerDocument serverDocument1 = null;
        try
        {
            serverDocument1 = new ServerDocument(fileName,
                true);
            System.Text.StringBuilder stringBuilder1 =
                new System.Text.StringBuilder();

            // Display all of the cached data items 
            // in the document.
            foreach (CachedDataHostItem hostItem1 in
                serverDocument1.CachedData.HostItems)
            {
                stringBuilder1.Append("\nNamespace and class: ");
                stringBuilder1.Append(hostItem1.Id + "\n");
                foreach (CachedDataItem dataItem1 in
                    hostItem1.CachedData)
                {
                    stringBuilder1.Append("     Data item: ");
                    stringBuilder1.Append(dataItem1.Id + "\n");
                }
            }
            MessageBox.Show(stringBuilder1.ToString());
        }
        finally
        {
            if (serverDocument1 != null)
                serverDocument1.Close();
        }
    }
    else
    {
        MessageBox.Show("The specified document is not " +
            "customized.");
    }
}

Permisos

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.