Represents an abstract base class for a gallery control.
- Inheritance:
- object AvaloniaObject Animatable StyledElement Visual Layoutable Interactive InputElement Control TemplatedControl ItemsControl SelectingItemsControl object
- Derived:
-
Bar
Menu BarGallery Menu Gallery Host Base
- Implements:
- IDataContextProvider ILogical IThemeVariantHost IResourceHost IResourceNode IStyleHost ISetLogicalParent ISetInheritanceParent IStyleable INamed IInputElement IDataTemplateHost ISetterValue IChildIndexProvider ICommandSource
Constructors
BarGalleryBase()
Initializes a new instance of the Bar
Properties
BetweenPreviewDelay
The delay in milliseconds between Previewed
Property Value
- int:
The default value is
0
.
CanCloneToRibbonQuickAccessToolBar
Whether the control can be cloned to the ribbon quick-access toolbar.
Property Value
- bool:
The default value is
true
.
CanStopPreviewingOnMouseLeave
Whether the gallery can stop previewing when the mouse leaves the control.
Property Value
- bool:
true
if the gallery can stop previewing when the mouse leaves the control; otherwise,false
.
Command
The ICommand to execute when a gallery item is selected.
Property Value
CommandParameter
The parameter to be passed to the Command.
Property Value
HighlightedItem
The item that is currently highlighted.
Property Value
InitialPreviewDelay
The delay in milliseconds for preview mode to begin after an item is highlighted.
Property Value
- int:
The default value is
300
.
IsSelectionSupported
Whether selection is supported.
Property Value
- bool:
The default value is
true
.
ItemSpacing
The amount of spacing between items.
Property Value
- double:
The default value is
0
.
Key
A string that uniquely identifies the control.
Property Value
Label
The text label to display.
Property Value
LargeIcon
The object representing a large icon, generally 32x32
size.
Property Value
MediumIcon
The object representing a medium icon, generally 24x24
size.
Property Value
MinItemHeight
The minimum item height.
Property Value
- double:
The default value is
16.0
.
MinItemWidth
The minimum item width.
Property Value
- double:
The default value is
16.0
.
PreviewedItem
The item that is currently being previewed.
Property Value
SmallIcon
The object representing a small icon, generally 16x16
size.
Property Value
Title
The string title, which can override the Label when displayed in screen tips and customization UI.
Property Value
UseAccentedItemBorder
Whether to use an accented item border for gallery items, common when they have vibrant content such as color swatches.
Property Value
- bool:
The default value is
false
.
Methods
ClearContainerForItemOverride(Control)
Undoes the effects of the Prepare
Parameter | Type | Description |
---|---|---|
container | Control | The container element. |
CreateContainerForItemOverride(object?, int, object?)
Creates or a container that can be used to display an item.
NeedsContainerOverride(object?, int, out object?)
Determines whether the specified item can be its own container.
Parameter | Type | Description |
---|---|---|
item | object | The item to check. |
index | int | The index of the item. |
recycleKey | object | When the method returns, contains a key that can be used to locate a previously
recycled container of the correct type, or null if the item cannot be recycled.
If the item is its own container then by definition it cannot be recycled, so
|
Returns
- bool:
true if the item needs a container; otherwise false if the item can itself be used as a container.
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)
Called when the styled element is added to a rooted logical tree.
Parameter | Type | Description |
---|---|---|
e | LogicalTreeAttachmentEventArgs | The event args. |
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)
Called when the styled element is removed from a rooted logical tree.
Parameter | Type | Description |
---|---|---|
e | LogicalTreeAttachmentEventArgs | The event args. |
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)
Called when the control is removed from a rooted visual tree.
Parameter | Type | Description |
---|---|---|
e | VisualTreeAttachmentEventArgs | The event args. |
OnHighlightedItemChanged()
Invokes the Highlighted
OnIsKeyboardFocusWithinChanged(AvaloniaPropertyChangedEventArgs)
Occurs when the IsKeyboardFocusWithinProperty
property value changes.
Parameter | Type | Description |
---|---|---|
e | AvaloniaPropertyChangedEventArgs | The Avalonia.AvaloniaPropertyChangedEventArgs containing data related to this event. |
OnItemSpacingPropertyValueChanged(AvaloniaPropertyChangedEventArgs)
Occurs when the Item
Parameter | Type | Description |
---|---|---|
e | AvaloniaPropertyChangedEventArgs | The Avalonia.AvaloniaPropertyChangedEventArgs containing data related to this event. |
OnMinItemHeightPropertyValueChanged(AvaloniaPropertyChangedEventArgs)
Occurs when the Min
Parameter | Type | Description |
---|---|---|
e | AvaloniaPropertyChangedEventArgs | The Avalonia.AvaloniaPropertyChangedEventArgs containing data related to this event. |
OnMinItemWidthPropertyValueChanged(AvaloniaPropertyChangedEventArgs)
Occurs when the Min
Parameter | Type | Description |
---|---|---|
e | AvaloniaPropertyChangedEventArgs | The Avalonia.AvaloniaPropertyChangedEventArgs containing data related to this event. |
OnPointerExited(PointerEventArgs)
Called before the Avalonia.Input.InputElement.PointerExited event occurs.
Parameter | Type | Description |
---|---|---|
e | PointerEventArgs | The event args. |
OnPointerMoved(PointerEventArgs)
Called before the Avalonia.Input.InputElement.PointerMoved event occurs.
Parameter | Type | Description |
---|---|---|
e | PointerEventArgs | The event args. |
PrepareContainerForItemOverride(Control, object?, int)
Prepares the specified element to display the specified item.
Parameter | Type | Description |
---|---|---|
container | Control | The element that's used to display the specified item. |
item | object | The item to display. |
index | int | The index of the item to display. |
ScrollToSelectedItem(bool)
Scrolls the gallery to the selected item.
Parameter | Type | Description |
---|---|---|
canFocus | bool | Whether to also focus the selected gallery item. |
ToString()
Returns the string representation of this object.
Returns
- string:
The string representation of this object.
Events
HighlightedItemChanged
Occurs when the Highlighted
Event Type
- Event
Handler <RoutedEventArgs>
Fields
BetweenPreviewDelayProperty
Defines the Between
CanCloneToRibbonQuickAccessToolBarProperty
Defines the Can
CommandParameterProperty
Defines the Command
CommandProperty
Defines the Command property.
HighlightedItemChangedEvent
Defines the Highlighted
HighlightedItemProperty
Defines the Highlighted
InitialPreviewDelayProperty
Defines the Initial
IsSelectionSupportedProperty
Defines the Is
ItemContainerTemplateSelectorProperty
Defines the ItemContainerTemplateSelector
property.
ItemSpacingProperty
Defines the Item
KeyProperty
Defines the Key property.
LabelProperty
Defines the Label property.
LargeIconProperty
Defines the Large
MediumIconProperty
Defines the Medium
MinItemHeightProperty
Defines the Min
MinItemWidthProperty
Defines the Min
PreviewedItemProperty
Defines the Previewed
SmallIconProperty
Defines the Small
TitleProperty
Defines the Title property.
UseAccentedItemBorderProperty
Defines the Use
Inherited Members
- SelectingItemsControl.AutoScrollToSelectedItemProperty
- SelectingItemsControl.SelectedIndexProperty
- SelectingItemsControl.SelectedItemProperty
- SelectingItemsControl.SelectedValueProperty
- SelectingItemsControl.SelectedValueBindingProperty
- SelectingItemsControl.SelectedItemsProperty
- SelectingItemsControl.SelectionProperty
- SelectingItemsControl.SelectionModeProperty
- SelectingItemsControl.IsSelectedProperty
- SelectingItemsControl.IsTextSearchEnabledProperty
- SelectingItemsControl.IsSelectedChangedEvent
- SelectingItemsControl.SelectionChangedEvent
- SelectingItemsControl.WrapSelectionProperty
- SelectingItemsControl.BeginInit()
- SelectingItemsControl.EndInit()
- SelectingItemsControl.GetIsSelected(Control)
-
Selecting
Items Control. Set Is Selected(Control, bool) -
Selecting
Items Control. Get Container From Event Source(object) - SelectingItemsControl.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)
- SelectingItemsControl.OnApplyTemplate(TemplateAppliedEventArgs)
-
Selecting
Items Control. Container For Item Prepared Override(Control, object, int) -
Selecting
Items Control. Container Index Changed Override(Control, int, int) - SelectingItemsControl.OnDataContextBeginUpdate()
- SelectingItemsControl.OnDataContextEndUpdate()
-
Selecting
Items Control. Update Data Validation(Avalonia Property, Binding Value Type, Exception) - SelectingItemsControl.OnInitialized()
- SelectingItemsControl.OnTextInput(TextInputEventArgs)
- SelectingItemsControl.OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
-
Selecting
Items Control. Move Selection(Navigation Direction, bool, bool) -
Selecting
Items Control. Move Selection(Control, Navigation Direction, bool, bool) -
Selecting
Items Control. Update Selection(int, bool, bool, bool, bool, bool) -
Selecting
Items Control. Update Selection(Control, bool, bool, bool, bool, bool) -
Selecting
Items Control. Update Selection From Event Source(object, bool, bool, bool, bool, bool) - SelectingItemsControl.AutoScrollToSelectedItem
- SelectingItemsControl.SelectedIndex
- SelectingItemsControl.SelectedItem
- SelectingItemsControl.SelectedValueBinding
- SelectingItemsControl.SelectedValue
- SelectingItemsControl.SelectedItems
- SelectingItemsControl.Selection
- SelectingItemsControl.IsTextSearchEnabled
- SelectingItemsControl.WrapSelection
- SelectingItemsControl.SelectionMode
- SelectingItemsControl.AlwaysSelected
- SelectingItemsControl.SelectionChanged
- ItemsControl.ItemContainerThemeProperty
- ItemsControl.ItemCountProperty
- ItemsControl.ItemsPanelProperty
- ItemsControl.ItemsSourceProperty
- ItemsControl.ItemTemplateProperty
- ItemsControl.DisplayMemberBindingProperty
-
Items
Control. Container From Index(int) -
Items
Control. Container From Item(object) - ItemsControl.IndexFromContainer(Control)
- ItemsControl.ItemFromContainer(Control)
- ItemsControl.GetRealizedContainers()
-
Items
Control. Scroll Into View(int) -
Items
Control. Scroll Into View(object) - ItemsControl.ItemsControlFromItemContainer(Control)
- ItemsControl.NeedsContainer<T>(object, out object)
- ItemsControl.OnGotFocus(GotFocusEventArgs)
- ItemsControl.OnKeyDown(KeyEventArgs)
- ItemsControl.OnCreateAutomationPeer()
- ItemsControl.RefreshContainers()
-
Items
Control. Get Next Control(INavigable Container, Navigation Direction, IInput Element, bool) - ItemsControl.DisplayMemberBinding
- ItemsControl.ItemContainerGenerator
- ItemsControl.Items
- ItemsControl.ItemContainerTheme
- ItemsControl.ItemCount
- ItemsControl.ItemsPanel
- ItemsControl.ItemsSource
- ItemsControl.ItemTemplate
- ItemsControl.Presenter
- ItemsControl.ItemsPanelRoot
- ItemsControl.ItemsView
- ItemsControl.DefaultRecycleKey
- ItemsControl.PreparingContainer
- ItemsControl.ContainerPrepared
- ItemsControl.ContainerIndexChanged
- ItemsControl.ContainerClearing
- 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.PaddingProperty
- TemplatedControl.TemplateProperty
- TemplatedControl.IsTemplateFocusTargetProperty
- TemplatedControl.TemplateAppliedEvent
- TemplatedControl.GetIsTemplateFocusTarget(Control)
-
Templated
Control. Set Is Template Focus Target(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.Padding
- TemplatedControl.Template
- TemplatedControl.TemplateApplied
- Control.FocusAdornerProperty
- Control.TagProperty
- Control.ContextMenuProperty
- Control.ContextFlyoutProperty
- Control.RequestBringIntoViewEvent
- Control.ContextRequestedEvent
- Control.LoadedEvent
- Control.UnloadedEvent
- Control.SizeChangedEvent
- Control.OnLoaded(RoutedEventArgs)
- Control.OnUnloaded(RoutedEventArgs)
- Control.OnSizeChanged(SizeChangedEventArgs)
- Control.OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)
- Control.OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)
- Control.OnLostFocus(RoutedEventArgs)
- Control.OnPointerReleased(PointerReleasedEventArgs)
- Control.OnKeyUp(KeyEventArgs)
- Control.FocusAdorner
- Control.DataTemplates
- Control.ContextMenu
- Control.ContextFlyout
- Control.IsLoaded
- Control.Tag
- Control.ContextRequested
- 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.LostFocusEvent
- 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.TappedEvent
- InputElement.HoldingEvent
- InputElement.DoubleTappedEvent
- InputElement.Focus(NavigationMethod, KeyModifiers)
- InputElement.OnAccessKey(RoutedEventArgs)
- InputElement.OnPointerEntered(PointerEventArgs)
- InputElement.OnPointerPressed(PointerPressedEventArgs)
- InputElement.OnPointerCaptureLost(PointerCaptureLostEventArgs)
- InputElement.OnPointerWheelChanged(PointerWheelEventArgs)
- InputElement.UpdateIsEffectivelyEnabled()
- InputElement.Focusable
- InputElement.IsEnabled
- InputElement.Cursor
- InputElement.IsKeyboardFocusWithin
- InputElement.IsFocused
- InputElement.IsHitTestVisible
- InputElement.IsPointerOver
- InputElement.IsTabStop
- InputElement.IsEffectivelyEnabled
- InputElement.TabIndex
- InputElement.KeyBindings
- InputElement.IsEnabledCore
- InputElement.GestureRecognizers
- InputElement.GotFocus
- InputElement.LostFocus
- InputElement.KeyDown
- InputElement.KeyUp
- InputElement.TextInput
- InputElement.TextInputMethodClientRequested
- InputElement.PointerEntered
- InputElement.PointerExited
- InputElement.PointerMoved
- InputElement.PointerPressed
- InputElement.PointerReleased
- InputElement.PointerCaptureLost
- InputElement.PointerWheelChanged
- InputElement.Tapped
- InputElement.Holding
- InputElement.DoubleTapped
-
Interactive.
Add Handler(Routed Event, Delegate, Routing Strategies, bool) - Interactive.AddHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool)
-
Interactive.
Remove Handler(Routed Event, 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.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.
Logical Children Collection Changed(object, Notify Collection Changed Event Args) - Visual.InvalidateMirrorTransform()
- Visual.Bounds
- Visual.ClipToBounds
- Visual.Clip
- Visual.IsEffectivelyVisible
- Visual.IsVisible
- Visual.Opacity
- Visual.OpacityMask
- 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.ApplyStyling()
- StyledElement.InitializeIfNeeded()
-
Styled
Element. Try Get Resource(object, Theme Variant, out object) -
Styled
Element. On Data Context Changed(Event Args) - 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>)
-
Avalonia
Object. 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)
-
Avalonia
Object. Set Value(Avalonia Property, object, Binding Priority) - AvaloniaObject.SetValue<T>(StyledProperty<T>, T, BindingPriority)
- AvaloniaObject.SetValue<T>(DirectPropertyBase<T>, T)
-
Avalonia
Object. Set Current Value(Avalonia Property, object) - AvaloniaObject.SetCurrentValue<T>(StyledProperty<T>, T)
- AvaloniaObject.Bind(AvaloniaProperty, IBinding)
- 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.PropertyChanged
-
object.
Get Type() -
object.
Memberwise Clone() -
object.
Equals(object, object) -
object.
Reference Equals(object, object)