RichTextBox.IsDocumentEnabled Property

Reference

Definition

Namespace:: System.Windows.Controls

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

public bool IsDocumentEnabled { get; set; }

member this.IsDocumentEnabled : bool with get, set

Public Property IsDocumentEnabled As Boolean

Property Value

Boolean

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

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>

Remarks

IsDocumentEnabled is introduced in the .NET Framework version 3.5. For more information, see Versions and Dependencies.

Applies to

Share via