Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
RichTextBox Class
 IsDocumentEnabled Property
.NET Framework Class Library
RichTextBox..::.IsDocumentEnabled Property

Updated: November 2007

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

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
C#
public bool IsDocumentEnabled { get; set; }
Visual C++
public:
property bool IsDocumentEnabled {
    bool get ();
    void set (bool value);
}
J#
/** @property */
public boolean get_IsDocumentEnabled()
/** @property */
public  void set_IsDocumentEnabled(boolean 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.

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

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.

XAML
<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>

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.

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker