RichTextContentControl 接口

项目
01/10/2014

表示文档中的文本块或其他类型的内容。

命名空间： Microsoft.Office.Tools.Word
程序集： Microsoft.Office.Tools.Word（在 Microsoft.Office.Tools.Word.dll 中）

语法

声明
<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

RichTextContentControl 类型公开以下成员。

属性

	名称	说明
	Application	获取一个表示 Microsoft Office Word 当前实例的 Microsoft.Office.Interop.Word.Application。
	BindingContext	获取或设置 IBindableComponent 的货币管理器的集合。（继承自 IBindableComponent。）
	Container	基础结构。（继承自 ContentControlBase。）
	ContainerComponent	基础结构。（继承自 ContentControlBase。）
	Creator	获取一个 32 位整数，该整数指示已在其中创建 RichTextContentControl 的应用程序。
	DataBindings	获取此 IBindableComponent 的数据绑定对象的集合。（继承自 IBindableComponent。）
	DefaultDataSourceUpdateMode	获取或设置 ContentControlBase 的默认 DataSourceUpdateMode。（继承自 ContentControlBase。）
	DefaultTextStyle	获取用于设置 RichTextContentControl 中的文本格式的字符样式的名称。
	ID	获取标识内容控件的唯一编号。（继承自 ContentControlBase。）
	InnerObject	获取 Microsoft.Office.Tools.Word.ContentControlBase 的基础 Microsoft.Office.Interop.Word.ContentControl 对象。（继承自 ContentControlBase。）
	LockContentControl	获取或设置一个值，该值指定是否可以从文档中删除 RichTextContentControl。
	LockContents	获取或设置一个值，该值指定 RichTextContentControl 的内容是否可以编辑。
	Parent	获取 RichTextContentControl 的父级。
	ParentContentControl	获取嵌套在另一个内容控件中的 RichTextContentControl 的父内容控件。
	PlaceholderText	获取或设置在用户操作或某个其他操作更改文本之前在 RichTextContentControl 中显示的文本。
	Range	获取一个表示 RichTextContentControl 的内容的 Range。
	ShowingPlaceholderText	获取一个值，该值指示 RichTextContentControl 当前是否显示占位符文本。
	Site	获取或设置与 IComponent 关联的 ISite。（继承自 IComponent。）
	Tag	获取或设置要与 RichTextContentControl 关联的字符串。
	Temporary	获取或设置一个值，该值指定在编辑 RichTextContentControl 时是否自动将该控件从文档中删除。
	Text	获取或设置 RichTextContentControl 中的文本。
	Title	获取或设置 RichTextContentControl 的标题。

页首

方法

	名称	说明
	BeginInit	用信号通知对象初始化即将开始。（继承自 ISupportInitialize。）
	Copy	将 RichTextContentControl 从文档复制到剪贴板。
	Cut	从文档中移除 RichTextContentControl，然后将其添加到剪贴板中。
	Delete	从文档中删除动态创建的内容控件，并将其从文档中的 ControlCollection 中移除。（继承自 ContentControlBase。）
	Dispose	执行与释放或重置非托管资源相关的应用程序定义的任务。（继承自 IDisposable。）
	EndInit	用信号通知对象初始化已完成。（继承自 ISupportInitialize。）
	SetPlaceholderText	将 BuildingBlock、Range 或字符串中的文本显示为 RichTextContentControl 中的占位符文本。

页首

事件

	名称	说明
	Added	在内容控件添加到文档后发生。（继承自 ContentControlBase。）
	BindingContextChanged	当 ContentControlBase 的 BindingContext 属性的值更改时发生。（继承自 ContentControlBase。）
	ContentUpdating	如果内容控件绑定到自定义 XML 部件，则此事件在 Microsoft Office Word 更新内容控件中的文本之前发生。（继承自 ContentControlBase。）
	Deleting	在内容控件从文档中删除之前发生。（继承自 ContentControlBase。）
	Disposed	表示处理组件的 Disposed 事件的方法。（继承自 IComponent。）
	Entering	当用户在内容控件中单击，或者以编程方式将光标移到内容控件中时发生。（继承自 ContentControlBase。）
	Exiting	当用户在内容控件外单击，或者以编程方式将光标移出内容控件时发生。（继承自 ContentControlBase。）
	StoreUpdating	就在 Microsoft Office Word 更新绑定到内容控件的自定义 XML 部件中的数据之前（即在内容控件中的文本更改之后）发生。（继承自 ContentControlBase。）
	Validated	在成功验证内容控件时发生。（继承自 ContentControlBase。）
	Validating	在验证内容控件的内容时发生。（继承自 ContentControlBase。）

页首

备注

RichTextContentControl 可以包含文本以及很多其他类型的内容，包括表、图片和其他内容控件。可以将格式设置和样式的组合应用于 RichTextContentControl 中的文本。

若要创建只能包含文本的文档区域，请使用 PlainTextContentControl。

备注

此接口由 Visual Studio Tools for Office Runtime 实现。不应在代码中实现此接口。有关详细信息，请参阅 Visual Studio Tools for Office Runtime 概述。

内容控件

可用在 Microsoft Office Word 中设计文档和模板的内容控件有八种，RichTextContentControl 是其中之一。内容控件具有一个用户界面 (UI)，其中包含类似于窗体的受控输入。使用内容控件可以防止用户编辑文档或模板的受保护部分，还可以将内容控件绑定到数据源。有关详细信息，请参阅内容控件。

用法

本文档介绍面向 .NET Framework 4 和 .NET Framework 4.5 的 Office 项目中所用此类型的版本。在面向 .NET Framework 3.5 的项目中，此类型可能具有不同的成员，因此本文档为此类型提供的代码示例可能并不适用。有关在面向 .NET Framework 3.5 的项目中使用此类型的文档，请参阅 Visual Studio 2008 文档中的以下参考部分：https://go.microsoft.com/fwlink/?LinkId=160658。

示例

下面的代码示例会在文档开头添加一个新的 RichTextContentControl。

此版本针对的是文档级自定义项。若要使用此代码，请将其粘贴到项目内的 ThisDocument 类中，然后从 ThisDocument_Startup 方法中调用 AddRichTextControlAtSelection 方法。

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";
}

此版本针对的是应用程序级外接程序。若要使用此代码，请将其粘贴到项目内的 ThisAddIn 类中，然后从 ThisAddIn_Startup 方法中调用 AddRichTextControlAtSelection 方法。

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";
}