PivotFieldDisplayTextEventArgs.Value Property

Gets the processed item’s value.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.2.dll

Declaration

C#

public override object Value { get; }

VB.NET

Public Overrides ReadOnly Property Value As Object

Property Value

Type	Description
Object	An object which represents the item’s value.

Remarks

If the PivotGridControl.FieldValueDisplayText event is raised for a field value header or total header the Value property returns the value of the corresponding column field or row field. If this event is fired for a grand total header or data field header the Value property will return null. To determine the type of the currently processed header use the PivotFieldValueEventArgsBase<T>.ValueType property.

If the PivotGridControl.FieldValueDisplayText event is fired for an item within a filter dropdown, the Value property returns the field’s value that corresponds to this item.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value 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-provide-custom-date-time-group-intervals-and-preserve-correct-sort-order-e2726/CS/WindowsApplication21/Form1.cs#L66

{
    DateTime dt = Convert.ToDateTime(e.Value);
    if (dt == beforeDate)

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

{
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName((int)e.Value);
}

how-to-implement-the-group-filter-for-a-pivotgrid-e2315/CS/Data.cs#L31

    e.DisplayText =
        CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName((int)e.Value);
}

winforms-pivot-grid-hide-empty-columns-and-rows/CS/Form1.cs#L91

{
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName((int)e.Value);
}

winforms-pivot-grid-hide-specific-columns-and-rows/CS/Form1.cs#L46

{
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName((int)e.Value);
}

VB.NET

how-to-provide-custom-date-time-group-intervals-and-preserve-correct-sort-order-e2726/VB/WindowsApplication21/Form1.vb#L61

If ReferenceEquals(e.Field, fieldCustomMonth) Then
    Dim dt As DateTime = Convert.ToDateTime(e.Value)
    If dt = beforeDate Then

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

If e.Field Is pivot.Fields(PivotHelper.Month) Then
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName(CInt((e.Value)))
End If

how-to-implement-the-group-filter-for-a-pivotgrid-e2315/VB/Data.vb#L31

If Object.ReferenceEquals(e.Field, fieldMonth) Then
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName(CInt(Fix(e.Value)))
End If

winforms-pivot-grid-hide-empty-columns-and-rows/VB/Form1.vb#L78

If ReferenceEquals(e.Field, pivotGridControl1.Fields(Month)) Then
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName(CInt(e.Value))
End If

winforms-pivot-grid-hide-specific-columns-and-rows/VB/Form1.vb#L52

If e.Field Is pivot.Fields(PivotHelper.Month) Then
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName(CInt((e.Value)))
End If