Поделиться через

ServerDocument.GetCustomizationVersion - метод

  • Статья

Возвращает версию Среда выполнения Visual Studio Tools for Office, которая использовалась для создания настройки, связанной с указанным документом.

Пространство имен:  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, которая использовалась для создания связанной настройки.

Исключения

Исключение Условие
ArgumentNullException

Параметр documentPath равен nullпустая ссылка (Nothing в Visual Basic), пуст или содержит только пробелы.
FileNotFoundException

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

Файл, заданный параметром documentPath, имеет расширение, не поддерживаемое средой Среда выполнения Visual Studio Tools for Office.

Заметки

Решения Office, созданные в разных версиях Visual Studio, используют разные версии Среда выполнения Visual Studio Tools for Office. В каждой версии представлены различные версии класса ServerDocument, предназначенного для работы с решениями для данной версии среды выполнения. Эта версия класса ServerDocument может использоваться с решениями, созданными с помощью Visual Studio 2010 и решений 2007 Microsoft Office, которые создаются с помощью Visual Studio 2008.

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

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

Описание

0

В документе нет настройки.

1

В документе есть настройка, созданная с помощью Visual Studio Tools for Office, версия 2003.

2

Документ содержит настройку, созданную с помощью набора средств Visual Studio 2005 для Office Second Edition Runtime. Это версия среды выполнения, которая используется настройками для Microsoft Office 2003 в Visual Studio 2005 Tools для Office и Visual Studio 2008.

3

В документе есть настройки, который был создан с помощью Visual Studio 2010 Tools для среды выполнения Office или Visual Studio Tools для системы Microsoft Office (версии 3.0 Runtime). Версия 3.0 среды выполнения используется настройками выпуска 2007 системы Microsoft Office в Visual Studio 2008.

Дополнительные сведения о разных версиях Среда выполнения Visual Studio Tools for Office см. в разделе Общие сведения об инструментах Visual Studio для среды выполнения Office.

Примеры

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

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

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

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

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

      или

    • 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 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

См. также

Ссылки

ServerDocument Класс

Microsoft.VisualStudio.Tools.Applications - пространство имен

Другие ресурсы

Управление документами на сервере с помощью класса ServerDocument