Partilhar via

Método ServerDocument.GetCustomizationVersion

  • Artigo

Retorna a versão de Visual Studio Tools for Office Runtime que foi usada para criar a personalização que está associada com o 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 de documento que você deseja verificar.

Valor de retorno

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

Exceções

Exceção Condição
ArgumentNullException

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

O arquivo especificado por documentPath não existe.
UnknownCustomizationFileException

O arquivo especificado por documentPath possui uma extensão de nome de arquivo que não é suportada por Visual Studio Tools for Office Runtime.

Comentários

As soluções do Office criados em versões diferentes do Visual Studio usam versões diferentes de Visual Studio Tools for Office Runtime.Cada versão do runtime fornece uma versão diferente de classe de ServerDocument que é criada para trabalhar com soluções para essa versão do tempo de execução.Esta versão da classe de ServerDocument pode ser usada com soluções criadas usando Visual Studio 2012, Visual Studio 2010 e com as soluções 2007 Microsoft Office que são criados usando Visual Studio 2008.

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

Valor de Retorno

Descrição

0

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

1

O documento tem uma personalização que é criado usando o Visual Studio para Office, versão 2003.

2

O documento tem uma personalização que é criado usando as ferramentas do Visual Studio 2005 para o tempo de execução do Office segundo.Esta é a versão do tempo de execução que é usado por personalizações para o Microsoft Office 2003 em ferramentas do Visual Studio 2005 para o Office e Visual Studio 2008.

3

O documento tem uma personalização que é criado usando o Visual Studio 2010 Tools for Office Runtime ou Visual Studio para o Microsoft Office system (tempo de execução de versão 3,0). A versão 3,0 do runtime é usada por personalizações para 2007 Microsoft Office system no Visual Studio 2008.

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

Exemplos

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

Este exemplo requer:

  • Um projeto de aplicativo do console ou qualquer outro projeto do Office não.

  • Referências para os seguintes conjuntos de módulos (assemblies):

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se o projeto utiliza .NET Framework 4 ou .NET Framework 4.5).

      ou

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se o projeto utiliza o .NET Framework 3.5).

  • Imports (Visual Basic) ou instruções de using (para C#) para Microsoft.VisualStudio.Tools.Applications e namespaces de Microsoft.VisualStudio.Tools.Applications.Runtime na parte superior do 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