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

BadgeDefaultProperties.Image Property

Gets or sets an image, used by this Badge. This property is obsolete. Use the BadgeDefaultProperties.ImageOptions.Image property instead.

Namespace: DevExpress.Utils.VisualEffects

Assembly: DevExpress.Utils.v24.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

#Declaration

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public Image Image { get; set; }

#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 background color (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. These custom images can be also painted using the badge’s back color if the BadgeDefaultProperties.ImageOptions.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.ImageOptions.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.ImageOptions.ImageStretchMargins property.

See Also