ServerDocument.DeploymentManifestUrl, propriété

Article
01/06/2014

Obtient ou définit l'URL du manifeste de déploiement de la personnalisation qui est associée au document.

Espace de noms : Microsoft.VisualStudio.Tools.Applications
Assembly : Microsoft.VisualStudio.Tools.Applications.ServerDocument (dans Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntaxe

'Déclaration
Public Property DeploymentManifestUrl As Uri

public Uri DeploymentManifestUrl { get; set; }

Valeur de propriété

Type : System.Uri
URL qui spécifie le nom et l'emplacement du manifeste de déploiement de la personnalisation associée au document.

Notes

Affectez une nouvelle URL à cette propriété si vous transférez le manifeste de déploiement vers un autre emplacement et que vous voulez que le document recherche les mises à jour de personnalisation depuis le nouvel emplacement. Si vous définissez cette propriété, l'URL doit pointer vers un manifeste de déploiement de la personnalisation qui est déjà associée au document.

Vous ne pouvez pas utiliser cette propriété pour associer une nouvelle personnalisation à un document. Pour ajouter une personnalisation à un document non personnalisé, utilisez la méthode AddCustomization. Pour ajouter une personnalisation différente à un document personnalisé, utilisez la méthode RemoveCustomization pour supprimer la personnalisation actuelle, puis utilisez la méthode AddCustomization.

Obtention de l'URL dans les applications qui ciblent le .NET Framework 3.5

Lorsque vous utilisez la classe ServerDocument dans l'assembly Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll dans une application qui cible le .NET Framework 3.5, la propriété DeploymentManifestUrl retourne l'URL du manifeste de déploiement actuelle uniquement si la personnalisation au niveau de la documentation est installée sur l'ordinateur où vous exécutez l'application. Sinon, cette propriété retourne nullune référence null (Nothing en Visual Basic).

Si vous devez obtenir l'URL du manifeste de déploiement d'une personnalisation au niveau du document qui n'est pas installée sur l'ordinateur où vous exécutez l'application (par exemple, sur un serveur sur lequel une personnalisation au niveau du document est publiée), ciblez .NET Framework 4 dans l'application, référencez l'assembly Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et utilisez la classe ServerDocument dans cet assembly.

Exemples

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

Cet exemple nécessite :

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).
Instructions Imports (pour Visual Basic) ou using pour C#) pour les espaces de noms Microsoft.VisualStudio.Tools.Applications et Microsoft.VisualStudio.Tools.Applications.Runtime au haut de votre fichier de code.

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

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

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

ServerDocument Classe

Microsoft.VisualStudio.Tools.Applications, espace de noms

Partager via