PivotSortMode Enum

Lists the values that specify how a field’s data should be sorted.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.PivotGrid.v25.2.Core.dll

NuGet Packages : DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

• C#
• VB.NET

[ResourceFinder(typeof(ResFinder), "PropertyNamesRes")]
public enum PivotSortMode

<ResourceFinder(GetType(ResFinder), "PropertyNamesRes")>
Public Enum PivotSortMode

Members

Sorts the field’s data by the field’s values (these are synchronized with the values from the bound data source).

| | Value |

Sorts the field’s data by the field’s values (these are synchronized with the values from the bound data source).

| | DisplayText |

• Sorts the field’s data by the field’s display text (the strings displayed within the field values).
• In OLAP mode, the data is sorted against the text generated on the server. Set the PivotGridOptionsOLAP.SortByCustomFieldValueDisplayText property to true to sort data by handling the PivotGridControl’s FieldValueDisplayText event.
• The field is not sorted against the custom text generated on the client side (for instance, if you modify the text via the PivotGridControl.FieldValueDisplayText event).

| | Custom |

Enables custom sorting of the field’s data using the CustomFieldSort event or the CustomServerModeSort event in OLAP mode.

| | Key |

Sorts the field’s data by key attributes (in OLAP mode).

| | ID |

Sorts by a level member’s ID (in OLAP mode).

| | None |

Data is not sorted - it is displayed in the order the data source specifies. This option is in effect only in OLAP mode.

| | DimensionAttribute |

Sorts the field’s data by the OLAP member property (in OLAP mode). Set the PivotGridFieldBase.SortByAttribute property to specify the dimension attribute.

|

Related API Members

The following properties accept/return PivotSortMode values:

• IThreadSafeField.SortMode
• PivotGridFieldBase.ActualSortMode
• PivotGridFieldBase.SortMode

Remarks

Values listed by this enumeration are used to set the field’s PivotGridFieldBase.SortMode property.

When the field’s SortMode is set to Custom , refer to the platform-specific events for more information:

When the field’s SortMode is set to Custom in OLAP mode, refer to the platform-specific events for more information:

See Also

SortMode

DevExpress.XtraPivotGrid Namespace