Class
GridViewColumnGroup

Represents a column group in RadGridView with a ColumnGroupsViewDefinition. Each group can either have subgroups or rows which contain data columns.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridViewColumnGroup : INotifyPropertyChanged

Inheritance: objectGridViewColumnGroup

Implements: INotifyPropertyChanged

Constructors

GridViewColumnGroup()

Initializes a new instance of the GridViewColumnGroup class.

Declaration

cs-api-definition
public GridViewColumnGroup()

GridViewColumnGroup(string)

Initializes a new instance of the GridViewColumnGroup class.

Declaration

cs-api-definition
public GridViewColumnGroup(string text)

Parameters

text

string

The text displayed in the group.

GridViewColumnGroup(string, string)

Initializes a new instance of the GridViewColumnGroup class.

Declaration

cs-api-definition
public GridViewColumnGroup(string text, string name)

Parameters

text

string

The text displayed in the group.

name

string

The name of the group.

Properties

AllowHide

Gets or sets value indicating whether the user can hide the group.

Declaration

cs-api-definition
public virtual bool AllowHide { get; set; }

Property Value

bool

AllowReorder

Gets or sets value indicating whether the user can reorder the group using mouse.

Declaration

cs-api-definition
public virtual bool AllowReorder { get; set; }

Property Value

bool

Groups

Gets a ColumnGroupCollection collection containing the subgroups of the current group.

Declaration

cs-api-definition
public ColumnGroupCollection Groups { get; }

Property Value

ColumnGroupCollection

IsPinned

Gets or sets a value indicating whether the column group is pinned and cannot be moved from its location when a user scrolls horizontally. Only the root column groups can be pinned.

Declaration

cs-api-definition
public bool IsPinned { get; set; }

Property Value

bool

IsSuspended

Gets whether the column group is suspended.

Declaration

cs-api-definition
public bool IsSuspended { get; }

Property Value

bool

The is suspended.

IsVisible

Gets or sets a value indicating whether the group is visible.

Declaration

cs-api-definition
public bool IsVisible { get; set; }

Property Value

bool

Name

Gets or sets the name of the group.

Declaration

cs-api-definition
public string Name { get; set; }

Property Value

string

Parent

Gets the parent column group.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewColumnGroup Parent { get; }

Property Value

GridViewColumnGroup

ParentViewDefinition

Gets the ViewDefinition of the group. Has value only on root groups.

Declaration

cs-api-definition
[Browsable(false)]
public ColumnGroupsViewDefinition ParentViewDefinition { get; }

Property Value

ColumnGroupsViewDefinition

PinPosition

Gets or sets the pin position for the row. When the column is pinned, it cannot be moved from its location when a user scrolls horizontally.

Declaration

cs-api-definition
public PinnedColumnPosition PinPosition { get; set; }

Property Value

PinnedColumnPosition

RootColumnGroup

Gets the root column group.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewColumnGroup RootColumnGroup { get; }

Property Value

GridViewColumnGroup

RowSpan

Gets or set the vertical span of the group (the height) in pixels.

Declaration

cs-api-definition
public int RowSpan { get; set; }

Property Value

int

Rows

Gets a ColumnGroupRowCollection collection containing the rows of the current group.

Declaration

cs-api-definition
public ColumnGroupRowCollection Rows { get; }

Property Value

ColumnGroupRowCollection

ShowHeader

Gets or sets a value indicating whether group header is visible. Works only for top level groups.

Declaration

cs-api-definition
public bool ShowHeader { get; set; }

Property Value

bool

true if the group header is visible; otherwise, false.

Tag

Gets or sets the tag of the group.

Declaration

cs-api-definition
public object Tag { get; set; }

Property Value

object

Text

Gets or sets the column group text.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

VisibleInColumnChooser

Gets or sets a value indicating whether the group will be visible in ColumnChooserElement.

Declaration

cs-api-definition
public virtual bool VisibleInColumnChooser { get; set; }

Property Value

bool

Remarks

Use this property if you want to hide groups from the user.

Methods

FindTemplate()

Finds the GridViewTemplate which owns this group. The method will return non-null value only when the group has been added to a view definition hierarchy and the view definition has been set to a template.

Declaration

cs-api-definition
public GridViewTemplate FindTemplate()

Returns

GridViewTemplate

OnNotifyPropertyChanged(string)

Declaration

cs-api-definition
protected virtual void OnNotifyPropertyChanged(string propertyName)

Parameters

propertyName

string

ResumeNotifications()

Resumes the notifications.

Declaration

cs-api-definition
public void ResumeNotifications()

SuspendNotifications()

Suspends the notifications.

Declaration

cs-api-definition
public void SuspendNotifications()

Events

PropertyChanged

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged