GridControl.ShowOnlyPredefinedDetails Property

Gets or sets whether the Grid Control displays only the relationships that exist in the GridControl.LevelTree.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

[Browsable(true)]
[DefaultValue(false)]
[DXCategory("Behavior")]
public virtual bool ShowOnlyPredefinedDetails { get; set; }

VB.NET

<Browsable(True)>
<DefaultValue(False)>
<DXCategory("Behavior")>
Public Overridable Property ShowOnlyPredefinedDetails As Boolean

Property Value

Type	Default	Description
Boolean	false	true if only the relationships that exist in the GridControl.LevelTree are displayed by the grid; false if all the relationships in the bound data source are displayed by the grid.

Remarks

The GridControl.LevelTree represents a hierarchical structure of nodes that associates master-detail relationships with pattern Views.

The GridControl.LevelTree does not necessarily contain nodes representing all the relationships in the bound data source. In this case, if the ShowOnlyPredefinedDetails property is set to true only the relationships which are referred to by the GridControl.LevelTree are displayed in the grid. If this property is set to false all the relationships in the bound data source will be displayed in the grid.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowOnlyPredefinedDetails property.

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-grid-disable-detail-tabs/CS/WindowsApplication3/MyGrid.cs#L97

GridLevelNode levelNode = GetLevelNode();
if (GridControl.ShowOnlyPredefinedDetails && (levelNode == null || !levelNode.HasChildren)) return null;
ArrayList details = new ArrayList();

VB.NET

winforms-grid-disable-detail-tabs/VB/WindowsApplication3/MyGrid.vb#L115

Dim levelNode As GridLevelNode = GetLevelNode()
If GridControl.ShowOnlyPredefinedDetails AndAlso (levelNode Is Nothing OrElse Not levelNode.HasChildren) Then
    Return Nothing