PivotFieldDisplayTextEventArgs.Value Property

Gets the processed item’s value.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v23.2.dll

NuGet Package: DevExpress.Web

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 ASPxPivotGrid.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 raised for a grand total header or data field header, the Value property returns null (Nothing in Visual Basic).

To determine the processed header’s type use the PivotFieldValueEventArgsBase<T>.ValueType property.

If the ASPxPivotGrid.FieldValueDisplayText event is raised for an item within a filter dropdown, the Value property returns the corresponding field value.

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#

web-forms-pivot-grid-split-field-value-cells/CS/ASPxPivotGrid_SplittingCells/Default.aspx.cs#L45

                    PivotFieldDisplayTextEventArgs e) {
if (e.Field == pivotGrid.Fields[PivotHelper.Month] && e.Value is int) {
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName((int)e.Value);

web-forms-pivot-grid-hide-particular-rows-and-columns/CS/ASPxPivotGrid_HidingColumnsAndRows/Default.aspx.cs#L41

if (e.Field == pivotGrid.Fields[PivotHelper.Month]) {
    e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName((int)e.Value);
}

VB.NET

web-forms-pivot-grid-split-field-value-cells/VB/ASPxPivotGrid_SplittingCells/Default.aspx.vb#L42

Protected Sub pivotGrid_FieldValueDisplayText(ByVal sender As Object, ByVal e As PivotFieldDisplayTextEventArgs)
    If e.Field Is pivotGrid.Fields(Month) AndAlso TypeOf e.Value Is Integer Then
        e.DisplayText = CultureInfo.CurrentCulture.DateTimeFormat.GetMonthName(CInt(e.Value))

web-forms-pivot-grid-hide-particular-rows-and-columns/VB/ASPxPivotGrid_HidingColumnsAndRows/Default.aspx.vb#L39

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