ServerDocument.GetCustomizationVersion 方法
傳回 Visual Studio Tools for Office Runtime 的版本,與指定文件關聯的自訂是使用此版本建立的。
命名空間: Microsoft.VisualStudio.Tools.Applications
組件: Microsoft.VisualStudio.Tools.Applications.ServerDocument (在 Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll 中)
語法
'宣告
Public Shared Function GetCustomizationVersion ( _
documentPath As String _
) As Integer
public static int GetCustomizationVersion(
string documentPath
)
參數
- documentPath
型別:System.String
您想要檢查之文件的完整路徑。
傳回值
型別:System.Int32
可指定 Visual Studio Tools for Office Runtime 版本的編號,關聯的自訂是以這個版本建立的。
例外狀況
例外狀況 | 條件 |
---|---|
ArgumentNullException | documentPath 參數為 nullnull 參考 (即 Visual Basic 中的 Nothing),或空字串,或整個都是空白字元。 |
FileNotFoundException | documentPath 所指定的檔案不存在。 |
UnknownCustomizationFileException | documentPath 所指定的檔案有 Visual Studio Tools for Office Runtime 不支援的副檔名。 |
備註
在不同 Visual Studio 版本中建立的辦公室方案會使用不同的 Visual Studio Tools for Office Runtime 版本。每個版本的執行階段會提供不同版本的 ServerDocument 類別,搭配個別版本的執行階段方案使用。ServerDocument 類別的這個版本可搭配使用 Visual Studio 2008 中,是使用 Visual Studio 2012, Visual Studio 2010 和 2007 Microsoft Office 方案中建立的方案。
下表指定這個方法的傳回值意義。
傳回值 |
描述 |
---|---|
0 |
文件沒有自訂。 |
1 |
文件有使用 Visual Studio Tools for Office,建立的自訂。 |
2 |
文件具有自訂,這是藉由使用 Visual Studio 2005 Tools for Office Second Edition 執行階段而建立的。這是 Visual Studio 2005 Tools for Office 與 Visual Studio 2008 中 Microsoft Office 2003 的自訂所使用的執行階段版本。 |
3 |
文件有使用建立的 Visual Studio 2010 Tools for Office Runtime 或 Visual Studio Tools for the Microsoft Office System 的自訂 (3.0 版 Runtime)。自訂會使用執行階段的版本 3.0 為 2007 Microsoft Office system 在 Visual Studio 2008。 |
如需不同版本 Visual Studio Tools for Office Runtime 的詳細資訊,請參閱 Visual Studio Tools for Office Runtime 概觀。
範例
下列程式碼範例會建立新的 ServerDocument,載入指定的文件,然後顯示附加至文件之自訂的部署資訊清單 URL。在建立物件之前,程式碼會使用 GetCustomizationVersion 方法會驗證使用 Visual Studio 2010 Tools for Office Runtime,自訂建立的。
這個範例需要:
主控台應用程式專案或其他非 Office 專案。
下列組件的參考:
Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll 和 Microsoft.VisualStudio.Tools.Applications.Runtime.dll (如果專案以 .NET Framework 4 或 .NET Framework 4.5)。
或
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll 和 Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (如果專案的目標是 .NET Framework 3.5)。
Microsoft.VisualStudio.Tools.Applications 和 Microsoft.VisualStudio.Tools.Applications.Runtime 命名空間 (在程式碼檔最頂端) 的Imports (Visual Basic) 或 using (C#) 陳述式。
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 安全性
- 完全信任立即呼叫者。這個成員無法供部分信任的程式碼使用。如需詳細資訊,請參閱從部分受信任程式碼使用程式庫。
請參閱
參考
Microsoft.VisualStudio.Tools.Applications 命名空間