Compartilhar via

Método ServerDocument.GetCustomizationVersion

  • Artigo

Retorna a versão do Visual Studio Tools for Office runtime que foi usado para criar a personalização está associada ao documento especificado.

Namespace:  Microsoft.VisualStudio.Tools.Applications
Assembly:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (em Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Sintaxe

'Declaração
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer

public static int GetCustomizationVersion(
    string documentPath
)

Parâmetros

  • documentPath
    Tipo: System.String
    O caminho completo do documento que você deseja verificar.

Valor de retorno

Tipo: System.Int32
Um número que especifica a versão do Visual Studio Tools for Office runtime que foi usado para criar a personalização associado.

Exceções

Exceção Condição
ArgumentNullException

O documentPath parâmetro é nulluma referência nula (Nothing no Visual Basic) vazio ou consiste inteiramente de caracteres de espaço em branco.
FileNotFoundException

O arquivo especificado por documentPath não existe.
UnknownCustomizationFileException

O arquivo especificado por documentPath tem uma extensão de nome de arquivo não oferece suporte a Visual Studio Tools for Office runtime.

Comentários

Criada em diferentes versões do Visual Studio de soluções do Office usam versões diferentes da Visual Studio Tools for Office runtime. Cada versão do runtime fornece uma versão diferente da ServerDocument classe que é projetado para trabalhar com soluções para essa versão do runtime. Esta versão do ServerDocument classe pode ser usada com soluções que são criadas usando Visual Studio 2010 e com o 2007 soluções de Microsoft Office que são criadas por meio de 2008 de Visual Studio.

A tabela a seguir especifica o significado dos valores de retorno para este método.

Return value

Description

0

O documento não tem uma personalização.

1

O documento tem uma personalização que foi criada usando Visual Studio Tools for Office, Versão 2003.

2

O documento tem uma personalização que foi criada por meio do Visual Studio do 2005 Tools para Office Second Edition runtime. Esta é a versão do runtime usado pelo personalizações para 2003 de Microsoft Office no Visual Studio 2005 Tools for Office e Visual Studio de 2008.

3

O documento tem uma personalização que foi criada usando o Visual Studio 2010 Tools for Office Runtime ou o Visual Studio Tools para o sistema de Microsoft Office (versão 3.0 Runtime). A versão 3.0 do runtime é usada pelo personalizações para o sistema de Microsoft Office de 2007 em 2008 de Visual Studio.

Para obter mais informações sobre as diferentes versões do Visual Studio Tools for Office runtime, consulte Visual Studio Tools for Office visão geral sobre o tempo de execução.

Exemplos

O exemplo de código a seguir cria um novo ServerDocument que carrega um documento especificado e exibe o URL do manifesto de implantação para a personalização anexado ao documento. Antes de criar o objeto, o código usa a GetCustomizationVersion método para verificar se a personalização foi criada usando o Visual Studio 2010 Tools for Office Runtime.

This example requires:

  • Um projeto de aplicativo de console ou algum outro projeto de não-Office.

  • Referências aos assemblies seguintes:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se os destinos do projeto de .NET Framework 4).

      or

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se os destinos do projeto a.NET Framework 3.5).

  • Imports(para Visual Basic) ou using (para C#) instruções para Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime namespaces no topo do seu arquivo de código.

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

Segurança do .NET Framework

Consulte também

Referência

ServerDocument Classe

Namespace Microsoft.VisualStudio.Tools.Applications

Outros recursos

Gerenciamento de documentos em um servidor usando a classe ServerDocument