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）或纯文本文件加载。 控件中的文本可以分配字符和段落格式。
该 RichTextBox 控件提供了许多可用于将格式应用于控件中文本的任何部分的属性。 若要更改文本的格式，必须先选择它。 只能为所选文本分配字符和段落格式。 对所选文本部分进行设置后，选择后输入的所有文本也会使用相同的设置进行格式设置，直到设置更改或控件文档的不同部分处于选中状态。 该 SelectionFont 属性使你可以使文本加粗或斜体。 还可以使用此属性更改文本的大小和字样。 使用该 SelectionColor 属性可以更改文本的颜色。 若要创建项目符号列表，可以使用该 SelectionBullet 属性。 还可以通过设置SelectionIndent和SelectionRightIndentSelectionHangingIndent属性来调整段落格式。
该 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 字符，而不是将焦点移动到 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 |
此属性与此类无关。 |
| BindingContext |
获取或设置 BindingContext 控件。 (继承自 Control) |
| BorderStyle |
获取或设置文本框控件的边框类型。 (继承自 TextBoxBase) |
| Bottom |
获取控件的下边缘与其容器工作区的上边缘之间的距离（以像素为单位）。 (继承自 Control) |
| Bounds |
获取或设置控件的大小和位置，包括其相对于父控件的非client 元素（以像素为单位）。 (继承自 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 |
获取或设置一个值，该值指示在键入控件时是否 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 |
获取一个值，该值指示调用方在对控件进行方法调用时是否必须调用调用方法，因为调用方与创建控件的线程不同。 (继承自 Control) |
| IsAccessible |
获取或设置一个值，该值指示控件是否对辅助功能应用程序可见。 (继承自 Control) |
| IsAncestorSiteInDesignMode |
指示此控件的上级位置之一是否位于 DesignMode 中。 此属性为只读。 (继承自 Control) |
| IsDisposed |
获取一个值，该值指示控件是否已释放。 (继承自 Control) |
| IsHandleCreated |
获取一个值，该值指示控件是否具有与之关联的句柄。 (继承自 Control) |
| IsMirrored |
获取一个值，该值指示控件是否镜像。 (继承自 Control) |
| LanguageOption |
获取或设置一个值，该值指示 RichTextBox 输入法编辑器（IME）和亚洲语言支持的设置。 |
| 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) |
