ServerDocument.GetCustomizationVersion – metoda
Vrátí verzi Visual Studio Tools for Office runtime , který byl použit k vytvoření vlastního nastavení, které souvisí s určený dokument.
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 , který byl použit k vytvoření přidruženého přizpůsobení.
Výjimky
Výjimka | Podmínka |
---|---|
ArgumentNullException | documentPath Parametr je nullodkaz null (Nothing v jazyce Visual Basic) prázdný nebo je celá tvořena znaky pro prázdné místo. |
FileNotFoundException | Souboru určeného parametrem documentPath neexistuje. |
UnknownCustomizationFileException | Souboru určeného parametrem documentPath má příponu názvu souboru, který není podporován Visual Studio Tools for Office runtime. |
Poznámky
Řešení systému Office, které jsou vytvořeny v různých verzích aplikace Visual Studio pomocí různých verzí Visual Studio Tools for Office runtime. Každá verze modulu runtime poskytuje jinou verzi ServerDocument třídou, která je určena pro práci s řešeními pro danou verzi modulu runtime. Tato verze ServerDocument třída může být použita s řešeními, které jsou vytvořeny pomocí Visual Studio 2012, Visual Studio 2010 a s 2007 řešení Microsoft Office, které jsou vytvořeny pomocí sady Visual Studio 2008.
Následující tabulka určuje význam vrácené hodnoty pro tuto metodu.
Vrácená hodnota |
Description |
---|---|
0 |
Dokument nemá o přizpůsobení. |
1 |
Dokument obsahuje vlastní nastavení, který byl vytvořen pomocí Visual Studio Tools for Office verze 2003. |
2 |
Dokument obsahuje vlastní nastavení, který byl vytvořen pomocí Visual Studio 2005 Tools for Office Second Edition runtime. Toto je verze modulu runtime, který je používán 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í nástroje sady Visual Studio 2010 for Office Runtime nebo Visual Studio Tools for the Microsoft Office system (verze 3.0 Runtime). Verze 3.0 Runtime modul používá vlastní nastavení 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 pro přehled Runtime sady Office.
Příklady
Následující příklad kódu vytvoří novou ServerDocument , načte zadaný dokument a potom zobrazí adresu URL v manifestu nasazení pro vlastní nastavení, který je připojen k dokumentu. Před vytvořením objektu, kód používá GetCustomizationVersion metodu k ověření, že v souvislosti s úpravou byl vytvořen pomocí Visual Studio 2010 Tools for Office Runtime.
Tento příklad vyžaduje:
Projekt konzolové aplikace nebo jiného projektu mimo sadu Office.
Odkazy na následující sestavení:
Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.dll (Pokud bude projekt cílen .NET Framework 4 nebo .NET Framework 4.5).
nebo
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (Pokud je projekt cílen na rozhraní.NET Framework 3.5).
Imports(pro jazyk Visual Basic) nebo using (pro jazyk C#) příkazy pro Microsoft.VisualStudio.Tools.Applications a Microsoft.VisualStudio.Tools.Applications.Runtime obory názvů na začátku 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
- Plná důvěra přímému volajícímu. Částečně zabezpečený kód nemůže tento člen použít. Další informace naleznete v tématu Používání knihoven z částečně důvěryhodného kódu.
Viz také
Referenční dokumentace
Microsoft.VisualStudio.Tools.Applications – obor názvů