All docs
V20.2
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

Badge Members

The Badge control displays a text in a badge over a visual element.

Constructors

Name Description
Badge() Initializes a new instance of the Badge class.

Fields

Name Description
AnimationDurationProperty static Identifies the Badge.AnimationDuration dependency property.
BackgroundProperty static Identifies the Badge.BackgroundProperty dependency property.
BadgeKindProperty static Identifies the Badge.BadgeKind dependency property.
BadgeProperty static Identifies the Badge.Badge attached property.
BadgeShapeProperty static Identifies the Badge.BadgeShape dependency property.
BorderBrushProperty static Identifies the Badge.BorderBrush dependency property.
BorderThicknessProperty static Identifies the Badge.BorderThickness dependency property.
ContentFormatProviderProperty static Identifies the Badge.ContentFormatProvider dependency property.
ContentProperty static Identifies the Badge.Content dependency property.
ContentStringFormatProperty static Identifies the Badge.ContentStringFormat dependency property.
ContentTemplateProperty static Identifies the Badge.ContentTemplate dependency property.
ContentTemplateSelectorProperty static Identifies the Badge.ContentTemplateSelector dependency property.
CornerRadiusProperty static Identifies the Badge.CornerRadius dependency property.
FontFamilyProperty static Identifies the Badge.FontFamily dependency property.
FontSizeProperty static Identifies the Badge.FontSize dependency property.
FontStretchProperty static Identifies the Badge.FontSize dependency property.
FontStyleProperty static Identifies the Badge.FontSize dependency property.
FontWeightProperty static Identifies the Badge.FontWeight dependency property.
ForegroundProperty static Identifies the Badge.Foreground dependency property.
HeightProperty static Identifies the Badge.Height dependency property.
HorizontalAlignmentProperty static Identifies the Badge.HorizontalAlignment dependency property.
HorizontalAnchorProperty static Identifies the Badge.HorizontalAnchor dependency property.
HorizontalContentAlignmentProperty static Identifies the Badge.HorizontalContentAlignment dependency property.
MarginProperty static Identifies the Badge.Margin dependency property.
MaxHeightProperty static Identifies the Badge.MaxHeight dependency property.
MaxWidthProperty static Identifies the Badge.MaxWidth dependency property.
MinHeightProperty static Identifies the Badge.MinHeight dependency property.
MinWidthProperty static Identifies the Badge.MinWidth dependency property.
OpacityProperty static Identifies the Badge.Opacity dependency property.
PaddingProperty static Identifies the Badge.Padding dependency property.
TemplateProperty static Identifies the Badge.Template dependency property.
VerticalAlignmentProperty static Identifies the Badge.VerticalAlignment dependency property.
VerticalAnchorProperty static Identifies the Badge.VerticalAnchor dependency property.
VerticalContentAlignmentProperty static Identifies the Badge.VerticalContentAlignment dependency property.
VisibilityProperty static Identifies the Badge.Visibility dependency property.
WidthProperty static Identifies the Badge.Width dependency property.

Properties

Name Description
AnimationDuration Get or sets the BadgeControl's fade-in and fade-out animation duration. This is a dependency property.
Background Gets or sets the brush used to paint the BadgeControl's background. This is a dependency property.
BadgeKind Gets or sets the BadgeControl's kind. This is a dependency property.
BadgeShape Gets or sets the BadgeControl's shape. This is a dependency property.
BorderBrush Gets or sets the brush used to paint the borders of the BadgeControl. This is a dependency property.
BorderThickness Gets or sets the thickness of the BadgeControl's border. This is a dependency property.
CanFreeze Gets a value that indicates whether the object can be made unmodifiable. Inherited from Freezable.
Content Gets or sets the badge's content. This is a dependency property.
ContentFormatProvider Gets or sets the format provider to format the BadgeControl's content. This is a dependency property.
ContentStringFormat Gets or sets a composite string that specifies how to format the Content property if it is displayed as a string. This is a dependency property.
ContentTemplate Gets or sets the template used to display the badge's Badge.Content. This is a dependency property.
ContentTemplateSelector Gets or sets an object that chooses the Badge.ContentTemplate based on custom logic. This is a dependency property.
CornerRadius Gets or sets the BadgeControl's corner radius. This is a dependency property.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
FontFamily Gets or sets the BadgeControl's font family. This is a dependency property.
FontSize Gets or sets the font size for the BadgeControl's text. This is a dependency property.
FontStretch Gets or sets the Badge's font stretch. This is a dependency property.
FontStyle Gets or sets the badge font style. This is a dependency property.
FontWeight Gets or sets the BadgeControl's font weight. This is a dependency property.
Foreground Gets or sets the brush used to paint the BadgeControl's foreground. This is a dependency property.
Height Gets or sets the BadgeControl's height. This is a dependency property.
HorizontalAlignment Gets or sets the BadgeControl's horizontal alignment. This is a dependency property.
HorizontalAnchor Gets or sets a BadgeControl's horizontal anchor point. This is a dependency property.
HorizontalContentAlignment Gets or sets the content's horizontal alignment within the BadgeControl container. This is a dependency property.
IsFrozen Gets a value that indicates whether the object is currently modifiable. Inherited from Freezable.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
Margin Gets or sets the outer indents around the BadgeControl. This is a dependency property.
MaxHeight Gets or sets the BadgeControl's maximum height. This is a dependency property.
MaxWidth Gets or sets the BadgeControl's maximum width. This is a dependency property.
MinHeight Gets or sets the BadgeControl's minimum height. This is a dependency property.
MinWidth Gets or sets the BadgeControl's minimum width. This is a dependency property.
Opacity Gets or sets the opacity factor applied to the BadgeControl. This is a dependency property.
Padding Gets or sets the inner indents around the BadgeControl. This is a dependency property.
Template Gets or sets the template that defines the BadgeControl's content presentation. This is a dependency property.
VerticalAlignment Gets or sets the BadgeControl's vertical alignment. This is a dependency property.
VerticalAnchor Gets or sets a BadgeControl's vertical anchor point. This is a dependency property.
VerticalContentAlignment Gets or sets the content's vertical alignment within the BadgeControl container. This is a dependency property.
Visibility Gets or sets the BadgeControl's visibility. This is a dependency property.
Width Gets or sets the BadgeControl's width. This is a dependency property.

Methods

Name Description
CheckAccess() Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
Clone() Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. Inherited from Freezable.
CloneCore(Freezable) protected Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
CloneCurrentValue() Creates a modifiable clone (deep copy) of the Freezable using its current values. Inherited from Freezable.
CloneCurrentValueCore(Freezable) protected Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. Inherited from Freezable.
CoerceValue(DependencyProperty) Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
CreateInstance() protected Initializes a new instance of the Freezable class. Inherited from Freezable.
Equals(Object) Determines whether a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Freeze() Makes the current object unmodifiable and sets its IsFrozen property to true. Inherited from Freezable.
Freeze(Freezable, Boolean) protected static If the isChecking parameter is true, this method indicates whether the specified Freezable can be made unmodifiable. If the isChecking parameter is false, this method attempts to make the specified Freezable unmodifiable and indicates whether the operation succeeded. Inherited from Freezable.
FreezeCore(Boolean) protected Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable. Inherited from Freezable.
GetAsFrozen() Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetAsFrozenCore(Freezable) protected Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
GetBadge(DependencyObject) static Gets the value of the Badge.Badge attached property to a specified DependencyObject.
GetCurrentValueAsFrozen() Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetCurrentValueAsFrozenCore(Freezable) protected Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. Inherited from Freezable.
GetHashCode() Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator() Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType() Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty) Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
InvalidateProperty(DependencyProperty) Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnChanged() protected Called when the current Freezable object is modified. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject) protected Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) protected This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. Inherited from Freezable.
OnPropertyChanged(DependencyPropertyChangedEventArgs) protected Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. Inherited from Freezable.
ReadLocalValue(DependencyProperty) Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReadPreamble() protected Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. Inherited from Freezable.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SetBadge(DependencyObject, Badge) static Sets the value of the Badge.Badge attached property to a specified DependencyObject.
SetCurrentValue(DependencyProperty, Object) Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protected Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ToString() Returns a string that represents the current object. Inherited from Object.
VerifyAccess() Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
WritePostscript() protected Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. Inherited from Freezable.
WritePreamble() protected Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. Inherited from Freezable.

Events

Name Description
Changed Occurs when the Freezable or an object it contains is modified. Inherited from Freezable.
CustomPlacement Occurs when a Badge is arranged.

Attached Properties

Name Description
Badge static Gets or sets the BadgeControl. This is an attached property.
See Also