ServerDocument Constructeurs

Référence

Définition

Espace de noms:: Microsoft.VisualStudio.Tools.Applications

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

ServerDocument(String)	Initialise une nouvelle instance de la classe ServerDocument en utilisant le chemin d'accès complet du document à charger.
ServerDocument(Byte[], String)	Initialise une nouvelle instance de la classe ServerDocument en utilisant un tableau d'octets qui représente le document à charger et l'extension de nom de fichier du document.
ServerDocument(Stream, String)	Initialise une nouvelle instance de la classe ServerDocument en utilisant un flux de données qui représente le document à charger et l'extension de nom de fichier du document.
ServerDocument(String, FileAccess)	Initialise une nouvelle instance de la classe ServerDocument en utilisant le chemin d'accès complet du document à charger et une valeur qui indique l'accès au fichier du document.

ServerDocument(String)

Initialise une nouvelle instance de la classe ServerDocument en utilisant le chemin d'accès complet du document à charger.

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)

Paramètres

documentPath: String

Chemin d'accès complet du document à charger.

Exceptions

ArgumentNullException

Le paramètre documentPath est null, est vide ou ne contient que des espaces blancs.

FileNotFoundException

Le fichier spécifié par documentPath n’existe pas.

DocumentCustomizedWithPreviousRuntimeException

Le fichier spécifié par documentPath a une personnalisation qui n'a pas été créée avec Visual Studio 2010 Tools pour Office Runtime ou Visual Studio Tools pour Microsoft Office system (runtime version 3.0).

UnknownCustomizationFileException

Le fichier spécifié par documentPath a une extension de nom de fichier qui n’est pas prise en charge par le runtime Visual Studio Tools pour Office.

Exemples

L’exemple de code suivant utilise le ServerDocument(String) constructeur pour créer un nouveau ServerDocument qui charge un document spécifié. L’exemple affiche ensuite l’URL du manifeste de déploiement pour la personnalisation attachée au document.

Cet exemple nécessite :

Un projet d’application console ou un autre projet non Office.
Références aux assemblys suivants :
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si le projet cible .NET Framework 4 ou .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si le projet cible le .NET Framework 3.5).
Imports (pour Visual Basic) ou using (pour les instructions C#) pour Microsoft.VisualStudio.Tools.Applications et Microsoft.VisualStudio.Tools.Applications.Runtime espaces de noms en haut de votre fichier de code.

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

Remarques

Utilisez ce constructeur pour accéder aux données mises en cache ou aux informations du manifeste de déploiement dans un document qui se trouve sur le disque. Lorsque vous utilisez ce constructeur, le document spécifié est ouvert avec un accès en lecture/écriture.

S’applique à

ServerDocument(Byte[], String)

Initialise une nouvelle instance de la classe ServerDocument en utilisant un tableau d'octets qui représente le document à charger et l'extension de nom de fichier du document.

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)

Paramètres

bytes: Byte[]

Tableau d'octets qui représente le document à charger.

fileType: String

Extension de nom de fichier du document stocké dans le bytes paramètre, précédé d’un point (.) — par exemple, « .xlsx » ou « .docx ».

Exceptions

ArgumentNullException

Le bytes paramètre est null ou vide.-ou-Le fileType paramètre est null ou vide ou se compose entièrement de caractères d’espace blanc.

UnknownCustomizationFileException

Le fileType paramètre spécifie une extension de nom de fichier qui n’est pas prise en charge par le runtime Visual Studio Tools pour Office.

DocumentCustomizedWithPreviousRuntimeException

Exemples

L’exemple de code suivant utilise le constructeur [ServerDocument (Byte<xref :Microsoft.VisualStudio.Tools.Applications.ServerDocument.%23ctor%28System.Byte%5B%5D%2CSystem Constructeur String%29> pour créer un nouveau constructeur [ServerDocument (Byte<xref :Microsoft.VisualStudio.Tools.Applications.ServerDocument à> partir d’un tableau d’octets qui contient un classeur Excel avec l’extension de nom de fichier .xlsx. L’exemple utilise ensuite la propriété [ServerDocument Constructor (Byte<xref :Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> pour afficher le nombre d’octets dans le document.

Cet exemple nécessite :

Un projet d’application console ou un autre projet non Office.
Références aux assemblys suivants :
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si le projet cible .NET Framework 4 ou .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si le projet cible le .NET Framework 3.5).
Imports (pour Visual Basic) ou using (pour C#) instructions pour [ServerDocument Constructor (Byte<xref :Microsoft.VisualStudio.Tools.Applications ?displayProperty=fullName> et [ServerDocument Constructor (Byte<xref :Microsoft.VisualStudio.Tools.Applications.Runtime ?displayProperty=fullName> ) en haut de votre fichier de code.

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

Remarques

Utilisez ce constructeur pour accéder aux données mises en cache ou aux informations du manifeste de déploiement dans un document qui est déjà en mémoire. Lorsque vous utilisez ce constructeur, le document est ouvert avec un accès en lecture/écriture.

Le fileType paramètre est utilisé uniquement pour déterminer le type de document stocké dans le tableau d’octets. La valeur de fileType est mappée à l’un des types de fichiers pris en charge pour les personnalisations au niveau du document. Aucune tentative d’ouverture du fichier n’est effectuée. Vous pouvez éventuellement transmettre un nom de fichier complet (par exemple, « Workbook1.xlsx »), mais dans ce cas, seule l’extension de nom de fichier est utilisée. Pour plus d'informations sur les formats disponibles, consultez Architecture des personnalisations au niveau du document.

Pour accéder au tableau d’octets du document après avoir appelé ce constructeur, utilisez la propriété [ServerDocument Constructor(Byte<xref :Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> .

S’applique à

ServerDocument(Stream, String)

Initialise une nouvelle instance de la classe ServerDocument en utilisant un flux de données qui représente le document à charger et l'extension de nom de fichier du document.

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)

Paramètres

stream: Stream

Flux de données qui représente le document à charger.

fileType: String

Extension de nom de fichier du document stocké dans le bytes paramètre, précédé d’un point (.) — par exemple, « .xlsx » ou « .docx ».

Exceptions

ArgumentNullException

Le stream paramètre est null ou vide.-ou-Le fileType paramètre est null ou vide ou se compose entièrement de caractères d’espace blanc.

ArgumentException

La longueur du paramètre stream est égale à zéro ou la position actuelle du paramètre est à la fin du flux.

UnknownCustomizationFileException

Le fileType paramètre spécifie une extension de nom de fichier qui n’est pas prise en charge par le runtime Visual Studio Tools pour Office.

DocumentCustomizedWithPreviousRuntimeException

Exemples

L’exemple de code suivant utilise le ServerDocument(Stream, String) constructeur pour créer un nouveau ServerDocument à partir d’un FileStream classeur Excel avec l’extension de nom de fichier .xlsx. Le code affiche ensuite l’URL du manifeste de déploiement pour la personnalisation attachée au document.

Cet exemple nécessite :

Un projet d’application console ou un autre projet non Office.
Références aux assemblys suivants :
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si le projet cible .NET Framework 4 ou .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si le projet cible le .NET Framework 3.5).
Imports (pour Visual Basic) ou using (pour les instructions C#) pour Microsoft.VisualStudio.Tools.Applications et Microsoft.VisualStudio.Tools.Applications.Runtime espaces de noms en haut de votre fichier de code.

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

Remarques

Pour accéder au tableau d’octets du document après avoir appelé ce constructeur, utilisez la Document propriété .

S’applique à

ServerDocument(String, FileAccess)

Initialise une nouvelle instance de la classe ServerDocument en utilisant le chemin d'accès complet du document à charger et une valeur qui indique l'accès au fichier du document.

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)

Paramètres

documentPath: String

Chemin d'accès complet du document à charger.

access: FileAccess

Valeur qui indique l'accès au fichier du document.

Exceptions

ArgumentNullException

Le paramètre documentPath est null, est vide ou ne contient que des espaces blancs.

ArgumentException

La valeur de access est System.IO.FileAccess.Write.

FileNotFoundException

Le fichier spécifié par documentPath n’existe pas.

DocumentNotCustomizedException

Le fichier spécifié par le documentPath paramètre n’a pas de personnalisation, et la valeur de access est System.IO.FileAccess.Read.

DocumentCustomizedWithPreviousRuntimeException

UnknownCustomizationFileException

Le fichier spécifié par documentPath a une extension de nom de fichier qui n’est pas prise en charge par le runtime Visual Studio Tools pour Office.

Exemples

L’exemple de code suivant utilise le ServerDocument(String, FileAccess) constructeur pour créer un ServerDocument nouveau qui charge un document spécifié avec un accès en lecture seule. Le code affiche ensuite l’URL du manifeste de déploiement pour la personnalisation attachée au document.

Cet exemple nécessite :

Un projet d’application console ou un autre projet non Office.
Références aux assemblys suivants :
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si le projet cible .NET Framework 4 ou .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si le projet cible le .NET Framework 3.5).
Imports (pour Visual Basic) ou using (pour les instructions C#) pour Microsoft.VisualStudio.Tools.Applications et Microsoft.VisualStudio.Tools.Applications.Runtime espaces de noms en haut de votre fichier de code.

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

Remarques

Utilisez ce constructeur pour accéder aux données mises en cache ou aux informations du manifeste de déploiement dans un document qui se trouve sur le disque si vous souhaitez ouvrir le document avec un accès en lecture seule ou en écriture seule. Par défaut, les autres ServerDocument constructeurs ouvrent le document avec un accès en lecture/écriture.

S’applique à

Share via

ServerDocument Constructeurs

Définition

Surcharges

ServerDocument(String)

Paramètres

Exceptions

Exemples

Remarques

S’applique à

ServerDocument(Byte[], String)

Paramètres

Exceptions

Exemples

Remarques

S’applique à

ServerDocument(Stream, String)

Paramètres

Exceptions

Exemples

Remarques

S’applique à

ServerDocument(String, FileAccess)

Paramètres

Exceptions

Exemples

Remarques

S’applique à

Ressources supplémentaires