ServerDocument.GetCustomizationVersion(String) Метод

Определение

Возвращает версию Набор средств Visual Studio для Office (cреда выполнения), которая использовалась для создания настройки, связанной с указанным документом.

public static int GetCustomizationVersion (string documentPath);

Параметры

documentPath
String

Полный путь к документу, который необходимо проверить.

Возвращаемое значение

Int32

Число, определяющее версию Набор средств Visual Studio для Office (cреда выполнения), которая использовалась для создания связанной настройки.

Исключения

Параметр documentPath равен null, пуст или содержит только пробелы.

Файл, указанный параметром documentPath, не существует.

Файл, заданный параметром documentPath, имеет расширение, не поддерживаемое средой Набор средств Visual Studio для Office (cреда выполнения).

Примеры

В следующем примере кода создается новый объект ServerDocument , который загружает указанный документ, а затем отображает URL-адрес манифеста развертывания для настройки, прикрепленной к документу. Перед созданием объекта код использует GetCustomizationVersion метод для проверки того, что настройка была создана с помощью среды выполнения средств Visual Studio 2010 для Office.

Для этого примера требуются:

  • Проект консольного приложения или другой проект, не относящийся к Office.

  • Ссылки на следующие сборки:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll и Microsoft.VisualStudio.Tools.Applications.Runtime.dll (если проект предназначен для платформы .NET Framework 4 или .NET Framework 4.5).

      or

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll и Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (если проект предназначен для .NET Framework 3,5).

  • Imports(для Visual Basic) или using (для C#) для Microsoft.VisualStudio.Tools.Applications Microsoft.VisualStudio.Tools.Applications.Runtime пространств имен и в верхней части файла кода.

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

Комментарии

Решения Office, созданные в разных версиях Visual Studio, используют разные версии Набор средств Visual Studio для Office (cреда выполнения) . Каждая версия среды выполнения предоставляет отдельную версию ServerDocument класса, предназначенную для работы с решениями для этой версии среды выполнения. Эту версию ServerDocument класса можно использовать с решениями, созданными с помощью Visual Studio 2013 , а также Visual Studio 2010 с 2007 Microsoft Office решениями, созданными с помощью Visual Studio 2008.

В следующей таблице указано значение возвращаемых значений для этого метода.

Возвращаемое значение Описание
0 Документ не имеет настройки.
1 Документ содержит настройки, созданные с помощью Инструменты Visual Studio для Office, версия 2003.
2 В документе есть настройка, созданная с помощью среды выполнения Visual Studio 2005 Tools для Office Second Edition. Это версия среды выполнения, используемая настройками для Microsoft Office 2003 в средствах Visual Studio 2005 для Office и Visual Studio 2008.
3 Документ содержит настройки, созданные с помощью среды выполнения Visual Studio 2010 Tools for Office или Инструменты Visual Studio для системы Microsoft Office (версия 3,0 runtime). Версия 3,0 среды выполнения используется настройками для системы Microsoft Office 2007 в Visual Studio 2008.

Дополнительные сведения о различных версиях Набор средств Visual Studio для Office (cреда выполнения) см. в разделе инструменты Visual Studio для среды выполнения Office.

Применяется к