Skip to main content

TdxSpreadSheetTableItemGroups.Delete(Integer,Integer) Method

Excludes the specified range of columns or rows from a table item group.

Declaration

procedure Delete(AStartIndex: Integer; AFinishIndex: Integer);

Parameters

Name Type
AStartIndex Integer
AFinishIndex Integer

Remarks

Use this procedure to exclude the range of columns or rows from the innermost group (i.e., the table item group with the highest nesting level to which it belongs). The excluded range, whose first and last table item indexes are passed as the AStartIndex and AFinishIndex parameters still belongs to all groups with lesser nesting level values. The Delete procedure is particularly useful for shrinking, dividing, and deleting table item groups.

The image below shows how a row group is deleted by calling the Delete procedure with the indexes of the first and last grouped rows as the AStartIndex and AFinishIndex parameters.

If both parameters are set to the same value, the Delete procedure excludes only a single column or row from the innermost group to which it belongs. The image below demonstrates how calling the Delete procedure shrinks a row group by one row.

If either the AStartIndex or AFinishIndex parameter value coincides with an index of a group’s outer table item, invoking the Delete procedure shrinks the group. The following image demonstrates how calling this function ungroups the first half of a row group.

If both the AStartIndex and AFinishIndex parameter values correspond to indexes of the group’s inner columns or rows, the Delete procedure divides the group into two separate groups.

Note

To delete all table item groups from the current root node, call the DeleteAll procedure.

See Also