GrapeCity.Documents.Excel.PivotFieldDateGroupOptions

PivotFieldDateGroupOptions Class

Represents the settings used to group a PivotField by date or time units.

Use this class to configure the date range and the date or time units used by Group(PivotFieldDateGroupOptions). By default, the group range is determined from the PivotCache and the field is grouped by Months.

Inheritance

object

PivotFieldDateGroupOptions

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public class PivotFieldDateGroupOptions

Public Class PivotFieldDateGroupOptions

Examples

PivotFieldDateGroupOptions options = new PivotFieldDateGroupOptions
{
    GroupBy = PivotFieldDateGroupBy.Months | PivotFieldDateGroupBy.Years,
    AutoStart = true,
    AutoEnd = true
};
PivotFieldDateGroupBy groupBy = options.GroupBy;

Constructors

Name	Description
PivotFieldDateGroupOptions()

Properties

Name	Description
AddGeneratedFieldsToLayout	Gets or sets whether generated group fields are automatically added to the PivotTable layout. The default value is true.
AutoEnd	Gets or sets whether the last date is determined from the PivotCache instead of End. When this value is false, End must be set when grouping is applied.
AutoStart	Gets or sets whether the first date is determined from the PivotCache instead of Start. When this value is false, Start must be set when grouping is applied.
Days	Gets or sets the number of days in each generated group when GroupBy includes Days. This value is used when GroupBy includes Days. When grouping is applied, it must be a finite whole number greater than `0`. The effective start date must also be earlier than the effective end date. The default value is `1`.
End	Gets or sets the last date included in the grouped range. When AutoEnd is true, this value is ignored and the last date is determined from the PivotCache.
GroupBy	Gets or sets the date and time units used to create the grouped PivotField. When multiple units are used, grouping is applied in the standard order from seconds through years. At least one unit is required when grouping is applied.
Start	Gets or sets the first date included in the grouped range. When AutoStart is true, this value is ignored and the first date is determined from the PivotCache.