Class RichTextBoxControl
Represents a Windows rich text box control. Wraps the System.Windows.Forms.RichTextBox control.
Inheritance
Inherited Members
Namespace: FastReport.Dialog
Assembly: FastReport.dll
Syntax
public class RichTextBoxControl : DialogControl, IComponent, IDisposable, IFRSerializable, IHasEditorConstructors
RichTextBoxControl()
Initializes a new instance of the RichTextBoxControl class with default settings.
Declaration
public RichTextBoxControl()Properties
RichTextBox
Gets an internal RichTextBox.
Declaration
[Browsable(false)]
public RichTextBox RichTextBox { get; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.RichTextBox |
Rtf
Gets or sets the text of the RichTextBox control, including all rich text format (RTF) codes. Wraps the System.Windows.Forms.RichTextBox.Rtf property.
Declaration
public string Rtf { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ScrollBars
Gets or sets the type of scroll bars to display in the RichTextBox control. Wraps the System.Windows.Forms.RichTextBox.ScrollBars property.
Declaration
public RichTextBoxScrollBars ScrollBars { get; set; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.RichTextBoxScrollBars |
Methods
LoadFile(Stream, RichTextBoxStreamType)
Loads rtf from a stream using specified stream type.
Declaration
public void LoadFile(Stream data, RichTextBoxStreamType fileType)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | data | Stream to load from. |
| System.Windows.Forms.RichTextBoxStreamType | fileType | Type of a stream. |
LoadFile(String)
Loads rtf from a file.
Declaration
public void LoadFile(string path)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | File to load from. |
LoadFile(String, RichTextBoxStreamType)
Loads rtf from a file using specified stream type.
Declaration
public void LoadFile(string path, RichTextBoxStreamType fileType)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | File to load from. |
| System.Windows.Forms.RichTextBoxStreamType | fileType | Type of a stream. |
Serialize(FRWriter)
Serializes the object.
Declaration
public override void Serialize(FRWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| FRWriter | writer | Writer object. |
Overrides
Remarks
Do not call this method directly. You should override it if you are developing a new component for FastReport.
This method is called when the object needs to save the state. It may happen when:
- saving the report to the file or stream;
- saving the report to the designer's undo buffer;
- assigning the object to another object using the Assign(Base) or AssignAll methods;
- saving the object to the designer's clipboard;
- saving the object to the preview (when run a report).