Compartir a través de


ServerDocument (Constructor) (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.

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

Sintaxis

'Declaración
Public Sub New ( _
    stream As Stream, _
    fileType As String _
)
public ServerDocument(
    Stream stream,
    string fileType
)

Parámetros

  • stream
    Tipo: System.IO.Stream
    Secuencia que representa el documento que se va a cargar.
  • fileType
    Tipo: System.String
    Extensión de nombre de archivo del documento que está almacenada en el parámetro bytes, precedida de un punto (.), por ejemplo, ".xlsx" o ".docx".

Excepciones

Excepción Condición
ArgumentNullException

El parámetro stream es nullreferencia null (Nothing en Visual Basic) o está vacío.

O bien

El parámetro fileType es nullreferencia null (Nothing en Visual Basic) o está vacío, o se compone únicamente 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 parámetro fileType especifica una extensión de nombre de archivo que no se admite en Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

DocumentCustomizedWithPreviousRuntimeException

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

Comentarios

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

El parámetro fileType sólo se utiliza para determinar el tipo de documento que está almacenado en una matriz de bytes. El valor de fileType se asigna a uno de los tipos de archivo que se admiten en las personalizaciones de nivel de documento. No se ha intentado abrir el archivo. Si lo desea, también puede pasar un nombre de archivo completo (por ejemplo, "Libro1.xlsx"), pero si hace esto, sólo se utilizará la extensión de nombre de archivo. Para obtener más información sobre los tipos de archivos compatibles, vea Arquitectura de las personalizaciones de nivel de documento.

Para tener acceso a la matriz de bytes del documento después de llamar a este constructor, utilice la propiedad Document.

Ejemplos

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

Este ejemplo necesita:

  • Un proyecto de aplicación de consola o algún otro proyecto que no es de Office.

  • Referencias a los siguientes ensamblados:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si el destino del proyecto es .NET Framework 4).

      O bien

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll and Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si el proyecto está dirigido a .NET Framework 3.5).

  • Instrucciones Imports (para Visual Basic) o using (para C#) para los espacios de nombres Microsoft.VisualStudio.Tools.Applications y Microsoft.VisualStudio.Tools.Applications.Runtime en la parte superior de su archivo de código.

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

Seguridad de .NET Framework

Vea también

Referencia

ServerDocument Clase

ServerDocument (Sobrecarga)

Microsoft.VisualStudio.Tools.Applications (Espacio de nombres)