BadgeView Class

Reference

Definition

Namespace:: Xamarin.CommunityToolkit.UI.Views

Assembly:: Xamarin.CommunityToolkit.dll

Package:: Xamarin.CommunityToolkit v1.1.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The BadgeView allows the user to show a badge with a string value on top of any control. By wrapping a control in a BadgeView control, you can show a badge value on top of it. This is very much like the badges you see on the app icons on iOS and Android.

[Xamarin.Forms.ContentProperty("Content")]
public class BadgeView : Xamarin.CommunityToolkit.UI.Views.Internals.BaseTemplatedView<Xamarin.Forms.Grid>

Inheritance: TemplatedView

BaseTemplatedView<Grid>
BadgeView

Attributes: ContentPropertyAttribute

Constructors

BadgeView()

Fields

AutoHideProperty	Backing BindableProperty for the AutoHide property.
BackgroundColorProperty	Backing BindableProperty for the BackgroundColor property.
BadgeAnimationProperty	Backing BindableProperty for the BadgeAnimation property.
BadgePositionProperty	Backing BindableProperty for the BadgePosition property.
BorderColorProperty	Backing BindableProperty for the BorderColor property.
ContentProperty	Backing BindableProperty for the Content property.
FontAttributesProperty	Backing BindableProperty for the FontAttributes property.
FontFamilyProperty	Backing BindableProperty for the FontFamily property.
FontSizeProperty	Backing BindableProperty for the FontSize property.
HasShadowProperty	Backing BindableProperty for the HasShadow property.
IsAnimatedProperty	Backing BindableProperty for the IsAnimated property.
TextColorProperty	Backing BindableProperty for the TextColor property.
TextProperty	Backing BindableProperty for the Text property.

Properties

AutoHide	Determines whether or not the badge is automatically hidden when the Text is set to 0. This is a bindable property.
BackgroundColor	Gets or sets the background Color of the badge. This is a bindable property.
BadgeAnimation	Gets or sets the animation that is used when the badge is shown or hidden. The animation only shows when IsAnimated is set to true. This is a bindable property.
BadgePosition	Determines the position where the badge will be shown on top of Content. This is a bindable property.
BorderColor	Gets or sets the border Color of the badge. This is a bindable property.
Content	Gets or sets the View on top of which the BadgeView will be shown. This is a bindable property.
Control	(Inherited from BaseTemplatedView<TControl>)
FontAttributes	Font attributes of all the text on the BadgeView. This is a bindable property.
FontFamily	Font of the text on the BadgeView. This is a bindable property.
FontSize	Font size of all the text on the BadgeView. NamedSize values can be used. This is a bindable property.
HasShadow	Enabled or disables a shadow being shown behind the BadgeView. This is a bindable property.
IsAnimated	Determines if an animation is used when the badge is shown or hidden. This is a bindable property.
Text	Text that is shown on the BadgeView. Set this property to 0 and AutoHide to true, to make the badge disappear automatically. This is a bindable property.
TextColor	Gets or sets the Color or the test shown in the BadgeView. This is a bindable property.

Methods

OnBindingContextChanged()
OnChildAdded(Element)	(Inherited from BaseTemplatedView<TControl>)
OnControlInitialized(Grid)
OnControlInitialized(TControl)	(Inherited from BaseTemplatedView<TControl>)
OnSizeAllocated(Double, Double)

Applies to

Share via