PivotGridFieldCollection.GetFieldByName(String) Method

Returns the field by the name.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public PivotGridField GetFieldByName(
    string name
)

VB.NET

Public Function GetFieldByName(
    name As String
) As PivotGridField

Parameters

Name	Type	Description
name	String	A String that specifies the name of the required field.

Returns

Type	Description
PivotGridField	A PivotGridField object representing the field whose name matches the specified string; null (Nothing in Visual Basic) if the field does not exist.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetFieldByName(String) method.

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#

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/CS/PivotGridCustomSummaryExample/Form1.cs#L73

// Create a new field to display totals.
PivotGridField fieldValueTotal = pivotGridControl1.Fields.GetFieldByName("fieldValueTotal") ?? CreateSavingsField();
fieldValueTotal.UnboundExpression = "Sum(Iif([Type]='Income', [Value], -[Value]))";

VB.NET

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/VB/PivotGridCustomSummaryExample/Form1.vb#L59

' Create a new field to display totals.
Dim fieldValueTotal As PivotGridField = If(pivotGridControl1.Fields.GetFieldByName("fieldValueTotal"), CreateSavingsField())
fieldValueTotal.UnboundExpression = "Sum(Iif([Type]='Income', [Value], -[Value]))"