ServerDocument.GetCustomizationVersion Метод (2007 System)

Статья
11/16/2008

Обновлен: Ноябрь 2007

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

Пространство имен: Microsoft.VisualStudio.Tools.Applications
Сборка: Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0 (в Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll)

Синтаксис

'Декларация
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer
'Применение
Dim documentPath As String
Dim returnValue As Integer

returnValue = ServerDocument.GetCustomizationVersion(documentPath)

public static int GetCustomizationVersion(
    string documentPath
)

Параметры

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

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

Тип: System.Int32
Число, определяющее версию среды выполнения Visual Studio Tools for Office, которая использовалась для создания связанной настройки.

Исключения

Исключение	Условие
ArgumentNullException	Параметр documentPath равен nullссылка null (Nothing в Visual Basic), пуст или содержит только пробелы.
FileNotFoundException	Файл, заданный в параметре documentPath, не существует.
UnknownCustomizationFileException	Visual Studio Tools for Office не поддерживает расширение имени файла, заданное в параметре documentPath.

Заметки

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

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

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

Дополнительные сведения о различных версиях класса ServerDocument см. в разделе Управление документами на сервере с помощью класса ServerDocument. Пример кода, демонстрирующий использование этого метода для работы с различными версиями класса ServerDocument в одном файле кода, см. в разделе Практическое руководство. Написание кода, в котором используются обе версии класса ServerDocument.

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

Примеры

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

Для этого примера требуются ссылки на сборки Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll, Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll и операторы 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();
    }
}

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.