PivotGridFieldBase.FieldName Property

Gets or sets the name of the database field that is assigned to the current PivotGridFieldBase object.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v24.1.Core.dll

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

Declaration

C#

[PivotAPIMemberCategory(APICategory.LegacyBinding)]
[XtraSerializableProperty]
public virtual string FieldName { get; set; }

VB.NET

<PivotAPIMemberCategory(APICategory.LegacyBinding)>
<XtraSerializableProperty>
Public Overridable Property FieldName As String

Property Value

Type	Description
String	A String value which is the name of the data field.

Remarks

Note

This member is no longer supported in Optimized, OLAP, and Server modes. Use DataSourceColumnBindingBase.ColumnName instead.

Use this property to change the data field that is assigned to the current PivotGridFieldBase object. To specify the text displayed within the field’s header, use the PivotGridFieldBase.Caption property.

In OLAP binding mode, the FieldName property must specify the full name of the bound measure or dimension.

For dimensions, the full name is composed of a dimension’s name, followed by a hierarchy’s name, followed by the name of a level(s). All names should be wrapped within square brackets and separated from one another using the dot symbol. Example: “[Customer].[Customer Geography].[Country]”.

For measures, the full name is composed of the “[Measures].” string followed by the measure’s name. Example: “[Measures].[Sales Amount]”.

Related GitHub Examples

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

winforms-pivot-grid-use-a-hidden-field-to-sort-visible-field-values/CS/CustomFieldSortExample/Form1.cs#L29

{
    if (e.Field.FieldName == "Sales Person")
    {

winforms-pivot-grid-implement-the-distinct-count-summary-type/CS/CustomSummaryDistinctCountExample/Form1.cs#L39

{
    string name = e.DataField.FieldName;

VB.NET

winforms-pivot-grid-use-a-hidden-field-to-sort-visible-field-values/VB/CustomFieldSortExample/Form1.vb#L25

Private Sub pivotGridControl1_CustomFieldSort(ByVal sender As Object, ByVal e As PivotGridCustomFieldSortEventArgs)
    If e.Field.FieldName = "Sales Person" Then
        If e.SortLocation = PivotSortLocation.Pivot Then

winforms-pivot-grid-implement-the-distinct-count-summary-type/VB/CustomSummaryDistinctCountExample/Form1.vb#L25

Private Sub PivotGridControl1_CustomSummary(ByVal sender As Object, ByVal e As PivotGridCustomSummaryEventArgs)
    Dim field_name As String = e.DataField.FieldName