Sdílet prostřednictvím

ServerDocument.GetCustomizationVersion – metoda

  • Článek

Vrátí verzi Visual Studio Tools for Office runtime , byla použita k vytvoření vlastního nastavení je spojeno s zadaného dokumentu.

Obor názvů:  Microsoft.VisualStudio.Tools.Applications
Sestavení:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (v Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntaxe

'Deklarace
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer

public static int GetCustomizationVersion(
    string documentPath
)

Parametry

  • documentPath
    Typ: System.String
    Úplná cesta dokumentu, který chcete zkontrolovat.

Vrácená hodnota

Typ: System.Int32
Číslo, které určuje verzi Visual Studio Tools for Office runtime , byla použita k vytvoření přidruženého přizpůsobení.

Výjimky

Výjimka Podmínka
ArgumentNullException

documentPath Je parametr nullodkaz Null (Nothing v jazyce Visual Basic) nebo prázdné nebo je celá tvořena bílých znaků.
FileNotFoundException

Určený soubor documentPath neexistuje.
UnknownCustomizationFileException

Určený soubor documentPath má příponu, která není podporována Visual Studio Tools for Office runtime.

Poznámky

Řešení Office vytvořené v různých verzích Visual Studio pomocí různých verzí Visual Studio Tools for Office runtime. Každá verze modulu runtime poskytuje jinou verzi ServerDocument třídy, který je navržen pro práci s řešeními pro danou verzi modulu runtime. Tato verze ServerDocument třídy lze řešení, které jsou vytvořeny pomocí Visual Studio 2010 a s 2007 řešení Microsoft Office, které jsou vytvořeny pomocí Visual Studio 2008.

Následující tabulka určuje význam návratové hodnoty pro tuto metodu.

Vrácená hodnota

Popis

0

Dokument nemá vlastní úpravy.

1

Dokument obsahuje vlastní nastavení, která byla vytvořena pomocí Nástroje Visual Studio Tools pro systém Office, verze 2003.

2

Dokument nemá vlastní vytvořené pomocí Visual Studio 2005 Tools for Office Second Edition runtime. Toto je verze runtime používaný vlastní nastavení sady Microsoft Office 2003 v aplikaci Visual Studio 2005 Tools pro sadu Office a Visual Studio 2008.

3

Dokument obsahuje vlastní nastavení, která byla vytvořena pomocí Visual Studio 2010 Tools for Office Runtime nebo Visual Studio Tools pro systém Microsoft Office (verze 3.0 Runtime). Verze modulu runtime 3.0 používá úprav pro systém Microsoft Office 2007 v aplikaci Visual Studio 2008.

Další informace o různých verzích Visual Studio Tools for Office runtime, viz Visual Studio Tools for Office Runtime Overview.

Příklady

Následující příklad kódu vytvoří nový ServerDocument , načte zadaný dokument a potom zobrazí adresu URL manifestu nasazení vlastního nastavení, která je připojena k dokumentu. Před vytvořením objektu kód používá GetCustomizationVersion ověřit, že byl vytvořen vlastní nastavení pomocí metody Visual Studio 2010 Tools for Office Runtime.

Tento příklad vyžaduje:

  • Projekt aplikace konzoly nebo některé jiné-Office project.

  • Odkazy na následující sestavení:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.dll (pokud cíle projektu .NET Framework 4).

      nebo

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (pokud cíle projektu.NET Framework 3.5).

  • Imports(pro Visual Basic) nebo using (pro C#) pro příkazy Microsoft.VisualStudio.Tools.Applications a Microsoft.VisualStudio.Tools.Applications.Runtime obory názvů v horní části souboru kódu.

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

Zabezpečení rozhraní .NET Framework

Viz také

Odkaz

ServerDocument Třída

Microsoft.VisualStudio.Tools.Applications – obor názvů

Další zdroje

Managing Documents on a Server by Using the ServerDocument Class