PivotGridFieldSortBySummaryInfo.FieldName Property

Gets or sets the field name of the field whose summary values define the order in which the values of the current column field or row field are arranged.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

[DefaultValue("")]
[XtraSerializableProperty]
public string FieldName { get; set; }

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
Public Property FieldName As String

Property Value

Type	Default	Description
String	String.Empty	A string that specifies the field name of the field whose summary values determine the order of the current field’s values.

Remarks

This property is in effect if the PivotGridFieldSortBySummaryInfo.Field property is set to null.

The FieldName property specifies the name of the field against which a summary will be calculated. The summary values evaluated will define the order in which the values of the current column field or row field are arranged. The FieldName property can be set to any field name contained in the control’s data source (even to a field name which has no bound PivotGridField object in the XtraPivotGrid control).

Use the PivotGridFieldSortBySummaryInfo.SummaryType property to specify the type of the summary function which will be calculated against the specified field.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FieldName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-implement-a-custom-sort-by-summary-feature-e2917/CS/WindowsApplication53/Form1.cs#L89

if (sort) {
    fieldItem.SortBySummaryInfo.FieldName = dataFieldItem.FieldName;
    fieldItem.SortBySummaryInfo.SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Count;

VB.NET

how-to-implement-a-custom-sort-by-summary-feature-e2917/VB/WindowsApplication53/Form1.vb#L99

If sort Then
    fieldItem.SortBySummaryInfo.FieldName = dataFieldItem.FieldName
    fieldItem.SortBySummaryInfo.SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Count