Skip to main content
A newer version of this page is available. .

BadgeDefaultProperties.StretchImage Property

Gets or sets whether or not this Badge should stretch its image to fit the text block.

Namespace: DevExpress.Utils.VisualEffects

Assembly: DevExpress.Utils.v19.2.dll

Declaration

[Browsable(false)]
public DefaultBoolean StretchImage { get; set; }

Property Value

Type Default Description
DefaultBoolean **Default**

A DefaultBoolean enumerator value that specifies whether or not this Badge should stretch its image to fit the text block.

Available values:

Name Description
True

Corresponds to a Boolean value of true.

False

Corresponds to a Boolean value of false.

Default

The value is determined by the current object’s parent object setting (e.g., a control setting).

Remarks

Text blocks, whose sizes are calculated as BadgeDefaultProperties.Text bounds plus the BadgeDefaultProperties.TextMargin, can require more space than the badge BadgeDefaultProperties.Image offers. When this happens, you can set the StretchImage property to DefaultBoolean.True to stretch this image vertically and/or horizontally until it fits the badge text. In order to prevent badge images from blurring, you can use the BadgeDefaultProperties.ImageStretchMargins property to set image regions that are never stretched.

If the StretchImage property is not set, the badge acts according to the common behavior, specified by the BadgeProperties.StretchImage property.

See Also