Skip to main content

ChartControl.CustomizeLegend Event

OBSOLETE

The CustomizeLegend event is obsolete now. Use the PivotChartingCustomizeLegend event instead.

Occurs before automatic settings are applied to the legend‘s layout properties.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.UI.dll

NuGet Package: DevExpress.Win.Charts

Declaration

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("The CustomizeLegend event is obsolete now. Use the PivotChartingCustomizeLegend event instead.")]
public event CustomizeLegendEventHandler CustomizeLegend

Event Data

The CustomizeLegend event's data class is CustomizeLegendEventArgs. The following properties provide information specific to this event:

Property Description
Legend Gets the chart’s legend.
MaxHorizontalPercentage Specifies the legend‘s maximum horizontal percentage.
MaxVerticalPercentage Specifies the legend‘s maximum vertical percentage.

Remarks

When a familiar data source (such as the PivotGridControl) is assigned to the chart’s ChartControl.DataSource property, and the ChartControl.AutoLayoutSettingsEnabled property is turned on, the LegendBase.MaxHorizontalPercentage and LegendBase.MaxVerticalPercentage properties are defined automatically, and cannot be customized at design time.

Handle the CustomizeLegend event, to manually adjust these options (via the CustomizeLegendEventArgs.MaxHorizontalPercentage and CustomizeLegendEventArgs.MaxVerticalPercentage properties). To access the legend, use the CustomizeLegendEventArgs.Legend property.

For more information, see Pivot Charting (Integration with a Pivot Grid Control).

See Also