New to Telerik Reporting? Start a free 30-day trial

Group

Class

Represents a class that defines a report group.

Definition

Assembly:Telerik.Reporting.dll

Syntax:

[ToolboxBitmap(typeof(Group), "Resources.Group.bmp")]
[TypeConverter(typeof(ExpandableObjectConverter))]
public class Group : GroupBase, IDataFlow, IToggleVisibilityTarget, IActionTarget

Inheritance: objectGroupBaseGroup

Implements: IActionTargetIDataFlowIToggleVisibilityTarget

Inherited Members GroupBase.ToString()GroupBase.NameGroupBase.GroupingsGroupBase.GroupingGroupBase.SortingsGroupBase.SortingGroupBase.Filters...

Constructors

Group()

Initializes a new instance of the Group class with default settings.

public Group()

Group(bool)

Initializes a new instance of the Group class with the specified group header/footer creation option.

public Group(bool createHeaderFooter)

Parameters:createHeaderFooterbool

true to create a GroupHeaderSection and a GroupFooterSection; otherwise, false.

A string started with "=" is interpreted as an expression to calculate the resulting id, otherwise - literal string. Supports embedded expressions also. When processed should evaluate to an unique value for each processing instance of the group. Any duplicated occurrences at runtime get modified in order to avoid duplication in the resulting report.

Remarks:

BookmarkId must be used along with NavigateToBookmarkAction interactive action in order to specify the target of the action.

DocumentMapText

string

Gets or sets a text to be displayed for this group in the document map.

public string DocumentMapText { get; set; }

Property Value:

A string started with "=" is interpreted as an expression to calculate the real data, otherwise - literal string. Supports embedded expressions also.

Remarks:

When defined the document map displays nodes that navigate to the instances of the group.

GroupFooter

GroupFooterSection

Gets a GroupFooterSection representing the group's footer section.

[Browsable(false)]
public GroupFooterSection GroupFooter { get; set; }

Property Value:

A GroupFooterSection value that represents the group footer section of the Group.

Remarks:

The Group footer section is rendered after the detail sections of the Group.

GroupHeader

GroupHeaderSection

Gets a GroupHeaderSection representing the group's header section.

[Browsable(false)]
public GroupHeaderSection GroupHeader { get; set; }

Property Value:

A GroupHeaderSection value that represents the group header section of the Group.

Remarks:

The Group header section is rendered before the detail sections of the Group. Typically, this section will contain report items that are bound to the data fields of the Group's grouping expressions.

GroupKeepTogether

Set to FirstDetail to ensure that the group header and the first detail record are printed on the same page of output, or All to ensure that the entire group is printed on the same page of output. If there is not enough space on the current page, then rendering will skip to the top of the next page.

public GroupKeepTogether GroupKeepTogether { get; set; }

Remarks:

When set to All, the PageBreak settings of the internal report sections get neglected and no soft page breaks get produced.

Report

Gets a Report representing the group's owner report.

[Browsable(false)]
public Report Report { get; }

Property Value:

A Report value that represents the owner report of the Group.

TocLevel

string

Gets or sets the level for this group in the table of contents.

public string TocLevel { get; set; }

Property Value:

A string started with "=" is interpreted as an expression to calculate the actual level, otherwise - literal integer. Supports embedded expressions also.

Remarks:

Takes effect when the current group has TocText defined and sets its level to an explicit value. If omitted, the level is calculated automatically based on the report's group hierarchy.