Class
TableGroup

TODO: Add documentation.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
public class TableGroup : GroupBase, IToggleVisibilityTarget, IActionTarget, IDataFlow

Inheritance: objectGroupBaseTableGroup

Implements: IActionTargetIDataFlowIToggleVisibilityTarget

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

Constructors

TableGroup()

TODO: Add documentation.

Declaration

cs-api-definition
public TableGroup()

Properties

BookmarkId

Gets or sets a bookmark id for this group.

Declaration

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

Property Value

string

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.

ChildGroups

TODO: Add documentation.

Declaration

cs-api-definition
[Browsable(false)]
public IList<TableGroup> ChildGroups { get; }

Property Value

IList<TableGroup>

DocumentMapText

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

Declaration

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

Property Value

string

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.

GroupKeepTogether

Indicates whether to keep all rows or columns that belong to the current group on one page.

Declaration

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

Property Value

bool

True to keep all rows or columns that belong to the current group on one page; otherwise False.

Remarks

When the GroupKeepTogether is set to True and there is not enough space on the current page, the entire group is moved the the top/left of the next page.

PageBreak

Gets or sets the page breaking rule for this TableGroup's representation, either rows or columns.

Declaration

cs-api-definition
public PageBreak PageBreak { get; set; }

Property Value

PageBreak

A PageBreak object specifying the page breaking rule for this TableGroup.

ReportItem

TODO: Add documentation.

Declaration

cs-api-definition
[Browsable(false)]
public ReportItem ReportItem { get; set; }

Property Value

ReportItem

TocText

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

Declaration

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

Property Value

string

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 table of contents displays nodes that navigate to the instances of the group.

Visible

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

Declaration

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

Property Value

bool

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

Methods

Equals(TableGroup)

TODO: Add documentation.

Declaration

cs-api-definition
public bool Equals(TableGroup other)

Parameters

other

TableGroup

Returns

bool

Equals(object)

TODO: Add documentation.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

Returns

bool

Overrides GroupBase.Equals(object)

GetHashCode()

TODO: Add documentation.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

Overrides GroupBase.GetHashCode()