BadgeDefaultProperties.Image Property

Gets or sets an image, used by this Badge.

Namespace: DevExpress.Utils.VisualEffects

Assembly: DevExpress.Utils.v20.1.dll

Declaration

[Browsable(false)]
public Image Image { get; set; }
<Browsable(False)>
Public Property Image As Image

Property Value

Type Default Description
Image

null

An Image displayed within this badge.

Remarks

By default, badges display their text blocks above circles, filled with this badge's backcolor (see the Badge.Appearance property). You can replace this simple shape with your own custom image for all badges at once (to do so, use the BadgeProperties.Image property) or an individual badge (the Image property). These custom images can be also painted using the badge's back color if the BadgeDefaultProperties.AllowGlyphSkinning property equals DefaultBoolean.True.

Images can be automatically stretched to fit long strings of text displayed by badges. To enable this behavior, set the BadgeDefaultProperties.StretchImage property to DefaultBoolean.True. You can also control how badge images are stretched by dividing the image area into two regions: one that is never scaled and displayed as is, another is stretched as required. These regions are set using the BadgeDefaultProperties.ImageStretchMargins property.

See Also