RichEditControl.IsSelectionInTable() Method

Gets whether the entire selection is contained in one table.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v19.1.dll

Declaration

C#

public bool IsSelectionInTable()

VB.NET

Public Function IsSelectionInTable As Boolean

Returns

Type	Description
Boolean	true if a selection is within one table; otherwise, false.

Example

The following code activates the Table Tools Ribbon tab if the document selection is located in a document table.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437

RichEditControlActions.cs

static void richEditControl_SelectionChanged(object sender, EventArgs e) {
    RichEditControl richEdit = (sender as RichEditControl);
    BarButtonItem barButton = richEdit.Tag as BarButtonItem;
    barButton.Enabled = !richEdit.IsSelectionInTable();
}

RichEditControlActions.vb

Private Shared Sub richEditControl_SelectionChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim richEdit As RichEditControl = (TryCast(sender, RichEditControl))
    Dim barButton As BarButtonItem = TryCast(richEdit.Tag, BarButtonItem)
    barButton.Enabled = Not richEdit.IsSelectionInTable()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsSelectionInTable() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L310

    BarButtonItem barButton = richEdit.Tag as BarButtonItem;
    barButton.Enabled = !richEdit.IsSelectionInTable();
}

toggle-visibility-of-ribbon-categories-that-correspond-to-the-specific-doc-element-types-e4506/CS/Form1.cs#L22

private void richEditControl1_SelectionChanged(object sender, EventArgs e) {
    tableToolsRibbonPageCategory1.Visible = richEditControl1.IsSelectionInTable();
    floatingPictureToolsRibbonPageCategory1.Visible = richEditControl1.IsFloatingObjectSelected;

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/CS/DXApplication9/Form1.cs#L77

{
    tableToolsRibbonPageCategory1.Visible = richEditControl.IsSelectionInTable();
    floatingPictureToolsRibbonPageCategory1.Visible = richEditControl.IsFloatingObjectSelected;

VB.NET

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L317

    Dim barButton As BarButtonItem = TryCast(richEdit.Tag, BarButtonItem)
    barButton.Enabled = Not richEdit.IsSelectionInTable()
End Sub

toggle-visibility-of-ribbon-categories-that-correspond-to-the-specific-doc-element-types-e4506/VB/Form1.vb#L24

Private Sub richEditControl1_SelectionChanged(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.SelectionChanged
    tableToolsRibbonPageCategory1.Visible = richEditControl1.IsSelectionInTable()
    floatingPictureToolsRibbonPageCategory1.Visible = richEditControl1.IsFloatingObjectSelected

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/VB/DXApplication9/Form1.vb#L70

Private Sub richEditControl_SelectionChanged(ByVal sender As Object, ByVal e As EventArgs)
    tableToolsRibbonPageCategory1.Visible = richEditControl.IsSelectionInTable()
    floatingPictureToolsRibbonPageCategory1.Visible = richEditControl.IsFloatingObjectSelected