Class FieldGroupImpl
Describes single pivot field group in the pivot table.
Inheritance
Implements
Namespace: Syncfusion.XlsIO.Implementation.PivotTables
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class FieldGroupImpl : Object, IPivotFieldGroup
Constructors
FieldGroupImpl(PivotCacheFieldImpl)
Initializes new instance of pivot field group.
Declaration
public FieldGroupImpl(PivotCacheFieldImpl baseField)
Parameters
Type | Name | Description |
---|---|---|
PivotCacheFieldImpl | baseField | Base field for the group. |
FieldGroupImpl(PivotCacheFieldImpl, Int32)
Initializes new instance of pivot field group with the specified parent field index.
Declaration
public FieldGroupImpl(PivotCacheFieldImpl baseField, int parentFieldIndex)
Parameters
Type | Name | Description |
---|---|---|
PivotCacheFieldImpl | baseField | Base field for the group. |
System.Int32 | parentFieldIndex | Parent field index of the group. |
Properties
AutoEndRange
Gets or sets a Boolean value that indicates whether we use source data to set the beginning range value.
Declaration
public bool AutoEndRange { get; set; }
Property Value
Type |
---|
System.Boolean |
AutoStartRange
Gets or set a Boolean value that indicates whether the application uses the source data to set the ending range value.
Declaration
public bool AutoStartRange { get; set; }
Property Value
Type |
---|
System.Boolean |
DiscreteGroupIndexes
Gets or sets the collection of items indexes in a field group.
Declaration
public byte[] DiscreteGroupIndexes { get; set; }
Property Value
Type |
---|
System.Byte[] |
EndDate
Gets or sets the end date for pivot field grouping.
Declaration
public DateTime EndDate { get; set; }
Property Value
Type |
---|
System.DateTime |
EndNumber
Gets or sets the order of the last pivot field item in the pivot field group.
Declaration
public double EndNumber { get; set; }
Property Value
Type |
---|
System.Double |
GroupBy
Gets or sets the pivot field group type for the pivot field group.
Declaration
public PivotFieldGroupType GroupBy { get; set; }
Property Value
Type |
---|
PivotFieldGroupType |
GroupInterval
Gets or sets the grouping interval for pivot field group.
Declaration
public double GroupInterval { get; set; }
Property Value
Type |
---|
System.Double |
HasDateTime
Gets or sets a Boolean value indicating wheather the fieldGroup contains the date time.
Declaration
public bool HasDateTime { get; set; }
Property Value
Type |
---|
System.Boolean |
HasNumber
Gets or sets a Boolean value indicating wheather the fieldGroup contains number.
Declaration
public bool HasNumber { get; set; }
Property Value
Type |
---|
System.Boolean |
IsDiscrete
True if the field group is a Dircrete group. False otherwise. Read-only.
Declaration
public bool IsDiscrete { get; }
Property Value
Type |
---|
System.Boolean |
ParentFieldIndex
Gets or sets the index of the parent field.
Declaration
public int ParentFieldIndex { get; }
Property Value
Type |
---|
System.Int32 |
PivotCacheField
Gets or sets the base of this field.
Declaration
public PivotCacheFieldImpl PivotCacheField { get; }
Property Value
Type |
---|
PivotCacheFieldImpl |
PivotCacheFieldIndex
Represents the index of the PivotCacheField. Read-only.
Declaration
public int PivotCacheFieldIndex { get; }
Property Value
Type |
---|
System.Int32 |
PivotDiscreteGroupNames
Gets the collection of pivot discrete group names in the field group. Read-only.
Declaration
public List<string> PivotDiscreteGroupNames { get; }
Property Value
Type |
---|
System.Collections.Generic.List<System.String> |
PivotRangeGroupNames
Gets the collection of pivot range group names in the field group. Read-only.
Declaration
public List<string> PivotRangeGroupNames { get; }
Property Value
Type |
---|
System.Collections.Generic.List<System.String> |
StartDate
Gets or sets the start date for pivot field grouping.
Declaration
public DateTime StartDate { get; set; }
Property Value
Type |
---|
System.DateTime |
StartNumber
Gets or sets the order of the first pivot field item in the pivot field group.
Declaration
public double StartNumber { get; set; }
Property Value
Type |
---|
System.Double |
Methods
FillDiscreteGroup(Int32[], String[])
Fills the discrete group with the specified property indexes and group names.
Declaration
public void FillDiscreteGroup(int[] indexes, string[] groupNames)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | indexes | Field indexes. |
System.String[] | groupNames | Field group names. |
FillRangeGroup(String[])
Add values into pivot range group names
Declaration
public void FillRangeGroup(string[] values)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | values |