RichTextBox.Document Property
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Gets or sets the FlowDocument that represents the contents of the RichTextBox.
Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
<object> <FlowDocument .../> </object>
Property Value
Type: System.Windows.Documents.FlowDocumentA 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;
Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
