GroupControl Class

The panel with a title which can be aligned along the top, bottom, left or right edge.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v18.1.dll

Declaration

C#

[SmartTagAction(typeof(GroupControlActions), "AddCustomHeaderButtons", "Add Custom Header Buttons", SmartTagActionType.CloseAfterExecute)]
[ToolboxBitmap(typeof(ToolboxIconsRootNS), "GroupControl")]
[SmartTagAction(typeof(GroupControlActions), "CaptionImage", "Edit Caption Image", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(GroupControlActions), "CaptionImageUri", "Edit Caption ImageUri", SmartTagActionType.CloseAfterExecute)]
[ToolboxTabName("DX.18.1: Navigation & Layout")]
public class GroupControl :
    PanelControl,
    IGroupBoxButtonsPanelOwner,
    IButtonsPanelOwner,
    IButtonPanelControlAppearanceOwner,
    IAppearanceOwner,
    IToolTipControlClient,
    IGroupStyleProvider

VB.NET

<SmartTagAction(GetType(GroupControlActions), "AddCustomHeaderButtons", "Add Custom Header Buttons", SmartTagActionType.CloseAfterExecute)>
<ToolboxBitmap(GetType(ToolboxIconsRootNS), "GroupControl")>
<SmartTagAction(GetType(GroupControlActions), "CaptionImage", "Edit Caption Image", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(GroupControlActions), "CaptionImageUri", "Edit Caption ImageUri", SmartTagActionType.CloseAfterExecute)>
<ToolboxTabName("DX.18.1: Navigation & Layout")>
Public Class GroupControl
    Inherits PanelControl
    Implements IGroupBoxButtonsPanelOwner,
               IButtonsPanelOwner,
               IButtonPanelControlAppearanceOwner,
               IAppearanceOwner,
               IToolTipControlClient,
               IGroupStyleProvider

Remarks

The GroupControl is a container control that can be used to define groups of controls. It displays a frame around controls and allows you to display text and image within the header region.

The control’s main features include:

• The caption can be located along the left, right, top or bottom side of the group control, or hidden (GroupControl.CaptionLocation, GroupControl.ShowCaption).
• Displaying an image in the header (GroupControl.CaptionImage, GroupControl.CaptionImageLocation, GroupControl.CaptionImagePadding, GroupControl.CaptionImageUri, GroupControl.AllowGlyphSkinning).
• Custom buttons in the header (GroupControl.CustomHeaderButtons, GroupControl.CustomHeaderButtonsLocation).
• Colorizing the header region and border in skinning paint schemes (GroupControl.AllowBorderColorBlending).

• The GroupControl.GroupStyle property allows you to select between three unique control styles that specify the appearance of group borders and header.

  

The GroupControl supports both the look and feel and appearances technologies. The XtraScrollableControl.LookAndFeel and PanelControl.Appearance inherited properties allow the control’s look and feel and appearance settings to be accessed, respectively.

The GroupControl.AppearanceCaption property provides the appearance settings used to paint the GroupControl’s caption. The GroupControl also allows its caption to be painted manually. For this purpose, handle the GroupControl.CustomDrawCaption event.

Related GitHub Examples

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

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#

how-to-implement-incremental-search-for-an-edit-form-via-the-lookupedit-e707/CS/Form1.cs#L26

private System.Windows.Forms.Label label4;
private DevExpress.XtraEditors.GroupControl groupControl1;
private DevExpress.XtraEditors.GroupControl groupControl2;

how-to-obtain-the-color-of-a-particular-controls-element-when-skins-are-used-e606/CS/Form1.cs#L17

private System.Windows.Forms.Label label1;
private DevExpress.XtraEditors.GroupControl groupControl1;
private DevExpress.XtraEditors.ComboBoxEdit comboBoxEdit1;

how-to-iterate-through-data-rows-and-apply-styles-to-the-corresponding-grid-cells-e537/CS/Form1.cs#L17

private DevExpress.XtraEditors.RadioGroup radioGroup1;
private DevExpress.XtraEditors.GroupControl groupControl1;
/// <summary>

how-to-create-a-caption-bar-control-e2091/CS/S134179/CaptionBar.cs#L8

namespace S134179 {
    public class CaptionBar:GroupControl {
        public CaptionBar() : base() { }

how-to-increase-the-groupcontrol-captions-height-based-on-the-captions-multiline-text-size-e2179/CS/WindowsApplication3/MyGroupControl.cs#L14

namespace WindowsApplication3 {
    public class MyGroupControl : GroupControl {

VB.NET

how-to-implement-incremental-search-for-an-edit-form-via-the-lookupedit-e707/VB/Form1.vb#L26

Private label4 As System.Windows.Forms.Label
Private groupControl1 As DevExpress.XtraEditors.GroupControl
Private groupControl2 As DevExpress.XtraEditors.GroupControl

how-to-obtain-the-color-of-a-particular-controls-element-when-skins-are-used-e606/VB/Form1.vb#L17

Private label1 As System.Windows.Forms.Label
Private groupControl1 As DevExpress.XtraEditors.GroupControl
Private WithEvents comboBoxEdit1 As DevExpress.XtraEditors.ComboBoxEdit

how-to-set-multi-line-caption-to-radio-buttons-e731/VB/Form1.vb#L34

'Do not modify it using the code editor.
Friend WithEvents GroupControl1 As DevExpress.XtraEditors.GroupControl
Friend WithEvents CheckEdit1 As DevExpress.XtraEditors.CheckEdit

how-to-iterate-through-data-rows-and-apply-styles-to-the-corresponding-grid-cells-e537/VB/Form1.vb#L19

Private WithEvents radioGroup1 As DevExpress.XtraEditors.RadioGroup
Private groupControl1 As DevExpress.XtraEditors.GroupControl
''' <summary>

how-to-create-a-caption-bar-control-e2091/VB/S134179/CaptionBar.vb#L10

Public Class CaptionBar
    Inherits GroupControl
    Public Sub New()

Implements

IXtraResizableControl

Inheritance

Show 12 items

Object

MarshalByRefObject

Component

Control

ScrollableControl

XtraScrollableControl

XtraPanel

DevExpress.Utils.Controls.PanelBase

PanelControl

GroupControl

SplitContainerControl

GridSplitContainer