Interface RichTextContentControl

Artigo
08/01/2011

Representa um bloco de texto ou outros tipos de conteúdo em um documento.

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (em Microsoft.Office.Tools.Word.dll)

Sintaxe

'Declaração
<GuidAttribute("fe02ce7e-9ae7-444f-a5f8-af588716d06b")> _
Public Interface RichTextContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("fe02ce7e-9ae7-444f-a5f8-af588716d06b")]
public interface RichTextContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

O tipo RichTextContentControl expõe os membros a seguir.

Propriedades

	Nome	Descrição
	Application	Obtém um Microsoft.Office.Interop.Word.Application que representa a instância atual do Word de Microsoft Office.
	BindingContext	Obtém ou define uma coleção dos gerenciadores de moeda para o IBindableComponent. (Herdado de IBindableComponent.)
	Container	Infraestrutura. (Herdado de ContentControlBase.)
	ContainerComponent	Infraestrutura. (Herdado de ContentControlBase.)
	Creator	Obtém um inteiro de 32 bits que indica o aplicativo no qual o RichTextContentControl foi criado.
	DataBindings	Obtém a coleção de objetos de ligação de dados para este IBindableComponent. (Herdado de IBindableComponent.)
	DefaultDataSourceUpdateMode	Obtém ou define o padrão DataSourceUpdateMode para o ContentControlBase. (Herdado de ContentControlBase.)
	DefaultTextStyle	Obtém o nome do estilo de caractere usado para formatar o texto do RichTextContentControl.
	ID	Obtém um número exclusivo que identifica o controle de conteúdo. (Herdado de ContentControlBase.)
	InnerObject	Obtém a base Microsoft.Office.Interop.Word.ContentControl de objeto para o Microsoft.Office.Tools.Word.ContentControlBase. (Herdado de ContentControlBase.)
	LockContentControl	Obtém ou define um valor que especifica se o RichTextContentControl pode ser excluído do documento.
	LockContents	Obtém ou define um valor que especifica se o conteúdo da RichTextContentControl pode ser editado.
	Parent	Obtém o pai do RichTextContentControl.
	ParentContentControl	Obtém o pai de controle de conteúdo uma RichTextContentControl que está aninhado em outro controle de conteúdo.
	PlaceholderText	Obtém ou define o texto exibido na RichTextContentControl até que o texto é alterado por uma ação do usuário ou alguma outra operação.
	Range	Obtém um Range que representa o conteúdo do RichTextContentControl.
	ShowingPlaceholderText	Obtém um valor que indica se a RichTextContentControl atualmente está exibindo texto de espaço reservado.
	Site	Obtém ou define o ISite associados a IComponent. (Herdado de IComponent.)
	Tag	Obtém ou define uma seqüência de caracteres que você deseja associar a RichTextContentControl.
	Temporary	Obtém ou define um valor que especifica se o RichTextContentControl é excluído automaticamente do documento quando o controle é editado.
	Text	Obtém ou define o texto a RichTextContentControl.
	Title	Obtém ou define o título da RichTextContentControl.

Início

Métodos

	Nome	Descrição
	BeginInit	Sinaliza o objeto que a inicialização está iniciando. (Herdado de ISupportInitialize.)
	Copy	Cópias do RichTextContentControl do documento para a área de transferência.
	Cut	Remove o RichTextContentControl do documento e o adiciona à área de transferência.
	Delete	Exclui um controle criado dinamicamente do conteúdo do documento e remove a partir do ControlCollection do documento. (Herdado de ContentControlBase.)
	Dispose	Executa tarefas de definição de aplicativo associadas liberando, liberando ou redefinindo recursos não gerenciados. (Herdado de IDisposable.)
	EndInit	Sinaliza o objeto que a inicialização for concluída. (Herdado de ISupportInitialize.)
	SetPlaceholderText	Exibe o texto em um BuildingBlock, um Range, ou uma seqüência de texto de espaço reservado a RichTextContentControl.

Início

Eventos

	Nome	Descrição
	Added	Ocorre após o controle de conteúdo é adicionado ao documento. (Herdado de ContentControlBase.)
	BindingContextChanged	Ocorre quando o valor da BindingContext propriedade da ContentControlBase alterações. (Herdado de ContentControlBase.)
	ContentUpdating	Ocorre antes de Microsoft Office o Word atualiza o texto no controle content, se o controle de conteúdo está vinculado a um componente XML personalizado. (Herdado de ContentControlBase.)
	Deleting	Ocorre antes do controle de conteúdo é excluído do documento. (Herdado de ContentControlBase.)
	Disposed	Representa o método que manipula o Disposed o evento de um componente. (Herdado de IComponent.)
	Entering	Ocorre quando o usuário clica no controle content, ou quando o cursor é movido para o controle de conteúdo por meio de programação. (Herdado de ContentControlBase.)
	Exiting	Ocorre quando o usuário clica fora do controle de conteúdo, ou quando o cursor é movido programaticamente fora do controle de conteúdo. (Herdado de ContentControlBase.)
	StoreUpdating	Ocorre antes de Microsoft Office o Word atualiza dados em uma parte XML personalizada vinculada ao conteúdo do controle (ou seja, depois que o texto no conteúdo de controle de alterações). (Herdado de ContentControlBase.)
	Validated	Ocorre quando o controle de conteúdo foi validado com êxito. (Herdado de ContentControlBase.)
	Validating	Ocorre quando o conteúdo do controle de conteúdo está sendo validado. (Herdado de ContentControlBase.)

Início

Comentários

A RichTextContentControl podem conter texto, bem como muitos outros tipos de conteúdo, incluindo tabelas, imagens ou outros controles de conteúdo. Você pode aplicar uma combinação de estilos e formatação ao texto em um RichTextContentControl.

Para criar uma região de documento só pode conter texto, use um PlainTextContentControl.

Observação
Esta interface é implementada pelo Visual Studio Tools for Office runtime. Ela não se destina a ser implementada em seu código. Para obter mais informações, consulte Visual Studio Tools for Office visão geral sobre o tempo de execução.

Controles de conteúdo

O RichTextContentControl é um dos oito tipos de controles de conteúdo que você pode usar para criar documentos e modelos do Word de Microsoft Office. Conteúdo de controles possuem uma interface de usuário (UI) que foi controlada entrada como um formulário. Você pode usar controles de conteúdo para impedir que usuários editem seções protegidas do documento ou modelo, e você também pode vincular controles de conteúdo a uma fonte de dados. For more information, see Controles de conteúdo.

Usage

Esta documentação descreve a versão deste tipo que é usada em projetos do Office destinados ao .NET Framework 4. Em projetos destinados ao .NET Framework 3.5, este tipo poderá ter membros diferentes, e os exemplos de código fornecidos para o tipo talvez não funcionem. Para obter documentação sobre este tipo em projetos destinados ao .NET Framework 3.5, consulte a seguinte seção de referência na documentação do Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Exemplos

O exemplo de código a seguir adiciona um novo RichTextContentControl para o início do documento.

Esta versão é para uma personalização em nível de documento. Para usar esse código, colá-lo na ThisDocument classe em seu projeto e a chamada a AddRichTextControlAtSelection método a partir do ThisDocument_Startup método.

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    richTextControl1 = Me.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

private void AddRichTextControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Esta versão é um suplemento em nível de aplicativo. Para usar esse código, colá-lo na ThisAddIn classe em seu projeto e a chamada a AddRichTextControlAtSelection método a partir do ThisAddIn_Startup método.

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    vstoDoc.Paragraphs(1).Range.Select()
    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

private void AddRichTextControlAtSelection()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}