Class Group

Represents a class that defines a report group.

Inheritance
System.Object
GroupBase
Group
Inherited Members
Namespace: Telerik.Reporting
Assembly: Telerik.Reporting.dll

Syntax

public class Group : GroupBase, IGroup, IDataFlow, INamedObject, IToggleVisibilityTarget, IActionTarget
Remarks

The Group class represents a set of grouping criteria. It also acts as a logical holder of the GroupHeaderSection and GroupFooterSection of the group.

The Group objects of a report reside in the component tray.

Constructors

Group()

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

Declaration
public Group()

Group(Boolean)

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

Declaration
public Group(bool createHeaderFooter)
Parameters
System.Boolean createHeaderFooter

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

Properties

BookmarkId

Gets or sets a bookmark id for this group.

Declaration
public string BookmarkId { get; set; }
Property Value
System.String

A System.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

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

Declaration
public string DocumentMapText { get; set; }
Property Value
System.String

A System.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

Gets a GroupFooterSection representing the group's footer section.

Declaration
public GroupFooterSection GroupFooter { get; set; }
Property Value
GroupFooterSection

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

Gets a GroupHeaderSection representing the group's header section.

Declaration
public GroupHeaderSection GroupHeader { get; set; }
Property Value
GroupHeaderSection

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.

Declaration
public GroupKeepTogether GroupKeepTogether { get; set; }
Property Value
GroupKeepTogether

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.

Declaration
public Report Report { get; }
Property Value
Report

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

TocText

Gets or sets a text to be displayed for this group in the table of contents.

Declaration
public string TocText { get; set; }
Property Value
System.String

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

When defined the table of contents displays nodes that navigate to the instances of the group.

Visible

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

Declaration
public bool Visible { get; set; }
Property Value
System.Boolean

true if the group is displayed; otherwise, false. The default is true.

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Overrides

Equals(Group)

Declaration
public bool Equals(Group other)
Parameters
Group other

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides