PivotGridFieldBase.Name Property

Gets or sets the field’s name.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.WindowsDesktop.PivotGrid.Core

Declaration

C#

[Browsable(false)]
[DefaultValue("")]
public virtual string Name { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue("")>
Public Overridable Property Name As String

Property Value

Type	Default	Description
String	String.Empty	A string which specifies the field’s name.

Remarks

PivotGridFieldBase objects are Component descendants and thus can be directly accessed in code using their names.

Use the Name property to assign a name to a PivotGridFieldBase object created at runtime. To retrieve a field from the control’s field collection by its name use the PivotGridFieldCollectionBase.GetFieldByName method.

Related GitHub Examples

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

winforms-pivot-grid-hide-the-grand-total-column-and-text-labels/CS/RemoveGridLinesExample/Form1.cs#L43

PivotGridField fieldYear = new PivotGridField("Date", PivotArea.RowArea);
fieldYear.Name = "FieldYear";
fieldYear.Caption = fieldYear.Name;

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/CS/PivotGridFormatCondition/ExpressionConditionDesigner.cs#L23

{
    Text = String.Format("Expression condition for field: [{0}]", SourceField.Name);
    LoadCondititons();

invoke-summary-type-menu-when-user-hovers-over-the-field-header-with-a-mouse-e2351/CS/WindowsApplication34/Form1.cs#L31

PivotGridField fieldYear = new PivotGridField("Date", PivotArea.ColumnArea);
fieldYear.Name = "FieldYear";
fieldYear.Caption = fieldYear.Name;

how-to-avoid-production-of-unnecessary-column-and-merging-of-cells-in-excel-export-e2346/CS/WindowsApplication53/Form1.cs#L81

if (e.Field != null && e.Field.Name == "fieldExportHeader" && e.ValueType == PivotGridValueType.Value )
{

winforms-pivot-change-summarydisplaytype-in-context-menu/CS/WindowsApplication34/Form1.cs#L24

PivotGridField fieldYear = new PivotGridField("Date", PivotArea.ColumnArea);
fieldYear.Name = "FieldYear";
fieldYear.Caption = fieldYear.Name;

VB.NET

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/VB/PivotGridFormatCondition/ExpressionConditionDesigner.vb#L37

Private Sub ExpressionConditionDesigner_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    Text = String.Format("Expression condition for field: [{0}]", SourceField.Name)
    LoadCondititons()

winforms-pivot-grid-hide-the-grand-total-column-and-text-labels/VB/RemoveGridLinesExample/Form1.vb#L38

Dim fieldYear As New PivotGridField("Date", PivotArea.RowArea)
fieldYear.Name = "FieldYear"
fieldYear.Caption = fieldYear.Name

pivot-grid-aggr-examples/VB/Pivot-Aggr-Examples/CodeFiles/CodeExample.vb#L19

Dim salesByYearByCountry As New PivotGridField()
salesByYearByCountry.Name = "fldSalesByYearByCountry"
salesByYearByCountry.Area = PivotArea.FilterArea

how-to-avoid-production-of-unnecessary-column-and-merging-of-cells-in-excel-export-e2346/VB/WindowsApplication53/Form1.vb#L49

fieldExportHeader.Caption = "Export"
fieldExportHeader.Name = "fieldExportHeader"
fieldExportHeader.Area = DevExpress.XtraPivotGrid.PivotArea.ColumnArea

invoke-summary-type-menu-when-user-hovers-over-the-field-header-with-a-mouse-e2351/VB/WindowsApplication34/Form1.vb#L29

Dim fieldYear As New PivotGridField("Date", PivotArea.ColumnArea)
fieldYear.Name = "FieldYear"
fieldYear.Caption = fieldYear.Name