ServerDocument Constructores

Referencia

Definición

Espacio de nombres:: Microsoft.VisualStudio.Tools.Applications

Ensamblado:: Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Sobrecargas

ServerDocument(String)	Inicializa una nueva instancia de la clase ServerDocument utilizando la ruta de acceso completa del documento que se va a cargar.
ServerDocument(Byte[], String)	Inicializa una nueva instancia de la clase ServerDocument utilizando una matriz de bytes que representa el documento que se va a cargar y la extensión de nombre de archivo del documento.
ServerDocument(Stream, String)	Inicializa una nueva instancia de la clase ServerDocument utilizando una secuencia que representa el documento que se va a cargar y la extensión de nombre de archivo del documento.
ServerDocument(String, FileAccess)	Inicializa una nueva instancia de la clase ServerDocument utilizando la ruta de acceso completa del documento que se va a cargar y un valor que indica el acceso a archivos del documento.

ServerDocument(String)

Inicializa una nueva instancia de la clase ServerDocument utilizando la ruta de acceso completa del documento que se va a cargar.

public:
 ServerDocument(System::String ^ documentPath);

public ServerDocument (string documentPath);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : string -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (documentPath As String)

Parámetros

documentPath: String

Ruta de acceso completa del documento que se va a cargar.

Excepciones

ArgumentNullException

El parámetro documentPath es null o está vacío, o se compone únicamente de caracteres de espacio en blanco.

FileNotFoundException

El archivo especificado por documentPath no existe.

DocumentCustomizedWithPreviousRuntimeException

El archivo especificado por documentPath tiene una personalización que no se creó con el Runtime de Visual Studio 2010 Tools para Office o Visual Studio Tools para Microsoft Office system (versión 3.0 Runtime).

UnknownCustomizationFileException

El archivo especificado por documentPath tiene una extensión de nombre de archivo que no es compatible con el entorno de ejecución de Visual Studio Tools para Office.

Ejemplos

En el ejemplo de código siguiente se usa el ServerDocument(String) constructor para crear un nuevo ServerDocument que cargue un documento especificado. A continuación, en el ejemplo se muestra la dirección URL del manifiesto de implementación para la personalización adjunta al documento.

Para este ejemplo se necesita:

Un proyecto de aplicación de consola o algún otro proyecto que no sea de Office.
Referencias a los ensamblados siguientes:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si el proyecto tiene como destino .NET Framework 4 o .NET Framework 4.5).
  
  o
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si el proyecto tiene como destino .NET Framework 3.5).
Imports (para Visual Basic) o using (para instrucciones de C#) para Microsoft.VisualStudio.Tools.Applications espacios de nombres y Microsoft.VisualStudio.Tools.Applications.Runtime en la parte superior del archivo de código.

private void CreateServerDocumentFromPath(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            serverDocument1 = new ServerDocument(documentPath);
            MessageBox.Show("The URL of the deployment manifest is: \n" +
                serverDocument1.DeploymentManifestUrl.ToString());
        }
    }
    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 CreateServerDocumentFromPath(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            serverDocument1 = New ServerDocument(documentPath)
            MessageBox.Show("The URL of the deployment manifest is: " & vbLf & _
                serverDocument1.DeploymentManifestUrl.ToString())
        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

Comentarios

Use este constructor para acceder a la información del manifiesto de implementación o datos almacenados en caché en un documento que se encuentra en el disco. Cuando se usa este constructor, el documento especificado se abre con acceso de lectura y escritura.

Se aplica a

ServerDocument(Byte[], String)

Inicializa una nueva instancia de la clase ServerDocument utilizando una matriz de bytes que representa el documento que se va a cargar y la extensión de nombre de archivo del documento.

public:
 ServerDocument(cli::array <System::Byte> ^ bytes, System::String ^ fileType);

public ServerDocument (byte[] bytes, string fileType);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : byte[] * string -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (bytes As Byte(), fileType As String)

Parámetros

bytes: Byte[]

Matriz de bytes que representa el documento que se va a cargar.

fileType: String

Extensión de nombre de archivo del documento almacenado en el bytes parámetro , precedido por un punto (.) —por ejemplo, ".xlsx" o ".docx".

Excepciones

ArgumentNullException

El bytes parámetro es o está null vacío.-o-El fileType parámetro es null o está vacío o consta completamente de caracteres de espacio en blanco.

UnknownCustomizationFileException

El fileType parámetro especifica una extensión de nombre de archivo que no es compatible con el entorno de ejecución de Visual Studio Tools para Office.

DocumentCustomizedWithPreviousRuntimeException

Ejemplos

En el ejemplo de código siguiente se usa el constructor [ServerDocument Constructor (Constructor Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.%23ctor%28System.Byte%5B%5D%2CSystem.String%29> ) para crear un nuevo constructor [ServerDocument Constructor (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument> desde una matriz de bytes que contiene un libro de Excel con la extensión de nombre de archivo .xlsx. A continuación, en el ejemplo se usa la propiedad [Constructor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> ) para mostrar el número de bytes del documento.

Para este ejemplo se necesita:

Un proyecto de aplicación de consola o algún otro proyecto que no sea de Office.
Referencias a los ensamblados siguientes:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si el proyecto tiene como destino .NET Framework 4 o .NET Framework 4.5).
  
  o
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si el proyecto tiene como destino .NET Framework 3.5).
Imports (para Visual Basic) o using (para C#) instrucciones para [Constructor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications?displayProperty=fullName> y [Constructor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.Runtime?displayProperty=fullName> ) en la parte superior del archivo de código.

private void CreateServerDocumentFromByteArray(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;
    System.IO.FileStream stream = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            // Read the file into a byte array.
            stream = new System.IO.FileStream(
                documentPath, System.IO.FileMode.Open,
                System.IO.FileAccess.Read);
            byte[] buffer = new byte[(int)stream.Length];
            stream.Read(buffer, 0, (int)buffer.Length);

            // Display the number of bytes in the document.
            serverDocument1 = new ServerDocument(buffer,
                "*.xlsx");
            MessageBox.Show("The Document property contains " +
                serverDocument1.Document.Length.ToString() +
                " bytes.");
        }
    }
    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();
        if (stream != null)
            stream.Close();
    }
}

Private Sub CreateServerDocumentFromByteArray(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing
    Dim stream As System.IO.FileStream = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            ' Read the file into a byte array.
            stream = New System.IO.FileStream(documentPath, System.IO.FileMode.Open, _
                System.IO.FileAccess.Read)
            Dim buffer(Fix(stream.Length)) As Byte
            stream.Read(buffer, 0, Fix(buffer.Length))

            ' Display the number of bytes in the document.
            serverDocument1 = New ServerDocument(buffer, "*.xlsx")
            MessageBox.Show("The Document property contains " & _
                serverDocument1.Document.Length.ToString() & " bytes.")
        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
        If Not (stream Is Nothing) Then
            stream.Close()
        End If
    End Try
End Sub

Comentarios

Use este constructor para acceder a la información del manifiesto de implementación o datos almacenados en caché en un documento que ya está en memoria. Cuando se usa este constructor, el documento se abre con acceso de lectura y escritura.

El fileType parámetro solo se usa para determinar el tipo de documento almacenado en la matriz de bytes. El valor de fileType se asigna a uno de los tipos de archivo que se admiten para las personalizaciones de nivel de documento. No se intenta abrir el archivo. Opcionalmente, puede pasar un nombre de archivo completo (por ejemplo, "Workbook1.xlsx"), pero si lo hace, solo se usa la extensión de nombre de archivo. Para obtener más información sobre los tipos de archivo admitidos, vea Arquitectura de Document-Level Personalizaciones.

Para tener acceso a la matriz de bytes del documento después de llamar a este constructor, utilice la propiedad [Constructor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> ).

Se aplica a

ServerDocument(Stream, String)

Inicializa una nueva instancia de la clase ServerDocument utilizando una secuencia que representa el documento que se va a cargar y la extensión de nombre de archivo del documento.

public:
 ServerDocument(System::IO::Stream ^ stream, System::String ^ fileType);

public ServerDocument (System.IO.Stream stream, string fileType);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : System.IO.Stream * string -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (stream As Stream, fileType As String)

Parámetros

stream: Stream

Secuencia que representa el documento que se va a cargar.

fileType: String

Extensión de nombre de archivo del documento almacenado en el bytes parámetro , precedido por un punto (.) —por ejemplo, ".xlsx" o ".docx".

Excepciones

ArgumentNullException

El stream parámetro es o está null vacío.-o-El fileType parámetro es null o está vacío o consta completamente de caracteres de espacio en blanco.

ArgumentException

El parámetro stream es de longitud cero o su posición actual está al final de la secuencia.

UnknownCustomizationFileException

El fileType parámetro especifica una extensión de nombre de archivo que no es compatible con el entorno de ejecución de Visual Studio Tools para Office.

DocumentCustomizedWithPreviousRuntimeException

Ejemplos

En el ejemplo de código siguiente se usa el ServerDocument(Stream, String) constructor para crear un nuevo ServerDocument a partir de un FileStream objeto que contiene un libro de Excel con la extensión de nombre de archivo .xlsx. A continuación, el código muestra la dirección URL del manifiesto de implementación para la personalización adjunta al documento.

Para este ejemplo se necesita:

Un proyecto de aplicación de consola o algún otro proyecto que no sea de Office.
Referencias a los ensamblados siguientes:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si el proyecto tiene como destino .NET Framework 4 o .NET Framework 4.5).
  
  o
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si el proyecto tiene como destino .NET Framework 3.5).
Imports (para Visual Basic) o using (para instrucciones de C#) para Microsoft.VisualStudio.Tools.Applications espacios de nombres y Microsoft.VisualStudio.Tools.Applications.Runtime en la parte superior del archivo de código.

private void CreateServerDocumentFromStream(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;
    System.IO.FileStream stream = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            stream = new System.IO.FileStream(
                documentPath, System.IO.FileMode.Open);
            serverDocument1 = new ServerDocument(stream,
                "*.xlsx");
            MessageBox.Show("The URL of the deployment manifest is: \n" +
                serverDocument1.DeploymentManifestUrl.ToString());
        }
    }
    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();
        if (stream != null)
            stream.Close();
    }
}

Private Sub CreateServerDocumentFromStream(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing
    Dim stream As System.IO.FileStream = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            stream = New System.IO.FileStream(documentPath, System.IO.FileMode.Open)
            serverDocument1 = New ServerDocument(stream, "*.xlsx")
            MessageBox.Show("The URL of the deployment manifest is: " & vbLf & _
                serverDocument1.DeploymentManifestUrl.ToString())
        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
        If Not (stream Is Nothing) Then
            stream.Close()
        End If
    End Try
End Sub

Comentarios

Para acceder a la matriz de bytes del documento después de llamar a este constructor, use la Document propiedad .

Se aplica a

ServerDocument(String, FileAccess)

Inicializa una nueva instancia de la clase ServerDocument utilizando la ruta de acceso completa del documento que se va a cargar y un valor que indica el acceso a archivos del documento.

public:
 ServerDocument(System::String ^ documentPath, System::IO::FileAccess access);

public ServerDocument (string documentPath, System.IO.FileAccess access);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : string * System.IO.FileAccess -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (documentPath As String, access As FileAccess)

Parámetros

documentPath: String

Ruta de acceso completa del documento que se va a cargar.

access: FileAccess

Valor que indica el acceso a archivos del documento.

Excepciones

ArgumentNullException

El parámetro documentPath es null o está vacío, o se compone únicamente de caracteres de espacio en blanco.

ArgumentException

El valor de access es System.IO.FileAccess.Write.

FileNotFoundException

El archivo especificado por documentPath no existe.

DocumentNotCustomizedException

El archivo especificado por el documentPath parámetro no tiene una personalización y el valor de access es System.IO.FileAccess.Read.

DocumentCustomizedWithPreviousRuntimeException

UnknownCustomizationFileException

El archivo especificado por documentPath tiene una extensión de nombre de archivo que no es compatible con el entorno de ejecución de Visual Studio Tools para Office.

Ejemplos

En el ejemplo de código siguiente se usa el ServerDocument(String, FileAccess) constructor para crear un nuevo ServerDocument que cargue un documento especificado con acceso de solo lectura. A continuación, el código muestra la dirección URL del manifiesto de implementación para la personalización adjunta al documento.

Para este ejemplo se necesita:

Un proyecto de aplicación de consola o algún otro proyecto que no sea de Office.
Referencias a los ensamblados siguientes:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si el proyecto tiene como destino .NET Framework 4 o .NET Framework 4.5).
  
  o
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si el proyecto tiene como destino .NET Framework 3.5).
Imports (para Visual Basic) o using (para instrucciones de C#) para Microsoft.VisualStudio.Tools.Applications espacios de nombres y Microsoft.VisualStudio.Tools.Applications.Runtime en la parte superior del archivo de código.

private void CreateServerDocumentReadOnly(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            serverDocument1 = new ServerDocument(documentPath,
                System.IO.FileAccess.Read);
            MessageBox.Show("The URL of the deployment manifest is: \n" +
                serverDocument1.DeploymentManifestUrl.ToString());
        }
    }
    catch (System.IO.FileNotFoundException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
    }
    catch (DocumentNotCustomizedException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not " +
            "have a customization.");
    }
    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 CreateServerDocumentReadOnly(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            serverDocument1 = New ServerDocument(documentPath, System.IO.FileAccess.Read)
            MessageBox.Show("The URL of the deployment manifest is: " & vbLf & _
                serverDocument1.DeploymentManifestUrl.ToString())
        End If

    Catch ex As System.IO.FileNotFoundException
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
    Catch ex As DocumentNotCustomizedException
        System.Windows.Forms.MessageBox.Show("The specified document does not " & _
            "have a customization.")
    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

Comentarios

Use este constructor para acceder a la información del manifiesto de implementación o datos almacenados en caché en un documento que se encuentra en el disco si desea abrir el documento con acceso de solo lectura o de solo escritura. De forma predeterminada, los demás ServerDocument constructores abren el documento con acceso de lectura y escritura.

Se aplica a

Compartir a través de

ServerDocument Constructores

Definición

Sobrecargas

ServerDocument(String)

Parámetros

Excepciones

Ejemplos

Comentarios

Se aplica a

ServerDocument(Byte[], String)

Parámetros

Excepciones

Ejemplos

Comentarios

Se aplica a

ServerDocument(Stream, String)

Parámetros

Excepciones

Ejemplos

Comentarios

Se aplica a

ServerDocument(String, FileAccess)

Parámetros

Excepciones

Ejemplos

Comentarios

Se aplica a

Recursos adicionales