RichTextContentControl Interface
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.
Representa um bloco de texto ou outros tipos de conteúdo em um documento.
[System.Runtime.InteropServices.Guid("fe02ce7e-9ae7-444f-a5f8-af588716d06b")]
public interface RichTextContentControl : IDisposable, Microsoft.Office.Tools.Word.ContentControlBase, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
- Atributos
- Implementações
Exemplos
O exemplo de código a seguir adiciona um novo RichTextContentControl ao início do documento.
Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument do projeto e chame o método AddRichTextControlAtSelection no método ThisDocument_Startup.
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";
}
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
Esta versão destina-se a um suplemento no nível de aplicativo. Para usar esse código, cole-o na classe ThisAddIn do projeto e chame o método AddRichTextControlAtSelection no método ThisAddIn_Startup.
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";
}
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
Comentários
Um RichTextContentControl pode 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 formatação e estilos a texto em um RichTextContentControl .
Para criar uma região de documento que só pode conter texto, use um PlainTextContentControl .
Observação
Essa interface é implementada pelo Visual Studio Tools para Office Runtime. Ela não se destina a ser implementada em seu código. Para obter mais informações, consulte Visão geral do Visual Studio Tools para Office Runtime.
Controles de conteúdo
O RichTextContentControl é um dos oito tipos de controles de conteúdo que você pode usar para criar documentos e modelos no Microsoft Office Word. Os controles de conteúdo têm uma interface do usuário que tem uma entrada controlada como um formulário. É possível usar controles de conteúdo para impedir que usuários editem seções protegidas do documento ou do modelo, além de também associar controles de conteúdo a uma fonte de dados. Para obter mais informações, consulte controles de conteúdo.
Uso
Essa documentação descreve a versão desse tipo que é usada nos projetos do Office direcionados ao .NET Framework 4 ou posterior. Em projetos direcionados ao .NET Framework 3.5, esse tipo pode ter membros diferentes e os exemplos de código fornecidos para este tipo talvez não funcionem. Conheça a documentação sobre este tipo em projetos direcionados ao .NET Framework 3.5 na seguinte seção de referência na documentação do Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.
Propriedades
| Application |
Obtém um Application que representa a instância atual do Microsoft Office Word. |
| Container | (Herdado de ContentControlBase) |
| ContainerComponent | (Herdado de ContentControlBase) |
| Creator |
Obtém um inteiro de 32 bits que indica o aplicativo no qual o RichTextContentControl foi criado. |
| DefaultDataSourceUpdateMode |
Obtém ou define o padrão DataSourceUpdateMode para o ContentControlBase. (Herdado de ContentControlBase) |
| DefaultTextStyle |
Obtém o nome do estilo de caractere a ser usado para formatar o texto no RichTextContentControl. |
| ID |
Obtém um número exclusivo que identifica o controle do conteúdo. (Herdado de ContentControlBase) |
| InnerObject |
Obtém o objeto ContentControl subjacente para o 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 do RichTextContentControl pode ser editado. |
| Parent |
Obtém o pai do RichTextContentControl. |
| ParentContentControl |
Obtém o controle de conteúdo pai de um RichTextContentControl aninhado em outro controle de conteúdo. |
| PlaceholderText |
Obtém ou define o texto exibido no RichTextContentControl até que ele seja alterado por uma ação do usuário ou por outra operação. |
| Range |
Obtém um Range que representa o conteúdo de RichTextContentControl. |
| ShowingPlaceholderText |
Obtém um valor que indica se o RichTextContentControl está exibindo o texto do espaço reservado no momento. |
| Tag |
Obtém ou define uma cadeia de caracteres que você deseja associar ao RichTextContentControl. |
| Temporary |
Obtém ou define um valor que especifica se o RichTextContentControl será excluído automaticamente do documento quando o controle for editado. |
| Text |
Obtém ou define o texto no RichTextContentControl. |
| Title |
Obtém ou define o título do RichTextContentControl. |
Métodos
| Copy() |
Copia o RichTextContentControl do documento para a Área de Transferência. |
| Cut() |
Remove o RichTextContentControl do documento e o adiciona à Área de Transferência. |
| Delete(Boolean) |
Exclui um controle de conteúdo criado dinamicamente do documento e o remove do ControlCollection no documento. (Herdado de ContentControlBase) |
| SetPlaceholderText(BuildingBlock, Range, String) |
Exibe o texto que está em um BuildingBlock, um Range ou em uma cadeia de caracteres como texto de espaço reservado no RichTextContentControl. |
Eventos
| Added |
Ocorre após a adição do controle de conteúdo ao documento. (Herdado de ContentControlBase) |
| BindingContextChanged |
Ocorre quando o valor da propriedade BindingContext do ContentControlBase é alterado. (Herdado de ContentControlBase) |
| ContentUpdating |
Ocorrerá logo antes de o Microsoft Office Word atualizar o texto em um controle de conteúdo, se o controle de conteúdo estiver associado a uma parte XML personalizada. (Herdado de ContentControlBase) |
| Deleting |
Ocorre imediatamente antes da exclusão do controle de conteúdo do documento. (Herdado de ContentControlBase) |
| Entering |
Ocorre quando o usuário clica no controle de conteúdo ou o cursor é movido programaticamente para o controle de conteúdo. (Herdado de ContentControlBase) |
| Exiting |
Ocorre quando o usuário clica fora do controle de conteúdo ou quando o cursor é movido para fora do controle de conteúdo programaticamente. (Herdado de ContentControlBase) |
| StoreUpdating |
Ocorrerá imediatamente antes de o Microsoft Office Word atualizar os dados em uma parte XML personalizada vinculada ao controle de conteúdo (ou seja, depois que o texto no controle de conteúdo for alterado). (Herdado de ContentControlBase) |
| Validated |
Ocorre quando o controle de conteúdo for validado com êxito. (Herdado de ContentControlBase) |
| Validating |
Ocorre quando os conteúdos do controle de conteúdo estão sendo validados. (Herdado de ContentControlBase) |