RichTextBox.SelectionProtected Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

RichTextBox.cs

Gets or sets a value indicating whether the current text selection is protected.

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

[System.ComponentModel.Browsable(false)]
public bool SelectionProtected { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.SelectionProtected : bool with get, set

Public Property SelectionProtected As Boolean

Property Value

Boolean

true if the current selection prevents any changes to its content; otherwise, false. The default is false.

Attributes

BrowsableAttribute

Examples

The following code example demonstrates how to specify protected text within the RichTextBox using the SelectionProtected property. This example requires that a RichTextBox control, named richTextBox1, has been added to the form and that the RichTextBox control has text added to it that contains the word "RichTextBox."

private:
   void ProtectMySelectedText()
   {
      // Determine if the selected text in the control contains the word "RichTextBox".
      if (  !richTextBox1->SelectedText->Equals( "RichTextBox" ) )
      {
         // Search for the word RichTextBox in the control.
         if ( richTextBox1->Find( "RichTextBox", RichTextBoxFinds::WholeWord ) == -1 )
         {
            //Alert the user that the word was not foun and return.
            MessageBox::Show( "The text \"RichTextBox\" was not found!" );
            return;
         }
      }

      // Protect the selected text in the control from being altered.
      richTextBox1->SelectionProtected = true;
   }

private void ProtectMySelectedText()
{
   // Determine if the selected text in the control contains the word "RichTextBox".
   if(richTextBox1.SelectedText != "RichTextBox")
   {
      // Search for the word RichTextBox in the control.
      if(richTextBox1.Find("RichTextBox",RichTextBoxFinds.WholeWord)== -1)
      {
         //Alert the user that the word was not foun and return.
         MessageBox.Show("The text \"RichTextBox\" was not found!");
         return;
      }
   }
   // Protect the selected text in the control from being altered.
   richTextBox1.SelectionProtected = true;
}

Private Sub ProtectMySelectedText()
   ' Determine if the selected text in the control contains the word "RichTextBox".
   If richTextBox1.SelectedText <> "RichTextBox" Then
      ' Search for the word RichTextBox in the control.
      If richTextBox1.Find("RichTextBox", RichTextBoxFinds.WholeWord) = -1 Then
         'Alert the user that the word was not foun and return.
         MessageBox.Show("The text ""RichTextBox"" was not found!")
         Return
      End If
   End If
   ' Protect the selected text in the control from being altered.
   richTextBox1.SelectionProtected = True
End Sub

Remarks

If no text is currently selected, the protection setting is applied to the paragraph in which the insertion point appears and to all text that is typed into the control after the insertion point. The protection setting applies until the property is changed to a different value or until the insertion point is moved to a different paragraph within the control.

If text is selected within the control, the selected text and any text entered after the text selection will have the value of this property applied to it. You can use this property to prevent the user from modifying sections of text within the control.

If this property is set to true, the Protected event is raised when the user attempts to change the current text selection.

Note

This property will return true only if the entire selection within the control contains protected content.

See also

• Protected