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.v21.2.dll

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

Declaration

C#

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

VB.NET

<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
Public Property StretchImage As DefaultBoolean

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	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

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.