Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

ExcelPivotGroupingInfo

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Describes grouping metadata read from a pivot cache field.

Inheritance

  • Object
  • ExcelPivotGroupingInfo

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 1

Constructors

public ExcelPivotGroupingInfo(String fieldName, ExcelPivotGroupBy? groupBy, DateTime? startDate, DateTime? endDate, Double? startNumber, Double? endNumber, Double? interval, Boolean? autoStart, Boolean? autoEnd, IReadOnlyList<String>? groupItems = null, UInt32? baseFieldIndex = null, UInt32? parentFieldIndex = null) #

Creates pivot grouping readback information.

Parameters

fieldName System.String requiredposition: 0
groupBy OfficeIMO.Excel.ExcelPivotGroupBy? requiredposition: 1
startDate System.DateTime? requiredposition: 2
endDate System.DateTime? requiredposition: 3
startNumber System.Double? requiredposition: 4
endNumber System.Double? requiredposition: 5
interval System.Double? requiredposition: 6
autoStart System.Boolean? requiredposition: 7
autoEnd System.Boolean? requiredposition: 8
groupItems System.Collections.Generic.IReadOnlyList<System.String>? = null optionalposition: 9
baseFieldIndex System.UInt32? = null optionalposition: 10
parentFieldIndex System.UInt32? = null optionalposition: 11

Properties

public String FieldName { get; } #

Gets the source field name.

public ExcelPivotGroupBy? GroupBy { get; } #

Gets the grouping mode.

public DateTime? StartDate { get; } #

Gets the date grouping start, if present.

public DateTime? EndDate { get; } #

Gets the date grouping end, if present.

public Double? StartNumber { get; } #

Gets the numeric grouping start, if present.

public Double? EndNumber { get; } #

Gets the numeric grouping end, if present.

public Double? Interval { get; } #

Gets the grouping interval, if present.

public Boolean? AutoStart { get; } #

Gets whether Excel should infer the grouping start.

public 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 UInt32? BaseFieldIndex { get; } #

Gets the source field index used as the base for this grouping, if present.

public UInt32? ParentFieldIndex { get; } #

Gets the parent grouping field index, if present.