Document Property
Collapse the table of content
Expand the table of content

RichTextBox.Document Property

 

Gets or sets the FlowDocument that represents the contents of the RichTextBox.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

public FlowDocument Document { get; set; }

Property Value

Type: System.Windows.Documents.FlowDocument

A FlowDocument object that represents the contents of the RichTextBox.

By default, this property is set to an empty FlowDocument. Specifically, the empty FlowDocument contains a single Paragraph, which contains a single Run which contains no text.

Exception Condition
ArgumentNullException

An attempt is made to set this property to null.

ArgumentException

An attempt is made to set this property to a FlowDocument that represents the contents of another RichTextBox.

InvalidOperationException

This property is set while a change block has been activated.

A FlowDocument may only be hosted by a single RichTextBox. Specifying a single FlowDocument as the contents of multiple RichTextBox controls is not supported.

The following example illustrates the use of this property.

// Create a simple FlowDocument to serve as content.
FlowDocument flowDoc = new FlowDocument(new Paragraph(new Run("Simple FlowDocument")));
// Create an empty, default RichTextBox.
RichTextBox rtb = new RichTextBox();
// This call sets the contents of the RichTextBox to the specified FlowDocument.
rtb.Document = flowDoc;
// This call gets a FlowDocument representing the contents of the RichTextBox.
FlowDocument rtbContents = rtb.Document;

.NET Framework
Available since 3.0
Return to top
Show:
© 2016 Microsoft