Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

PivotGridField.ImageIndex Property

Use the ImageIndex option accessible in PivotGridField.ImageOptions to specify the index of the image displayed within the field’s header.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.2.dll

NuGet Package: DevExpress.Win.PivotGrid

#Declaration

[Browsable(false)]
[DefaultValue(-1)]
[EditorBrowsable(EditorBrowsableState.Never)]
[ImageList("HeaderImages")]
[XtraSerializableProperty]
public int ImageIndex { get; set; }

#Property Value

Type Default Description
Int32 -1

A zero-based integer that represents the index of the image which is displayed within the field’s header.

#Remarks

Use the ImageIndex property to associate an image from the PivotGridControl.HeaderImages list with the current field. This image will be displayed within the field’s header.

FieldHeaderImage

It’s also possible to associate images with field values. To do this assign an image list to the PivotGridControl.ValueImages property and handle the PivotGridControl.FieldValueImageIndex event to associate the images in this list with particular field values.

Tip

You can also assign an image by its name in the collection.

// The image collection is created and populated with images at design time.
barItem.ImageOptions.Image = imageCollection1["technology_32x32"]; 
// Assign an SVG image in the SvgCollection
// barItem.ImageOptions.SvgImage = svgCollection1["technology_32x32"];

Read the following help topic for more information: Access and Use DevExpress Icons in Code.

See Also