RichTextBox 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
表示 Windows 多格式文本框控件。
public ref class RichTextBox : System::Windows::Forms::TextBoxBasepublic class RichTextBox : System.Windows.Forms.TextBoxBase[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Windows.Forms.Docking(System.Windows.Forms.DockingBehavior.Ask)]
public class RichTextBox : System.Windows.Forms.TextBoxBase[System.Windows.Forms.Docking(System.Windows.Forms.DockingBehavior.Ask)]
public class RichTextBox : System.Windows.Forms.TextBoxBasetype RichTextBox = class
inherit TextBoxBase[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Windows.Forms.Docking(System.Windows.Forms.DockingBehavior.Ask)>]
type RichTextBox = class
inherit TextBoxBase[<System.Windows.Forms.Docking(System.Windows.Forms.DockingBehavior.Ask)>]
type RichTextBox = class
inherit TextBoxBasePublic Class RichTextBox
Inherits TextBoxBase- 继承
- 属性
示例
下面的代码示例创建一个 RichTextBox 控件，该控件将 RTF 文件加载到控件中，并搜索单词“Text”的第一个实例。然后，代码更改所选文本的字体样式、字号和字体颜色，并将更改保存回原始文件。 示例代码通过将 控件添加到其 Form完成。 此示例要求将示例代码中创建的方法添加到 Form 类并从窗体的构造函数调用。 该示例还要求在 C 驱动器的根目录中创建一个 RTF 文件，其中包含单词“Text”。
public:
void CreateMyRichTextBox()
{
RichTextBox^ richTextBox1 = gcnew RichTextBox;
richTextBox1->Dock = DockStyle::Fill;
richTextBox1->LoadFile( "C:\\MyDocument.rtf" );
richTextBox1->Find( "Text", RichTextBoxFinds::MatchCase );
richTextBox1->SelectionFont = gcnew System::Drawing::Font(
"Verdana", 12, FontStyle::Bold );
richTextBox1->SelectionColor = Color::Red;
richTextBox1->SaveFile( "C:\\MyDocument.rtf",
RichTextBoxStreamType::RichText );
this->Controls->Add( richTextBox1 );
}
public void CreateMyRichTextBox()
{
RichTextBox richTextBox1 = new RichTextBox();
richTextBox1.Dock = DockStyle.Fill;
richTextBox1.LoadFile("C:\\MyDocument.rtf");
richTextBox1.Find("Text", RichTextBoxFinds.MatchCase);
richTextBox1.SelectionFont = new Font("Verdana", 12, FontStyle.Bold);
richTextBox1.SelectionColor = Color.Red;
richTextBox1.SaveFile("C:\\MyDocument.rtf", RichTextBoxStreamType.RichText);
this.Controls.Add(richTextBox1);
}
Public Sub CreateMyRichTextBox()
Dim richTextBox1 As New RichTextBox()
richTextBox1.Dock = DockStyle.Fill
richTextBox1.LoadFile("C:\MyDocument.rtf")
richTextBox1.Find("Text", RichTextBoxFinds.MatchCase)
richTextBox1.SelectionFont = New Font("Verdana", 12, FontStyle.Bold)
richTextBox1.SelectionColor = Color.Red
richTextBox1.SaveFile("C:\MyDocument.rtf", RichTextBoxStreamType.RichText)
Me.Controls.Add(richTextBox1)
End Sub
注解
RichTextBox使用 控件，用户可以输入和编辑文本。 控件还提供比标准 TextBox 控件更高级的格式设置功能。 可以直接将文本分配给控件，也可以从 RTF) 或纯文本文件 (RTF 格式加载文本。 可以为控件中的文本分配字符和段落格式。
控件 RichTextBox 提供了许多可用于将格式应用于控件中文本的任何部分的属性。 若要更改文本的格式，必须先选择它。 只能为所选文本分配字符和段落格式。 对所选文本部分进行设置后，在选定内容后输入的所有文本也将使用相同的设置进行格式设置，直到进行设置更改或选择控件文档的其他部分为止。 属性 SelectionFont 使文本可以加粗或斜体。 还可以使用此属性更改文本的大小和字样。 属性 SelectionColor 可用于更改文本的颜色。 若要创建项目符号列表， SelectionBullet 可以使用 属性。 还可以通过设置 、 SelectionRightIndent和 SelectionHangingIndent 属性来SelectionIndent调整段落格式。
控件 RichTextBox 提供提供用于打开和保存文件的功能的方法。 方法 LoadFile 使你能够将现有的 RTF 或 ASCII 文本文件加载到 控件中。 还可以从已打开的数据流加载数据。 SaveFile使你能够将文件保存到 RTF 或 ASCII 文本。 与 LoadFile 方法类似，还可以使用 SaveFile 方法保存到打开的数据流。 控件 RichTextBox 还提供用于查找文本字符串的功能。 重 Find 载 方法以查找文本字符串以及控件文本中的特定字符。
还可以将 RichTextBox 控件初始化为内存中存储的数据。 例如，可以将 属性初始化 Rtf 为包含要显示的文本的字符串，包括确定文本格式的 RTF 代码。
如果控件中的文本包含链接（例如网站的链接），则可以使用 DetectUrls 属性在控件的文本中适当地显示链接。 然后，可以处理 LinkClicked 事件以执行与链接关联的任务。 属性 SelectionProtected 使你能够保护控件中的文本不受用户操作。 借助控件中的受保护文本，可以处理 Protected 事件以确定用户何时尝试修改受保护的文本，并提醒用户文本受到保护，或者为用户提供操作受保护文本的标准方法。
可以轻松调整已使用 TextBox 控件的应用程序以使用 RichTextBox 控件。 但是，控件 RichTextBox 不具有相同的 64K 字符容量限制 TextBox 。 RichTextBox通常用于提供类似于文字处理应用程序（如 Microsoft Word）的文本操作和显示功能。
注意
方法 TextBoxBase.Undo 不适用于 KeyPress 或 TextChanged 事件。
构造函数
| RichTextBox() |
初始化 RichTextBox 类的新实例。 |
属性
| AcceptsTab |
获取或设置一个值，该值指示在多行文本框控件中按 Tab 键时，是否在控件中键入一个 Tab 字符，而不是按选项卡的顺序将焦点移动到下一个控件。 (继承自 TextBoxBase) |
| AccessibilityObject |
获取分配给该控件的 AccessibleObject。 (继承自 Control) |
| AccessibleDefaultActionDescription |
获取或设置控件的默认操作说明以供具有辅助功能的客户端应用程序使用。 (继承自 Control) |
| AccessibleDescription |
获取或设置辅助功能客户端应用程序使用的控件说明。 (继承自 Control) |
| AccessibleName |
获取或设置辅助功能客户端应用程序所使用的控件名称。 (继承自 Control) |
| AccessibleRole |
获取或设置控件的辅助性角色。 (继承自 Control) |
| AllowDrop |
获取或设置一个值，该值指示控件是否允许拖放操作。 |
| Anchor |
获取或设置控件绑定到的容器的边缘并确定控件如何随其父级一起调整大小。 (继承自 Control) |
| AutoScrollOffset |
获取或设置一个值，该值指示在 ScrollControlIntoView(Control) 中将控件滚动到何处。 (继承自 Control) |
| AutoSize |
此属性与此类无关。 |
| AutoWordSelection |
获取或设置一个值，通过该值指示是否启用自动选择字词。 |
| BackColor |
获取或设置控件的背景色。 (继承自 TextBoxBase) |
| BackgroundImage |
此属性与此类无关。 |
| BackgroundImageLayout |
此属性与此类无关。 |
| BackgroundImageLayout |
此属性与此类无关。 (继承自 TextBoxBase) |
| BindingContext |
获取或设置控件的 BindingContext。 (继承自 Control) |
| BorderStyle |
获取或设置文本框控件的边框类型。 (继承自 TextBoxBase) |
| Bottom |
获取控件下边缘与其容器的工作区上边缘之间的距离（以像素为单位）。 (继承自 Control) |
| Bounds |
获取或设置控件（包括其非工作区元素）相对于其父控件的大小和位置（以像素为单位）。 (继承自 Control) |
| BulletIndent |
获取或设置对文本应用项目符号样式时，RichTextBox 控件中使用的缩进。 |
| CanEnableIme |
获取一个用以指示是否可以将 ImeMode 属性设置为活动值的值，以启用 IME 支持。 (继承自 TextBoxBase) |
| CanFocus |
获取一个值，该值指示控件是否可以接收焦点。 (继承自 Control) |
| CanRaiseEvents |
确定是否可以在控件上引发事件。 (继承自 Control) |
| CanRedo |
获取一个值，通过该值指示在 RichTextBox 内发生的操作中是否有可以重新应用的操作。 |
| CanSelect |
获取一个值，该值指示是否可以选中控件。 (继承自 Control) |
| CanUndo |
获取一个值，该值指示用户在文本框控件中能否撤消前一操作。 (继承自 TextBoxBase) |
| Capture |
获取或设置一个值，该值指示控件是否已捕获鼠标。 (继承自 Control) |
| CausesValidation |
获取或设置一个值，该值指示控件是否会引起在任何需要在接收焦点时执行验证的控件上执行验证。 (继承自 Control) |
| ClientRectangle |
获取表示控件的工作区的矩形。 (继承自 Control) |
| ClientSize |
获取或设置控件的工作区的高度和宽度。 (继承自 Control) |
| CompanyName |
获取包含控件的应用程序的公司名称或创建者。 (继承自 Control) |
| Container |
获取包含 IContainer 的 Component。 (继承自 Component) |
| ContainsFocus |
获取一个值，该值指示控件或它的一个子控件当前是否有输入焦点。 (继承自 Control) |
| ContextMenu |
获取或设置与控件关联的快捷菜单。 (继承自 Control) |
| ContextMenuStrip |
获取或设置与此控件关联的 ContextMenuStrip。 (继承自 Control) |
| Controls |
获取包含在控件内的控件的集合。 (继承自 Control) |
| Created |
获取一个值，该值指示控件是否已经创建。 (继承自 Control) |
| CreateParams |
获取创建控件句柄时所需要的创建参数。 |
| Cursor |
获取或设置当鼠标指针位于控件上时显示的光标。 (继承自 Control) |
| DataBindings |
为该控件获取数据绑定。 (继承自 Control) |
| DataContext |
获取或设置用于数据绑定的数据上下文。 这是一个环境属性。 (继承自 Control) |
| DefaultCursor |
获取或设置控件的默认光标。 (继承自 TextBoxBase) |
| DefaultImeMode |
获取控件支持的默认输入法编辑器 (IME) 模式。 (继承自 Control) |
| DefaultMargin |
获取控件之间默认指定的间距（以像素为单位）。 (继承自 Control) |
| DefaultMaximumSize |
获取以像素为单位的长度和高度，此长度和高度被指定为控件的默认最大大小。 (继承自 Control) |
| DefaultMinimumSize |
获取以像素为单位的长度和高度，此长度和高度被指定为控件的默认最小大小。 (继承自 Control) |
| DefaultPadding |
获取 控件内容的默认内部间距（以像素为单位）。 (继承自 Control) |
| DefaultSize |
获取控件的默认大小。 |
| DesignMode |
获取一个值，用以指示 Component 当前是否处于设计模式。 (继承自 Component) |
| DetectUrls |
获取或设置一个值，通过该值指示当在控件中键入某个统一资源定位器 (URL) 时，RichTextBox 是否自动设置 URL 的格式。 |
| DeviceDpi |
获取显示当前控件的显示设备的 DPI 值。 (继承自 Control) |
| DisplayRectangle |
获取表示控件的显示区域的矩形。 (继承自 Control) |
| Disposing |
获取一个值，该值指示 Control 基类是否在释放进程中。 (继承自 Control) |
| Dock |
获取或设置哪些控件边框停靠到其父控件并确定控件如何随其父级一起调整大小。 (继承自 Control) |
| DoubleBuffered |
获取或设置一个值，该值指示是否在显示控件前在缓冲区中完成控件绘制。 此属性与此类无关。 (继承自 TextBoxBase) |
| EnableAutoDragDrop |
获取或设置一个值，该值在文本、图片和其他数据上启用拖放操作。 |
| Enabled |
获取或设置一个值，该值指示控件是否可以对用户交互作出响应。 (继承自 Control) |
| Events |
获取附加到此 Component 的事件处理程序的列表。 (继承自 Component) |
| Focused |
获取一个值，该值指示控件是否有输入焦点。 (继承自 Control) |
| Font |
获取或设置控件显示的文字的字体。 |
| FontHeight |
获取或设置控件的字体的高度。 (继承自 Control) |
| ForeColor |
获取或设置控件的前景色。 |
| Handle |
获取控件绑定到的窗口句柄。 (继承自 Control) |
| HasChildren |
获取一个值，该值指示控件是否包含一个或多个子控件。 (继承自 Control) |
| Height |
获取或设置控件的高度。 (继承自 Control) |
| HideSelection |
获取或设置一个值，该值指示当文本框控件没有焦点时，该控件中选定的文本是否保持突出显示。 (继承自 TextBoxBase) |
| ImeMode |
获取或设置控件的输入法编辑器 (IME) 模式。 (继承自 Control) |
| ImeModeBase |
获取或设置控件的输入法编辑器 (IME) 模式。 (继承自 TextBoxBase) |
| InvokeRequired |
获取一个值，该值指示调用方在对控件进行方法调用时是否必须调用 Invoke 方法，因为调用方位于创建控件所在的线程以外的线程中。 (继承自 Control) |
| IsAccessible |
获取或设置一个值，该值指示控件对辅助功能应用程序是否可见。 (继承自 Control) |
| IsAncestorSiteInDesignMode |
指示此控件的上级之一是否位于 DesignMode 中以及该站点。 此属性为只读。 (继承自 Control) |
| IsDisposed |
获取一个值，该值指示控件是否已经被释放。 (继承自 Control) |
| IsHandleCreated |
获取一个值，该值指示控件是否有与它关联的句柄。 (继承自 Control) |
| IsMirrored |
获取一个值，该值指示此控件是否为镜像控件。 (继承自 Control) |
| LanguageOption |
获取或设置一个值，该值指示输入法编辑器 (IME) 和亚洲语言支持的 RichTextBox 设置。 |
| LayoutEngine |
获取控件的布局引擎的缓存实例。 (继承自 Control) |
| Left |
获取或设置控件左边缘与其容器的工作区左边缘之间的距离（以像素为单位）。 (继承自 Control) |
| Lines |
获取或设置文本框控件中的文本行。 (继承自 TextBoxBase) |
| Location |
获取或设置该控件的左上角相对于其容器的左上角的坐标。 (继承自 Control) |
| Margin |
获取或设置控件之间的空间。 (继承自 Control) |
| MaximumSize |
获取或设置大小，该大小是 GetPreferredSize(Size) 可以指定的上限。 (继承自 Control) |
| MaxLength |
获取或设置用户可在多格式文本框控件中键入或粘贴的最大字符数。 |
| MinimumSize |
获取或设置大小，该大小是 GetPreferredSize(Size) 可以指定的下限。 (继承自 Control) |
| Modified |
获取或设置一个值，该值指示自创建文本框控件或上次设置该控件的内容后，用户修改了该控件。 (继承自 TextBoxBase) |
| Multiline |
获取或设置一个值，该值指示这是否为多行 RichTextBox 控件。 |
| Name |
获取或设置控件的名称。 (继承自 Control) |
| Padding |
此属性与此类无关。 (继承自 TextBoxBase) |
| Parent |
获取或设置控件的父容器。 (继承自 Control) |
| PreferredHeight |
获取文本框的首选高度。 (继承自 TextBoxBase) |
| PreferredSize |
获取可以容纳控件的矩形区域的大小。 (继承自 Control) |
| ProductName |
获取包含控件的程序集的产品名称。 (继承自 Control) |
| ProductVersion |
获取包含控件的程序集的版本。 (继承自 Control) |
| ReadOnly |
获取或设置一个值，该值指示文本框中的文本是否为只读。 (继承自 TextBoxBase) |
| RecreatingHandle |
获取一个值，该值指示控件当前是否在重新创建其句柄。 (继承自 Control) |
| RedoActionName |
获取当调用 Redo() 方法后，可以重新应用到控件的操作名称。 |
| Region |
获取或设置与控件关联的窗口区域。 (继承自 Control) |
| RenderRightToLeft |
已过时.
已过时.
此属性现已过时。 (继承自 Control) |
| ResizeRedraw |
获取或设置一个值，该值指示控件在调整大小时是否重绘自己。 (继承自 Control) |
| RichTextShortcutsEnabled |
此属性与此类无关。 |
| Right |
获取控件右边缘与其容器的工作区左边缘之间的距离（以像素为单位）。 (继承自 Control) |
| RightMargin |
获取或设置 RichTextBox 控件内单个文本行的大小。 |
| RightToLeft |
获取或设置一个值，该值指示是否将控件的元素对齐以支持使用从右向左的字体的区域设置。 (继承自 Control) |
| Rtf |
获取或设置 RichTextBox 控件的文本，包括所有 RTF 格式代码。 |
| ScaleChildren |
获取一个值，该值确定子控件的缩放。 (继承自 Control) |
| ScrollBars |
获取或设置 RichTextBox 控件中显示的滚动条类型。 |
| SelectedRtf |
获取或设置控件中当前选择的 RTF 格式的格式化文本。 |
| SelectedText |
获取或设置 RichTextBox 内的选定文本。 |
| SelectionAlignment |
获取或设置应用到当前选定内容或插入点的对齐方式。 |
| SelectionBackColor |
获取或设置在 RichTextBox 控件中选中文本时文本的颜色。 |
| SelectionBullet |
获取或设置一个值，通过该值指示项目符号样式是否应用到当前选定内容或插入点。 |
| SelectionCharOffset |
获取或设置控件中的文本是显示在基线上、作为上标还是作为基线下方的下标。 |
| SelectionColor |
获取或设置当前选定文本或插入点的文本颜色。 |
| SelectionFont |
获取或设置当前选定文本或插入点的字体。 |
| SelectionHangingIndent |
获取或设置选定段落中第一行文本的左边缘和同一段落中后面各行的左边缘之间的距离。 |
| SelectionIndent |
获取或设置所选内容开始行的缩进距离（以像素为单位）。 |
| SelectionLength |
获取或设置控件中选定的字符数。 |
| SelectionProtected |
获取或设置一个值，通过该值指示是否保护当前选定文本。 |
| SelectionRightIndent |
RichTextBox 控件右边缘与选中文本或在当前插入点添加的文本的右边缘之间的距离（以像素为单位）。 |
| SelectionStart |
获取或设置文本框中选定的文本起始点。 (继承自 TextBoxBase) |
| SelectionTabs |
获取或设置 RichTextBox 控件中的绝对制表位位置。 |
| SelectionType |
获取控件内的选定内容类型。 |
| ShortcutsEnabled |
获取或设置一个值，该值指示是否启用已定义的快捷方式。 (继承自 TextBoxBase) |
| ShowFocusCues |
获取一个值，该值指示控件是否应显示聚焦框。 (继承自 Control) |
| ShowKeyboardCues |
获取一个值，该值指示用户界面是否处于适当的状态以显示或隐藏键盘快捷键。 (继承自 Control) |
| ShowSelectionMargin |
获取或设置一个值，通过该值指示 RichTextBox 中是否显示选定内容的边距。 |
| Site |
获取或设置控件的站点。 (继承自 Control) |
| Size |
获取或设置控件的高度和宽度。 (继承自 Control) |
| TabIndex |
获取或设置控件在其容器内的 Tab 键顺序。 (继承自 Control) |
| TabStop |
获取或设置一个值，该值指示用户能否使用 Tab 键将焦点放到该控件上。 (继承自 Control) |
| Tag |
获取或设置包含有关控件的数据的对象。 (继承自 Control) |
| Text |
获取或设置多格式文本框中的当前文本。 |
| TextLength |
获取控件中文本的长度。 |
| Top |
获取或设置控件上边缘与其容器的工作区上边缘之间的距离（以像素为单位）。 (继承自 Control) |
| TopLevelControl |
获取没有另一个 Windows 窗体控件作为其父级的父控件。 通常，这是控件所在的最外面的 Form。 (继承自 Control) |
| UndoActionName |
获取调用 Undo() 方法后在控件中可撤消的操作名称。 |
| UseWaitCursor |
获取或设置一个值，该值指示是否将等待光标用于当前控件以及所有子控件。 (继承自 Control) |
| Visible |
获取或设置一个值，该值指示是否显示该控件及其所有子控件。 (继承自 Control) |
| Width |
获取或设置控件的宽度。 (继承自 Control) |
| WindowTarget |
此属性与此类无关。 (继承自 Control) |
| WordWrap |
指示多行文本框控件在必要时是否自动换行到下一行的开始。 (继承自 TextBoxBase) |
| ZoomFactor |
获取或设置 RichTextBox 的当前缩放级别。 |
方法
事件
显式接口实现
| IDropTarget.OnDragDrop(DragEventArgs) |
引发 DragDrop 事件。 (继承自 Control) |
| IDropTarget.OnDragEnter(DragEventArgs) |
引发 DragEnter 事件。 (继承自 Control) |
| IDropTarget.OnDragLeave(EventArgs) |
引发 DragLeave 事件。 (继承自 Control) |
| IDropTarget.OnDragOver(DragEventArgs) |
引发 DragOver 事件。 (继承自 Control) |
