Class Shield

Namespace

Nova.Avalonia.UI.Controls

Assembly

Nova.Avalonia.UI.dll

A control that displays a subject and status in a badge-like format, commonly used to display build status, version numbers, or other metadata in a compact way.

public class Shield : Button, INotifyPropertyChanged, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, INamed, IInputElement, IDataTemplateHost, ISetterValue, ICommandSource

Inheritance

object

AvaloniaObject

Animatable

StyledElement

Visual

Layoutable

Interactive

InputElement

Control

TemplatedControl

ContentControl

Button

Shield

Implements

INotifyPropertyChanged

IDataContextProvider

ILogical

IThemeVariantHost

IResourceHost

IResourceNode

IStyleHost

ISetLogicalParent

ISetInheritanceParent

ISupportInitialize

INamed

IInputElement

IDataTemplateHost

ISetterValue

ICommandSource

Inherited Members

Button.ClickModeProperty

Button.CommandProperty

Button.HotKeyProperty

Button.CommandParameterProperty

Button.IsDefaultProperty

Button.IsCancelProperty

Button.ClickEvent

Button.IsPressedProperty

Button.FlyoutProperty

Button.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)

Button.OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)

Button.OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)

Button.OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)

Button.OnAccessKey(RoutedEventArgs)

Button.OnKeyUp(KeyEventArgs)

Button.OnClick()

Button.OpenFlyout()

Button.CloseFlyout()

Button.OnFlyoutOpened()

Button.OnFlyoutClosed()

Button.OnPointerReleased(PointerReleasedEventArgs)

Button.OnPointerCaptureLost(PointerCaptureLostEventArgs)

Button.OnLostFocus(FocusChangedEventArgs)

Button.OnApplyTemplate(TemplateAppliedEventArgs)

Button.UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception)

Button.ClickMode

Button.Command

Button.HotKey

Button.CommandParameter

Button.IsDefault

Button.IsCancel

Button.IsPressed

Button.Flyout

Button.IsEnabledCore

Button.Click

ContentControl.ContentProperty

ContentControl.ContentTemplateProperty

ContentControl.HorizontalContentAlignmentProperty

ContentControl.VerticalContentAlignmentProperty

ContentControl.RegisterContentPresenter(ContentPresenter)

ContentControl.Content

ContentControl.ContentTemplate

ContentControl.Presenter

ContentControl.HorizontalContentAlignment

ContentControl.VerticalContentAlignment

TemplatedControl.BackgroundProperty

TemplatedControl.BackgroundSizingProperty

TemplatedControl.BorderBrushProperty

TemplatedControl.BorderThicknessProperty

TemplatedControl.CornerRadiusProperty

TemplatedControl.FontFamilyProperty

TemplatedControl.FontFeaturesProperty

TemplatedControl.FontSizeProperty

TemplatedControl.FontStyleProperty

TemplatedControl.FontWeightProperty

TemplatedControl.FontStretchProperty

TemplatedControl.ForegroundProperty

TemplatedControl.LetterSpacingProperty

TemplatedControl.PaddingProperty

TemplatedControl.TemplateProperty

TemplatedControl.IsTemplateFocusTargetProperty

TemplatedControl.TemplateAppliedEvent

TemplatedControl.GetIsTemplateFocusTarget(Control)

TemplatedControl.SetIsTemplateFocusTarget(Control, bool)

TemplatedControl.ApplyTemplate()

TemplatedControl.GetTemplateFocusTarget()

TemplatedControl.OnTemplateChanged(AvaloniaPropertyChangedEventArgs)

TemplatedControl.Background

TemplatedControl.BackgroundSizing

TemplatedControl.BorderBrush

TemplatedControl.BorderThickness

TemplatedControl.CornerRadius

TemplatedControl.FontFamily

TemplatedControl.FontFeatures

TemplatedControl.FontSize

TemplatedControl.FontStyle

TemplatedControl.FontWeight

TemplatedControl.FontStretch

TemplatedControl.Foreground

TemplatedControl.LetterSpacing

TemplatedControl.Padding

TemplatedControl.Template

TemplatedControl.TemplateApplied

Control.FocusAdornerProperty

Control.TagProperty

Control.ContextMenuProperty

Control.ContextFlyoutProperty

Control.RequestBringIntoViewEvent

Control.LoadedEvent

Control.UnloadedEvent

Control.SizeChangedEvent

Control.OnLoaded(RoutedEventArgs)

Control.OnUnloaded(RoutedEventArgs)

Control.OnSizeChanged(SizeChangedEventArgs)

Control.OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)

Control.OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)

Control.OnGotFocus(FocusChangedEventArgs)

Control.FocusAdorner

Control.DataTemplates

Control.ContextMenu

Control.ContextFlyout

Control.IsLoaded

Control.Tag

Control.Loaded

Control.Unloaded

Control.SizeChanged

InputElement.FocusableProperty

InputElement.IsEnabledProperty

InputElement.IsEffectivelyEnabledProperty

InputElement.CursorProperty

InputElement.IsKeyboardFocusWithinProperty

InputElement.IsFocusedProperty

InputElement.IsHitTestVisibleProperty

InputElement.IsPointerOverProperty

InputElement.IsTabStopProperty

InputElement.GotFocusEvent

InputElement.GettingFocusEvent

InputElement.LostFocusEvent

InputElement.LosingFocusEvent

InputElement.KeyDownEvent

InputElement.KeyUpEvent

InputElement.TabIndexProperty

InputElement.TextInputEvent

InputElement.TextInputMethodClientRequestedEvent

InputElement.PointerEnteredEvent

InputElement.PointerExitedEvent

InputElement.PointerMovedEvent

InputElement.PointerPressedEvent

InputElement.PointerReleasedEvent

InputElement.PointerCaptureLostEvent

InputElement.PointerWheelChangedEvent

InputElement.ContextRequestedEvent

InputElement.ContextCanceledEvent

InputElement.IsHoldingEnabledProperty

InputElement.IsHoldWithMouseEnabledProperty

InputElement.PinchEvent

InputElement.PinchEndedEvent

InputElement.PullGestureEvent

InputElement.PullGestureEndedEvent

InputElement.SwipeGestureEvent

InputElement.SwipeGestureEndedEvent

InputElement.ScrollGestureEvent

InputElement.ScrollGestureInertiaStartingEvent

InputElement.ScrollGestureEndedEvent

InputElement.PointerTouchPadGestureMagnifyEvent

InputElement.PointerTouchPadGestureRotateEvent

InputElement.PointerTouchPadGestureSwipeEvent

InputElement.TappedEvent

InputElement.RightTappedEvent

InputElement.HoldingEvent

InputElement.DoubleTappedEvent

InputElement.Focus(NavigationMethod, KeyModifiers)

InputElement.OnGettingFocus(FocusChangingEventArgs)

InputElement.OnLosingFocus(FocusChangingEventArgs)

InputElement.OnTextInput(TextInputEventArgs)

InputElement.OnPointerEntered(PointerEventArgs)

InputElement.OnPointerExited(PointerEventArgs)

InputElement.OnPointerMoved(PointerEventArgs)

InputElement.GetNextTabStopOverride()

InputElement.GetPreviousTabStopOverride()

InputElement.GetFirstFocusableElementOverride()

InputElement.GetLastFocusableElementOverride()

InputElement.ProcessTabStopOverride(IInputElement, IInputElement, bool, bool, ref IInputElement)

InputElement.ProcessCandidateTabStopOverride(IInputElement, IInputElement, IInputElement, bool, ref IInputElement)

InputElement.OnPointerWheelChanged(PointerWheelEventArgs)

InputElement.OnTapped(TappedEventArgs)

InputElement.OnRightTapped(TappedEventArgs)

InputElement.OnDoubleTapped(TappedEventArgs)

InputElement.OnHolding(HoldingRoutedEventArgs)

InputElement.UpdateIsEffectivelyEnabled()

InputElement.GetIsHoldingEnabled(StyledElement)

InputElement.SetIsHoldingEnabled(StyledElement, bool)

InputElement.GetIsHoldWithMouseEnabled(StyledElement)

InputElement.SetIsHoldWithMouseEnabled(StyledElement, bool)

InputElement.Focusable

InputElement.IsEnabled

InputElement.Cursor

InputElement.IsKeyboardFocusWithin

InputElement.IsFocused

InputElement.IsHitTestVisible

InputElement.IsPointerOver

InputElement.IsTabStop

InputElement.IsEffectivelyEnabled

InputElement.TabIndex

InputElement.KeyBindings

InputElement.GestureRecognizers

InputElement.GotFocus

InputElement.GettingFocus

InputElement.LostFocus

InputElement.LosingFocus

InputElement.KeyDown

InputElement.KeyUp

InputElement.TextInput

InputElement.TextInputMethodClientRequested

InputElement.PointerEntered

InputElement.PointerExited

InputElement.PointerMoved

InputElement.PointerPressed

InputElement.PointerReleased

InputElement.PointerCaptureLost

InputElement.PointerWheelChanged

InputElement.ContextRequested

InputElement.ContextCanceled

InputElement.Pinch

InputElement.PinchEnded

InputElement.PullGesture

InputElement.PullGestureEnded

InputElement.ScrollGesture

InputElement.ScrollGestureInertiaStarting

InputElement.ScrollGestureEnded

InputElement.PointerTouchPadGestureMagnify

InputElement.PointerTouchPadGestureRotate

InputElement.SwipeGesture

InputElement.SwipeGestureEnded

InputElement.PointerTouchPadGestureSwipe

InputElement.Tapped

InputElement.RightTapped

InputElement.Holding

InputElement.DoubleTapped

Interactive.AddHandler(RoutedEvent, Delegate, RoutingStrategies, bool)

Interactive.AddHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool)

Interactive.RemoveHandler(RoutedEvent, Delegate)

Interactive.RemoveHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>)

Interactive.RaiseEvent(RoutedEventArgs)

Interactive.BuildEventRoute(RoutedEvent)

Layoutable.DesiredSizeProperty

Layoutable.WidthProperty

Layoutable.HeightProperty

Layoutable.MinWidthProperty

Layoutable.MaxWidthProperty

Layoutable.MinHeightProperty

Layoutable.MaxHeightProperty

Layoutable.MarginProperty

Layoutable.HorizontalAlignmentProperty

Layoutable.VerticalAlignmentProperty

Layoutable.UseLayoutRoundingProperty

Layoutable.UpdateLayout()

Layoutable.Measure(Size)

Layoutable.Arrange(Rect)

Layoutable.InvalidateMeasure()

Layoutable.InvalidateArrange()

Layoutable.AffectsMeasure<T>(params AvaloniaProperty[])

Layoutable.AffectsArrange<T>(params AvaloniaProperty[])

Layoutable.MeasureCore(Size)

Layoutable.MeasureOverride(Size)

Layoutable.ArrangeCore(Rect)

Layoutable.ArrangeOverride(Size)

Layoutable.OnMeasureInvalidated()

Layoutable.OnVisualParentChanged(Visual, Visual)

Layoutable.Width

Layoutable.Height

Layoutable.MinWidth

Layoutable.MaxWidth

Layoutable.MinHeight

Layoutable.MaxHeight

Layoutable.Margin

Layoutable.HorizontalAlignment

Layoutable.VerticalAlignment

Layoutable.DesiredSize

Layoutable.IsMeasureValid

Layoutable.IsArrangeValid

Layoutable.UseLayoutRounding

Layoutable.EffectiveViewportChanged

Layoutable.LayoutUpdated

Visual.BoundsProperty

Visual.ClipToBoundsProperty

Visual.ClipProperty

Visual.IsVisibleProperty

Visual.OpacityProperty

Visual.OpacityMaskProperty

Visual.CacheModeProperty

Visual.EffectProperty

Visual.HasMirrorTransformProperty

Visual.RenderTransformProperty

Visual.RenderTransformOriginProperty

Visual.FlowDirectionProperty

Visual.VisualParentProperty

Visual.ZIndexProperty

Visual.GetFlowDirection(Visual)

Visual.SetFlowDirection(Visual, FlowDirection)

Visual.InvalidateVisual()

Visual.Render(DrawingContext)

Visual.AffectsRender<T>(params AvaloniaProperty[])

Visual.LogicalChildrenCollectionChanged(object, NotifyCollectionChangedEventArgs)

Visual.InvalidateMirrorTransform()

Visual.Bounds

Visual.ClipToBounds

Visual.Clip

Visual.IsEffectivelyVisible

Visual.IsVisible

Visual.Opacity

Visual.OpacityMask

Visual.CacheMode

Visual.Effect

Visual.HasMirrorTransform

Visual.RenderTransform

Visual.RenderTransformOrigin

Visual.FlowDirection

Visual.ZIndex

Visual.VisualChildren

Visual.VisualRoot

Visual.BypassFlowDirectionPolicies

Visual.AttachedToVisualTree

Visual.DetachedFromVisualTree

StyledElement.DataContextProperty

StyledElement.NameProperty

StyledElement.ParentProperty

StyledElement.TemplatedParentProperty

StyledElement.ThemeProperty

StyledElement.BeginInit()

StyledElement.EndInit()

StyledElement.ApplyStyling()

StyledElement.InitializeIfNeeded()

StyledElement.TryGetResource(object, ThemeVariant, out object)

StyledElement.OnDataContextChanged(EventArgs)

StyledElement.OnDataContextBeginUpdate()

StyledElement.OnDataContextEndUpdate()

StyledElement.OnInitialized()

StyledElement.Name

StyledElement.Classes

StyledElement.DataContext

StyledElement.IsInitialized

StyledElement.Styles

StyledElement.StyleKey

StyledElement.Resources

StyledElement.TemplatedParent

StyledElement.Theme

StyledElement.LogicalChildren

StyledElement.PseudoClasses

StyledElement.StyleKeyOverride

StyledElement.Parent

StyledElement.ActualThemeVariant

StyledElement.AttachedToLogicalTree

StyledElement.DetachedFromLogicalTree

StyledElement.DataContextChanged

StyledElement.Initialized

StyledElement.ResourcesChanged

StyledElement.ActualThemeVariantChanged

Animatable.TransitionsProperty

Animatable.OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)

Animatable.Transitions

AvaloniaObject.CheckAccess()

AvaloniaObject.VerifyAccess()

AvaloniaObject.ClearValue(AvaloniaProperty)

AvaloniaObject.ClearValue<T>(AvaloniaProperty<T>)

AvaloniaObject.ClearValue<T>(StyledProperty<T>)

AvaloniaObject.ClearValue<T>(DirectPropertyBase<T>)

AvaloniaObject.Equals(object)

AvaloniaObject.GetHashCode()

AvaloniaObject.GetValue(AvaloniaProperty)

AvaloniaObject.GetValue<T>(StyledProperty<T>)

AvaloniaObject.GetValue<T>(DirectPropertyBase<T>)

AvaloniaObject.GetBaseValue<T>(StyledProperty<T>)

AvaloniaObject.IsAnimating(AvaloniaProperty)

AvaloniaObject.IsSet(AvaloniaProperty)

AvaloniaObject.SetValue(AvaloniaProperty, object, BindingPriority)

AvaloniaObject.SetValue<T>(StyledProperty<T>, T, BindingPriority)

AvaloniaObject.SetValue<T>(DirectPropertyBase<T>, T)

AvaloniaObject.SetCurrentValue(AvaloniaProperty, object)

AvaloniaObject.SetCurrentValue<T>(StyledProperty<T>, T)

AvaloniaObject.Bind(AvaloniaProperty, BindingBase)

AvaloniaObject.Bind(AvaloniaProperty, IObservable<object>, BindingPriority)

AvaloniaObject.Bind<T>(StyledProperty<T>, IObservable<object>, BindingPriority)

AvaloniaObject.Bind<T>(StyledProperty<T>, IObservable<T>, BindingPriority)

AvaloniaObject.Bind<T>(StyledProperty<T>, IObservable<BindingValue<T>>, BindingPriority)

AvaloniaObject.Bind<T>(DirectPropertyBase<T>, IObservable<object>)

AvaloniaObject.Bind<T>(DirectPropertyBase<T>, IObservable<T>)

AvaloniaObject.Bind<T>(DirectPropertyBase<T>, IObservable<BindingValue<T>>)

AvaloniaObject.CoerceValue(AvaloniaProperty)

AvaloniaObject.RaisePropertyChanged<T>(DirectPropertyBase<T>, T, T)

AvaloniaObject.SetAndRaise<T>(DirectPropertyBase<T>, ref T, T)

AvaloniaObject.InheritanceParent

AvaloniaObject.this[AvaloniaProperty]

AvaloniaObject.this[IndexerDescriptor]

AvaloniaObject.Dispatcher

AvaloniaObject.PropertyChanged

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The Shield control is designed to mimic the style of shields.io badges. It consists of two parts: a subject (left side) and a status (right side), each with distinct background colors.

Fields

IsReadOnlyProperty

Defines the IsReadOnly property.

public static readonly StyledProperty<bool> IsReadOnlyProperty

Field Value

StyledProperty<bool>

StatusProperty

Defines the Status property.

public static readonly StyledProperty<object?> StatusProperty

Field Value

StyledProperty<object>

SubjectBackgroundProperty

Defines the SubjectBackground property.

public static readonly StyledProperty<IBrush?> SubjectBackgroundProperty

Field Value

StyledProperty<IBrush>

SubjectProperty

Defines the Subject property.

public static readonly StyledProperty<object?> SubjectProperty

Field Value

StyledProperty<object>

Properties

IsReadOnly

Gets or sets whether the shield is in read-only (display-only) mode.

public bool IsReadOnly { get; set; }

Property Value

bool

When true, the shield is non-interactive but retains full opacity, unlike the disabled state which fades the control. Use this for informational badges.

Status

Gets or sets the content displayed on the right side of the shield (the status/value).

public object? Status { get; set; }

Property Value

object

The status content, typically a string like "passing", "1.0.0", or "MIT". Can also be any UI element for custom rendering.

Subject

Gets or sets the content displayed on the left side of the shield (the subject/label).

public object? Subject { get; set; }

Property Value

object

The subject content, typically a string like "build", "version", or "license". Can also be any UI element for custom rendering.

SubjectBackground

Gets or sets the background color of the subject (left) part of the shield.

public IBrush? SubjectBackground { get; set; }

Property Value

IBrush

An Avalonia.Media.IBrush used as the background for the subject section. If not set, falls back to the theme-defined ShieldSubjectBackgroundBrush.

Methods

OnCreateAutomationPeer()

Returns a new, type-specific Avalonia.Automation.Peers.AutomationPeer implementation for the control.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

The type-specific Avalonia.Automation.Peers.AutomationPeer implementation.

OnKeyDown(KeyEventArgs)

Invoked when an unhandled Avalonia.Input.InputElement.KeyDownEvent reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

protected override void OnKeyDown(KeyEventArgs e)

Parameters

e KeyEventArgs

Data about the event.

OnPointerPressed(PointerPressedEventArgs)

Invoked when an unhandled Avalonia.Input.InputElement.PointerPressedEvent reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

protected override void OnPointerPressed(PointerPressedEventArgs e)

Parameters

e PointerPressedEventArgs

Data about the event.

OnPropertyChanged(AvaloniaPropertyChangedEventArgs)

Called when a avalonia property changes on the object.

protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs change)

Parameters

change AvaloniaPropertyChangedEventArgs

The property change details.