ServerDocument.GetCustomizationVersion(String) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Retorna a versão do Visual Studio Tools para Office Runtime que foi usado para criar a personalização associada ao documento especificado.
public static int GetCustomizationVersion (string documentPath);
Parâmetros
- documentPath
- String
O caminho completo do documento que você deseja verificar.
Retornos
Um número que especifica a versão do Visual Studio Tools para Office Runtime que foi usado para criar a personalização associada.
Exceções
O parâmetro documentPath é null ou vazio ou consiste inteiramente em caracteres de espaço em branco.
O arquivo especificado por documentPath não existe.
O arquivo especificado pelo documentPath tem uma extensão de nome de arquivo à qual o Visual Studio Tools para Office Runtime não dá suporte.
Exemplos
O exemplo de código a seguir cria um novo ServerDocument que carrega um documento especificado e, em seguida, exibe a URL do manifesto de implantação para a personalização que está anexada ao documento. Antes de criar o objeto, o código usa o GetCustomizationVersion método para verificar se a personalização foi criada usando o tempo de execução das ferramentas do Visual Studio 2010 para Office.
Este exemplo requer:
Um projeto de aplicativo do console ou qualquer outro projeto que não seja do Office.
Referências para os seguintes assemblies:
Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (caso o projeto segmente o .NET Framework 4 ou o .NET Framework 4.5).
ou
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (caso o projeto segmente o .NET Framework 3.5).
Instruções
Imports(para Visual Basic) ouusing(para C#) para namespaces Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime na parte superior do arquivo de código.
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
Comentários
As soluções do Office criadas em versões diferentes do Visual Studio usam versões diferentes do Visual Studio Tools para Office Runtime . Cada versão do tempo de execução fornece uma versão diferente da ServerDocument classe que foi projetada para trabalhar com soluções para essa versão do tempo de execução. Esta versão da ServerDocument classe pode ser usada com soluções que são criadas usando o Visual Studio 2013 Visual Studio 2010 e com o 2007 Microsoft Office soluções criadas usando o Visual Studio 2008.
A tabela a seguir especifica o significado dos valores de retorno para esse método.
| Valor retornado | Descrição |
|---|---|
| 0 | O documento não tem uma personalização. |
| 1 | O documento tem uma personalização que foi criada usando o Ferramentas do Visual Studio para Office, versão 2003. |
| 2 | O documento tem uma personalização que foi criada usando o tempo de execução das ferramentas do Visual Studio 2005 para Office Second Edition. Esta é a versão do tempo de execução usada pelas personalizações para Microsoft Office 2003 no Visual Studio 2005 Tools for Office e Visual Studio 2008. |
| 3 | O documento tem uma personalização que foi criada usando o tempo de execução das ferramentas do Visual Studio 2010 para Office ou o Ferramentas do Visual Studio para o sistema de Microsoft Office (tempo de execução da versão 3,0). A versão 3,0 do tempo de execução é usada por personalizações para o sistema de Microsoft Office de 2007 no Visual Studio 2008. |
Para obter mais informações sobre as diferentes versões do Visual Studio Tools para Office Runtime , consulte a visão geral do ferramentas do Visual Studio for Office Runtime.