ServerDocument.DeploymentManifestUrl-Eigenschaft

Ruft die URL des Bereitstellungsmanifests für die Anpassung, die dem Dokument zugeordnet ist, ab oder legt diese fest.

Namespace:  Microsoft.VisualStudio.Tools.Applications
Assembly:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntax

'Declaration
Public Property DeploymentManifestUrl As Uri
    Get
    Set
public Uri DeploymentManifestUrl { get; set; }

Eigenschaftswert

Typ: System.Uri
Eine URL, die den Namen und den Speicherort des Bereitstellungsmanifests für die Anpassung angibt, die dem Dokument zugeordnet ist.

Hinweise

Legen Sie diese Eigenschaft auf eine neue URL fest, wenn Sie das Bereitstellungsmanifest für eine Anpassung an einen anderen Speicherort verschieben möchten und das Dokument in der Lage sein soll, Anpassungsupdates am neuen Speicherort zu finden. Wenn Sie diese Eigenschaft festlegen, muss die URL auf ein Bereitstellungsmanifest für die Anpassung verweisen, die bereits dem Dokument zugeordnet ist.

Sie können diese Eigenschaft nicht verwenden, um einem Dokument eine neue Anpassung zuzuordnen. Um einem nicht angepassten Dokument eine Anpassung hinzuzufügen, verwenden Sie die AddCustomization-Methode. Um einem angepassten Dokument eine andere Anpassung hinzuzufügen, entfernen Sie zunächst mit der RemoveCustomization-Methode die aktuelle Anpassung. Anschließend verwenden Sie die AddCustomization-Methode.

Abrufen der URL in Anwendungen, deren Ziel .NET Framework 3.5 ist

Wenn Sie die ServerDocument-Klasse in der Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll-Assembly in einer Anwendung verwenden, die auf .NET Framework 3.5 abzielt, gibt die DeploymentManifestUrl-Eigenschaft die aktuelle Bereitstellungsmanifest-URL nur zurück, wenn die Anpassung auf Dokumentationsebene auf dem Computer installiert ist, auf dem Sie die Anwendung ausführen. Andernfalls gibt diese Eigenschaft nullNULL-Verweis (Nothing in Visual Basic) zurück.

Wenn Sie die Bereitstellungsmanifest-URL einer Anpassung auf Dokumentebene abrufen müssen, die nicht auf dem Computer installiert ist, auf dem Sie die Anwendung ausführen (z. B. auf einem Server, auf dem eine Anpassung auf Dokumentebene veröffentlicht wurde), zielen Sie in der Anwendung auf .NET Framework 4 ab, verweisen auf die Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll-Assembly und verwenden die ServerDocument-Klasse in dieser Assembly.

Beispiele

Im folgenden Codebeispiel wird der ServerDocument(String)-Konstruktor zum Erstellen eines neuen ServerDocument-Objekts verwendet, das ein angegebenes Dokument lädt. Im Beispiel wird dann die URL des Bereitstellungsmanifests für die Anpassung angezeigt, die an das Dokument angefügt ist.

Für dieses Beispiel sind erforderlich:

  • Ein Konsolenanwendungsprojekt oder ein anderes Nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt auf .NET Framework 4 abzielt)

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf .NET Framework 3.5 abzielt).

  • Imports-Anweisungen (für Visual Basic) oder using-Anweisungen (für C#) für Microsoft.VisualStudio.Tools.Applications- und Microsoft.VisualStudio.Tools.Applications.Runtime-Namespaces am Anfang der Codedatei.

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

.NET Framework-Sicherheit

Siehe auch

Referenz

ServerDocument Klasse

Microsoft.VisualStudio.Tools.Applications-Namespace