Método ServerDocument.AddCustomization (String, Uri)

Anexa uma personalização no documento especificado usando o manifesto de implantação e o nome do assembly especificado.

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

Sintaxe

'Declaração
Public Shared Sub AddCustomization ( _
    documentPath As String, _
    deploymentManifestUrl As Uri _
)

public static void AddCustomization(
    string documentPath,
    Uri deploymentManifestUrl
)

Parâmetros

• documentPath
  Tipo: System.String
  O caminho completo do documento ao qual você deseja anexar uma personalização.

• deploymentManifestUrl
  Tipo: System.Uri
  A URL do manifesto da implantação da solução.

Exceções

Comentários

O AddCustomization método associa a personalização especificada do documento, adicionando a _AssemblyName e _AssemblyLocation Propriedades de documento personalizadas para o documento. Essas propriedades identificam o documento tem uma personalização e especifique o local do manifesto de implantação. Depois que esse método com êxito é chamado, na próxima vez que um usuário abre o documento especificado, o runtime tentará instalar a solução do Office. Para obter mais informações sobre as propriedades de documento personalizadas, consulte Visão geral sobre propriedades de documento personalizado.

Se o documento especificado não contém um controle que a personalização espera que o documento para que, a AddCustomization método terá êxito, mas o assembly não será carregado quando o usuário abre o documento.

O fileType parâmetro deve especificar um documento que tem uma extensão de nome de arquivo que é compatível com as personalizações em nível de documento. Não é possível anexar uma personalização em um documento que é salvo no documento XML do Word (* xml) ou o documento XML do Word 2003 (* xml) formatos de arquivo. Para obter mais informações sobre os tipos de arquivo com suporte, consulte Arquitetura de personalizações em nível de documento.

Exemplos

O seguinte exemplo de código usa a AddCustomization método para anexar uma personalização no documento especificado.

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 AddCustomizationUsingDocumentPath(ByVal documentPath As String, _
    ByVal deployManifestPath As String)
    Dim runtimeVersion As Integer = 0

    Try
        ' Make sure that this document does not yet have any Visual Studio Tools 
        ' for Office customizations.
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 0 Then
            Dim deploymentManifestUri As New Uri(deployManifestPath)
            ServerDocument.AddCustomization(documentPath, deploymentManifestUri)
            MessageBox.Show("The document was successfully customized.")
        Else
            System.Windows.Forms.MessageBox.Show("The document is already customized.")
        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.")
    Catch ex As DocumentNotCustomizedException
        System.Windows.Forms.MessageBox.Show("The document could not be customized." & _
        vbLf & ex.Message)
    End Try
End Sub

private void AddCustomizationUsingDocumentPath(string documentPath, string deployManifestPath)
{
    int runtimeVersion = 0;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);

        // Make sure that this document does not yet have any Visual Studio Tools 
        // for Office customizations.
        if (runtimeVersion == 0)
        {
            Uri deploymentManifestUri = new Uri(deployManifestPath);
            ServerDocument.AddCustomization(documentPath, deploymentManifestUri);
            MessageBox.Show("The document was successfully customized.");
        }
        else
        {
            System.Windows.Forms.MessageBox.Show("The document is already customized.");
        }
    }
    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.");
    }
    catch (DocumentNotCustomizedException ex)
    {
        System.Windows.Forms.MessageBox.Show("The document could not be customized.\n" +
            ex.Message);
    }
}

Segurança do .NET Framework

• Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

ServerDocument Classe

Sobrecargas AddCustomization

Namespace Microsoft.VisualStudio.Tools.Applications