GrapeCity.Documents.Excel.PivotFieldCustomGroupOptions

PivotFieldCustomGroupOptions Class

Represents the settings used to create a custom group from PivotItems in a PivotField.

Use this class to configure the item names, optional group name, and whether generated group fields are automatically added to the PivotTable layout by Group(PivotFieldCustomGroupOptions).

Inheritance

object

PivotFieldCustomGroupOptions

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public class PivotFieldCustomGroupOptions

Public Class PivotFieldCustomGroupOptions

Examples

PivotFieldCustomGroupOptions options = new PivotFieldCustomGroupOptions
{
    Name = "Fruit Group",
    Items = new List<string> { "Apple", "Banana" }
};
productField.Group(options);

Constructors

Name	Description
PivotFieldCustomGroupOptions()

Properties

Name	Description
AddGeneratedFieldsToLayout	Gets or sets whether generated group fields are automatically added to the PivotTable layout. The default value is true.
Items	Gets or sets the source PivotItem names to include in the new custom group. The list must contain at least one item name when grouping is applied. Source names, item names, and captions are matched without case sensitivity. Set this property to null to clear the item list.
Name	Gets or sets the display name of the created custom group. If this value is null or empty, a default group name is used when grouping is applied. If the specified name already exists, grouping fails.

Name

Description

AddGeneratedFieldsToLayout

Gets or sets whether generated group fields are automatically added to the PivotTable layout.

The default value is true.

Items

Gets or sets the source PivotItem names to include in the new custom group.

The list must contain at least one item name when grouping is applied. Source names, item names, and captions are matched without case sensitivity. Set this property to null to clear the item list.

Name

Gets or sets the display name of the created custom group.

If this value is null or empty, a default group name is used when grouping is applied. If the specified name already exists, grouping fails.