AppMenuFileLabel.LabelImageClick Event

Fires when the label's image/selected image is clicked.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v20.2.dll

Declaration

[DXCategory("Events")]
public event CancelEventHandler LabelImageClick
<DXCategory("Events")>
Public Event LabelImageClick As CancelEventHandler

Event Data

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

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled.

Remarks

A check button is displayed at the label's right edge, provided that the AppMenuFileLabel.ShowCheckButton property is enabled. This button displays either AppMenuFileLabel.Image or AppMenuFileLabel.SelectedImage according to the button's state (AppMenuFileLabel.Checked).

When the check button is clicked, the LabelImageClick event fires. You can set the event's Cancel parameter to true to prevent follow-up actions. If the Cancel parameter is left set to false, the check button's state is toggled and the notification AppMenuFileLabel.CheckedChanged event fires. You can handle this event to respond to checking/unchecking the button.

See Also