PivotGridFieldCollection.Add(String, PivotArea) Method

Adds a new field with the specified field name and location to the end of the collection.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.2.dll

Declaration

C#

public PivotGridField Add(
    string fieldName,
    PivotArea area
)

VB.NET

Public Function Add(
    fieldName As String,
    area As PivotArea
) As PivotGridField

Parameters

Name	Type	Description
fieldName	String	A string that identifies the name of the database field that will be assigned to the new PivotGridField object. This value is assigned to the PivotGridFieldBase.FieldName property.
area	PivotArea	A PivotArea value that identifies the area in which the new PivotGridField object will be positioned. This value is assigned to the PivotGridFieldBase.Area property.

Returns

Type	Description
PivotGridField	The PivotGridField object that has been added to the collection.

Remarks

This method creates a new PivotGridField object, initializes it with default settings and appends it to the collection.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(String, PivotArea) 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#

how-to-locate-field-value-cells-matching-a-particular-condition-e2772/CS/Data.cs#L21

public static void FillPivot(PivotGridControl pivot) {
    pivot.Fields.Add(Employee, PivotArea.RowArea);
    pivot.Fields.Add(Widget, PivotArea.RowArea);

winforms-pivot-grid-hide-empty-columns-and-rows/CS/Data.cs#L44

public static void FillPivot(PivotGridControl pivot) {
    pivot.Fields.Add(Employee, PivotArea.RowArea);
    pivot.Fields.Add(Widget, PivotArea.RowArea);

winforms-pivot-grid-hide-specific-columns-and-rows/CS/Data.cs#L21

public static void FillPivot(PivotGridControl pivot) {
    pivot.Fields.Add(Employee, PivotArea.RowArea);
    pivot.Fields.Add(Widget, PivotArea.RowArea);

winforms-pivot-split-field-value-cells/CS/Data.cs#L21

public static void FillPivot(PivotGridControl pivot) {
    pivot.Fields.Add(Employee, PivotArea.RowArea);
    pivot.Fields.Add(Widget, PivotArea.RowArea);

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/CS/WindowsApplication1/Form1.cs#L46

void AddFields() {
    columnField = pivotGridControl1.Fields.Add("Category", PivotArea.ColumnArea);
    rowField = pivotGridControl1.Fields.Add("Product", PivotArea.RowArea);

VB.NET

how-to-locate-field-value-cells-matching-a-particular-condition-e2772/VB/Data.vb#L25

Public Shared Sub FillPivot(ByVal pivot As PivotGridControl)
    pivot.Fields.Add(Employee, PivotArea.RowArea)
    pivot.Fields.Add(Widget, PivotArea.RowArea)

winforms-pivot-grid-hide-empty-columns-and-rows/VB/Data.vb#L54

Public Sub FillPivot(ByVal pivot As PivotGridControl)
    pivot.Fields.Add(Employee, PivotArea.RowArea)
    pivot.Fields.Add(Widget, PivotArea.RowArea)

winforms-pivot-grid-hide-specific-columns-and-rows/VB/Data.vb#L25

Public Shared Sub FillPivot(ByVal pivot As PivotGridControl)
    pivot.Fields.Add(Employee, PivotArea.RowArea)
    pivot.Fields.Add(Widget, PivotArea.RowArea)

winforms-pivot-split-field-value-cells/VB/Data.vb#L25

Public Shared Sub FillPivot(ByVal pivot As PivotGridControl)
    pivot.Fields.Add(Employee, PivotArea.RowArea)
    pivot.Fields.Add(Widget, PivotArea.RowArea)

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/VB/WindowsApplication1/Form1.vb#L48

Private Sub AddFields()
    columnField = pivotGridControl1.Fields.Add("Category", PivotArea.ColumnArea)
    rowField = pivotGridControl1.Fields.Add("Product", PivotArea.RowArea)