API Reference
ExcelPivotGroupingInfo
Describes grouping metadata read from a pivot cache field.
Inheritance
- Object
- ExcelPivotGroupingInfo
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property ExcelPivotTableInfo.Groupings
Accepted by parameters
- Constructor ExcelPivotTableInfo.ExcelPivotTableInfo
Constructors
public ExcelPivotGroupingInfo(String fieldName, Nullable<GroupByValues> groupBy, Nullable<DateTime> startDate, Nullable<DateTime> endDate, Nullable<Double> startNumber, Nullable<Double> endNumber, Nullable<Double> interval, Nullable<Boolean> autoStart, Nullable<Boolean> autoEnd, IReadOnlyList<String> groupItems = null, Nullable<UInt32> baseFieldIndex = null, Nullable<UInt32> parentFieldIndex = null) #Creates pivot grouping readback information.
Parameters
- fieldName System.String
- groupBy System.Nullable{DocumentFormat.OpenXml.Spreadsheet.GroupByValues}
- startDate System.Nullable{System.DateTime}
- endDate System.Nullable{System.DateTime}
- startNumber System.Nullable{System.Double}
- endNumber System.Nullable{System.Double}
- interval System.Nullable{System.Double}
- autoStart System.Nullable{System.Boolean}
- autoEnd System.Nullable{System.Boolean}
- groupItems System.Collections.Generic.IReadOnlyList{System.String} = null
- baseFieldIndex System.Nullable{System.UInt32} = null
- parentFieldIndex System.Nullable{System.UInt32} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String FieldName { get; } #Gets the source field name.
public Nullable<GroupByValues> GroupBy { get; } #Gets the grouping mode.
public Nullable<DateTime> StartDate { get; } #Gets the date grouping start, if present.
public Nullable<DateTime> EndDate { get; } #Gets the date grouping end, if present.
public Nullable<Double> StartNumber { get; } #Gets the numeric grouping start, if present.
public Nullable<Double> EndNumber { get; } #Gets the numeric grouping end, if present.
public Nullable<Double> Interval { get; } #Gets the grouping interval, if present.
public Nullable<Boolean> AutoStart { get; } #Gets whether Excel should infer the grouping start.
public Nullable<Boolean> AutoEnd { get; } #Gets whether Excel should infer the grouping end.
public IReadOnlyList<String> GroupItems { get; } #Gets explicit grouping item labels or values, if present.
public Nullable<UInt32> BaseFieldIndex { get; } #Gets the source field index used as the base for this grouping, if present.
public Nullable<UInt32> ParentFieldIndex { get; } #Gets the parent grouping field index, if present.