New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

The item which splits the groups (when utilizing the grouping feature of RadGrid) and provides expand/collapse functionality for them.

Created and meaningful only with grouping enabled.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
public class GridGroupHeaderItem : GridItem, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, INamingContainer

Inheritance: objectControlWebControlTableRowGridTableRowGridItemGridGroupHeaderItem...

Implements: IAttributeAccessorIComponentIControlBuilderAccessorIControlDesignerAccessorIDataBindingsAccessorIDisposableIExpressionsAccessorINamingContainerIParserAccessorIUrlResolutionService...

Inherited Members GridItem.AddAttributesToRender(HtmlTextWriter)GridItem.FireCommandEvent(string, object)GridItem.OnBubbleEvent(object, EventArgs)GridItem.SetItemType(GridItemType)GridItem.OnCellDataBound(GridColumn, TableCell)GridItem.CellsDataBound(GridColumn[])GridItem.CreateCellObject(GridColumn)GridItem.RemoveSelectedChildren()GridItem.RemoveEditedChildren()GridItem.OnExpand()GridItem.OnCollapse()GridItem.ExpandHierarchyToTop()GridItem.SetEdited(bool)GridItem.CalcColSpan(GridColumn[], int, int)GridItem.LoadViewState(object)GridItem.LeftAlign()GridItem.RightAlign()GridItem.OwnerTableViewGridItem.OwnerIDGridItem.OwnerGridIDGridItem.DataItemGridItem.DataSetIndexGridItem.ItemIndexGridItem.ItemIndexHierarchicalGridItem.ItemTypeGridItem.ExpandedGridItem.DisplayGridItem.SelectedGridItem.SelectableModeGridItem.EditGridItem.GroupIndexGridItem.IsDataBoundGridItem.IsInEditModeGridTableRow.OriginalClientIDGridTableRow.ClientIDTableRow.CreateControlStyle()TableRow.CreateControlCollection()TableRow.CellsTableRow.HorizontalAlignTableRow.SupportsDisabledAttributeTableRow.TableSectionTableRow.VerticalAlignWebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.SaveViewState()WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SkinIDWebControl.TabIndexWebControl.TagKeyWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.OnPreRender(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Example:

Here is how you can get reference to the GridGroupHeaderItem on ItemDataBound:

csharp
Private Sub RadGrid1_ItemDataBound(sender As Object, e As Telerik.Web.UI.GridItemEventArgs)
   If Typeof e.Item Is GridGroupHeaderItem Then
      Dim item As GridGroupHeaderItem = CType(e.Item, GridGroupHeaderItem)
      'do something here
   End If
End Sub 'RadGrid1_ItemDataBound
csharp
private void RadGrid1_ItemDataBound(object sender, Telerik.Web.UI.GridItemEventArgs e)
{
 if ( e.Item is GridGroupHeaderItem )
 {
  GridGroupHeaderItem item = (GridGroupHeaderItem)e.Item;
  //do something here
 }
 }
}

Constructors

Marked for internal usage only

C#
public GridGroupHeaderItem(GridTableView ownerTableView, int itemIndex, int dataSetIndex)
Parameters:ownerTableViewGridTableViewitemIndexintdataSetIndexint

Properties

Gets or sets all aggregate values in the header.

C#
public IDictionary AggregatesValues { get; set; }
Property Value:

All aggregate values in the header.

Marked for internal usage

C#
public override bool CanExpand { get; }

Overrides: GridItem.CanExpand

The cell holding the content of the GridGroupHeaderItem

C#
public TableCell DataCell { get; }
Property Value:

N/A

Created and meaningful only with grouping enabled.

Example:
cs-api-definition
Private Sub RadGrid1_ItemDataBound(sender As Object, e As Telerik.Web.UI.GridItemEventArgs)
If Typeof e.Item Is GridGroupHeaderItem Then
Dim item As GridGroupHeaderItem = CType(e.Item, GridGroupHeaderItem)
Dim groupDataRow As DataRowView = CType(e.Item.DataItem, DataRowView)

'Clear the present text of the cell
item.DataCell.Text = ""
Dim column As DataColumn
For Each column In groupDataRow.DataView.Table.Columns

'Check the condition and add only the field you need
If column.ColumnName = "Country" Then
item.DataCell.Text += "Customized display - Country is " + groupDataRow("Country").ToString()
End If
Next column
End If
End Sub 'RadGrid1_ItemDataBound

Boolean property indicating whether the relevant GridGroupHeaderItem has child items inside the group it forms.

C#
public override bool HasChildItems { get; }
Property Value:

boolean

Overrides: GridItem.HasChildItems

Meaningful only with grouping enabled.

Example:
cs-api-definition
Dim groupHeader As GridGroupHeaderItem = grid.MasterTableView.GetItems(GridItemType.GroupHeader)(0)
If (groupHeader.HasChildItems) Then
'operate with the items
Else
'do something else
End If

Methods

C#
protected override TableCell CreateCellObject()
Returns:

TableCell

Overrides: GridItem.CreateCellObject()

Method which returns the data items under the GridGroupHeaderItem group.

C#
public GridItem[] GetChildItems()
Returns:

GridItem[]

An array of GridItem instances

Meaningful only with grouping enabled.

Example:
cs-api-definition
Dim groupHeader As GridGroupHeaderItem = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)(0)
Dim groupItems As GridItem() = groupHeader.GetChildItems()
'traverse the items and operate with them further
C#
protected override bool GetExpandedDefaultValue()
Returns:

bool

Overrides: GridItem.GetExpandedDefaultValue()

C#
protected GridGroupHeaderItem GetHeaderItemByGroupIndex(string GroupIndex)
Parameters:GroupIndexstringReturns:

GridGroupHeaderItem

Inherited from Control, for internal usage only

C#
public override void Initialize(GridColumn[] columns)
Parameters:columnsGridColumn[]

Overrides: GridItem.Initialize(GridColumn[])

Inherited from Control, for internal usage only

C#
public override void PrepareItemStyle()

Overrides: GridItem.PrepareItemStyle()

C#
protected void SetChildrenVisibility(bool visible)
Parameters:visiblebool

Inherited from Control, for internal usage only

C#
public override void SetupItem(bool dataBind, object dataItem, GridColumn[] columns, ControlCollection rows)
Parameters:dataBindbooldataItemobjectcolumnsGridColumn[]rowsControlCollection

Overrides: GridItem.SetupItem(bool, object, GridColumn[], ControlCollection)

Method which shows/hides the items in the group designated by the GridGroupHeaderItem

C#
[SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")]
public override void SetVisibleChildren(bool value)
Parameters:valuebool

boolean, determines whether the items in the group will be displayed or hidden

Overrides: GridItem.SetVisibleChildren(bool)

Meaningful only with grouping enabled.

Example:
cs-api-definition
Dim groupHeader As GridGroupHeaderItem = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)(0)
groupHeader.SetVisibleChildren(False)