RichTextBox.IsDocumentEnabled Property (System.Windows.Controls)

IsDocumentEnabled Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

Microsoft Visual Studio 2010/.NET Framework 4.0

.NET Framework Class Library

RichTextBox..::.IsDocumentEnabled Property

Gets or sets a value that indicates whether the user can interact with UIElement and ContentElement objects within the RichTextBox.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/xaml/presentation

Syntax

Visual Basic (Declaration)

Public Property IsDocumentEnabled As Boolean

Visual Basic (Usage)

Dim instance As RichTextBox
Dim value As Boolean

value = instance.IsDocumentEnabled

instance.IsDocumentEnabled = value

public bool IsDocumentEnabled { get; set; }

Visual C++

public:
property bool IsDocumentEnabled {
    bool get ();
    void set (bool value);
}

JScript

public function get IsDocumentEnabled () : boolean
public function set IsDocumentEnabled (value : boolean)

XAML Attribute Usage

<object IsDocumentEnabled="bool" .../>

Property Value

Type: System..::.Boolean
true if the user can interact with UIElement and ContentElement objects within the RichTextBox; otherwise, false.

Remarks

IsDocumentEnabled is introduced in the .NET Framework version 3.5. For more information, see .NET Framework 3.5 Architecture.

Examples

The following example creates CheckBox and a RichTextBox that contains a Hyperlink and a Button. The IsDocumentEnabled property of the RichTextBox is bound to the IsChecked property of the CheckBox. When the user selects the CheckBox, the user can interact with the Button and Hyperlink. When the user clears the CheckBox, the Button and Hyperlink are disabled.

<StackPanel>
    <CheckBox Name="IsDocumentEnabledChbk" Content="IsDocumentEnabled"/>
    <RichTextBox Name="richTB"
                 IsDocumentEnabled="{Binding ElementName=IsDocumentEnabledChbk,
                                             Path=IsChecked}">
        <FlowDocument>
            <Paragraph>
                Use the Checkbox above to switch between enabling and
                disabling the Button and Hyperlink in the RichTextBox.
                <Hyperlink>Here is a hyperlink</Hyperlink>
            </Paragraph>
            <BlockUIContainer>
                <Button>Click me!</Button>
            </BlockUIContainer>

        </FlowDocument>
    </RichTextBox>
</StackPanel>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1

Reference

RichTextBox Class

RichTextBox Members

System.Windows.Controls Namespace