Table of Contents

Class RDFormsComboBox

Namespace
RDCore.Forms.Avalonia.Controls
Assembly
RDCore.Forms.Avalonia.dll

A VB ComboBox: a Avalonia.Controls.ComboBox that shows a ComboBox component.

public sealed class RDFormsComboBox : ComboBox, INotifyPropertyChanged, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, INamed, IInputElement, IDataTemplateHost, ISetterValue, IChildIndexProvider
Inheritance
AvaloniaObject
Animatable
StyledElement
Visual
Layoutable
Interactive
InputElement
Control
TemplatedControl
ItemsControl
SelectingItemsControl
ComboBox
RDFormsComboBox
Implements
IDataContextProvider
ILogical
IThemeVariantHost
IResourceHost
IResourceNode
IStyleHost
ISetLogicalParent
ISetInheritanceParent
INamed
IInputElement
IDataTemplateHost
ISetterValue
IChildIndexProvider
Inherited Members
ComboBox.IsDropDownOpenProperty
ComboBox.IsEditableProperty
ComboBox.MaxDropDownHeightProperty
ComboBox.SelectionBoxItemProperty
ComboBox.PlaceholderTextProperty
ComboBox.PlaceholderForegroundProperty
ComboBox.HorizontalContentAlignmentProperty
ComboBox.VerticalContentAlignmentProperty
ComboBox.TextProperty
ComboBox.SelectionBoxItemTemplateProperty
ComboBox.IsDropDownOpen
ComboBox.IsEditable
ComboBox.MaxDropDownHeight
ComboBox.SelectionBoxItem
ComboBox.PlaceholderText
ComboBox.PlaceholderForeground
ComboBox.HorizontalContentAlignment
ComboBox.VerticalContentAlignment
ComboBox.SelectionBoxItemTemplate
ComboBox.DropDownClosed
ComboBox.DropDownOpened
SelectingItemsControl.AutoScrollToSelectedItemProperty
SelectingItemsControl.SelectedIndexProperty
SelectingItemsControl.SelectedItemProperty
SelectingItemsControl.SelectedValueProperty
SelectingItemsControl.SelectedValueBindingProperty
SelectingItemsControl.IsSelectedProperty
SelectingItemsControl.IsTextSearchEnabledProperty
SelectingItemsControl.IsSelectedChangedEvent
SelectingItemsControl.SelectionChangedEvent
SelectingItemsControl.WrapSelectionProperty
SelectingItemsControl.BeginInit()
SelectingItemsControl.EndInit()
SelectingItemsControl.GetIsSelected(Control)
SelectingItemsControl.ItemsControlFromItemContainer(Control)
SelectingItemsControl.AutoScrollToSelectedItem
SelectingItemsControl.SelectedIndex
SelectingItemsControl.SelectedItem
SelectingItemsControl.SelectedValueBinding
SelectingItemsControl.SelectedValue
SelectingItemsControl.IsTextSearchEnabled
SelectingItemsControl.WrapSelection
SelectingItemsControl.SelectionChanged
ItemsControl.ItemContainerThemeProperty
ItemsControl.ItemCountProperty
ItemsControl.ItemsPanelProperty
ItemsControl.ItemsSourceProperty
ItemsControl.ItemTemplateProperty
ItemsControl.DisplayMemberBindingProperty
ItemsControl.IndexFromContainer(Control)
ItemsControl.ItemFromContainer(Control)
ItemsControl.GetRealizedContainers()
ItemsControl.DisplayMemberBinding
ItemsControl.ItemContainerGenerator
ItemsControl.Items
ItemsControl.ItemContainerTheme
ItemsControl.ItemCount
ItemsControl.ItemsPanel
ItemsControl.ItemsSource
ItemsControl.ItemTemplate
ItemsControl.Presenter
ItemsControl.ItemsPanelRoot
ItemsControl.ItemsView
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.LetterSpacingProperty
TemplatedControl.PaddingProperty
TemplatedControl.TemplateProperty
TemplatedControl.IsTemplateFocusTargetProperty
TemplatedControl.TemplateAppliedEvent
TemplatedControl.GetIsTemplateFocusTarget(Control)
TemplatedControl.ApplyTemplate()
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.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.GetIsHoldingEnabled(StyledElement)
InputElement.GetIsHoldWithMouseEnabled(StyledElement)
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.RaiseEvent(RoutedEventArgs)
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.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.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.AttachedToVisualTree
Visual.DetachedFromVisualTree
StyledElement.DataContextProperty
StyledElement.NameProperty
StyledElement.ParentProperty
StyledElement.TemplatedParentProperty
StyledElement.ThemeProperty
StyledElement.ApplyStyling()
StyledElement.Name
StyledElement.Classes
StyledElement.DataContext
StyledElement.IsInitialized
StyledElement.Styles
StyledElement.StyleKey
StyledElement.Resources
StyledElement.TemplatedParent
StyledElement.Theme
StyledElement.Parent
StyledElement.ActualThemeVariant
StyledElement.AttachedToLogicalTree
StyledElement.DetachedFromLogicalTree
StyledElement.DataContextChanged
StyledElement.Initialized
StyledElement.ResourcesChanged
StyledElement.ActualThemeVariantChanged
Animatable.TransitionsProperty
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.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<T>(StyledProperty<T>, T, BindingPriority)
AvaloniaObject.SetValue<T>(DirectPropertyBase<T>, T)
AvaloniaObject.SetCurrentValue<T>(StyledProperty<T>, T)
AvaloniaObject.Bind(AvaloniaProperty, BindingBase)
AvaloniaObject.CoerceValue(AvaloniaProperty)
AvaloniaObject.this[AvaloniaProperty]
AvaloniaObject.this[IndexerDescriptor]
AvaloniaObject.Dispatcher
AvaloniaObject.PropertyChanged

Remarks

Its items are the component's List. At a Style of Dropdown Combo, the component's Text is the edit box's: typing sets it, code's Text selects no item, and choosing an item puts its text in the box. At Dropdown List it has no edit box, and Text is its selected item's.

Its events, as measured with VB6: Click is a choice, raised for every pick of an item by the mouse (the one already selected too), every arrow key that moves the selection with the list open or closed, a Dropdown List's character that selects another item, and code's ListIndex when it moves. Change is the edit box's, raised from the component's Text, from typing and from code, never from choosing an item. DropDown is raised as the list opens. It raises GotFocus and LostFocus once as the combo is entered and left, whether the combo or its edit box has the focus. KeyDown, KeyPress and KeyUp are raised for the keys of the combo, of its edit box and of its open list, and the form raises none of its own for them where its KeyPreview is False. A key's Click, Change or DropDown comes after its KeyDown, and its KeyPress where it types a character, and before its KeyUp.

AddItem(string, int?), RemoveItem(int) and Clear() keep the component's ItemData and ItemIcon in step with its items. An added item's data is 0.

An item's icon, its ItemIcon, is drawn before its text in the list, scaled to fit a square as tall as the text. Where any item has one, every item's text starts after that square, so that the text lines up. A Dropdown List draws its selected item's icon in its box too; a Dropdown Combo's edit box shows text only. A metafile icon is not drawn. Item icons are an RD-VBA addition.

Typing completes an item's text as RD-VBA's code completion completes a name (an RD-VBA addition): an item whose text starts with what is typed matches first, then one whose humps it matches (MP matches MultiPlayer), without regard to case. A Dropdown List adds up the characters typed into a word while an item matches it, and selects the best match; a character that no item matches with the word starts a new one, which selects the next item it matches after the selected one. A Dropdown Combo's typing opens its list and shows only the items its text matches, best first and highlighted: Up and Down move the highlight, and Enter chooses the highlighted item, as a click on an item does. The text stays what was typed until an item is chosen, and the list closes where no item matches.

A Simple Combo shows its edit box with its list always shown under it and no button; the list takes the rest of its height, and scrolls where its items do not fit. Its rows are a line of its font high, and its edit box a row and 8 pixels: 13 and 21 at the default font. Where IntegralHeight is True, its height is snapped to whole rows of its list, or to the edit box alone where no row fits; a height from code of the edit box's or less is ignored. A press on the list picks the item under it, or the last item when the press is below the items, even the item already selected; a pick raises Click and no Change, and leaves the focus in the edit box. A press that moves the focus selects the item before the focus moves, and the text follows before the Click. A double click is one Click, then DblClick. Its list never drops, and it raises no DropDown. Typing does not complete or filter.

A Locked combo keeps out the user, not code: its edit box takes no typing, its list does not drop, and neither the keys nor the pointer pick an item. Its key events are raised. Code's Text and ListIndex still set it.

Constructors

RDFormsComboBox(ComponentInstance)

Creates a combo that shows a ComboBox.

public RDFormsComboBox(ComponentInstance instance)

Parameters

instance ComponentInstance

The ComboBox.

Remarks

It follows its Style set later, from code, as a combo made with the new value: it keeps its items and its selection, and its text where it has an edit box before and after. A Dropdown List's edit box, where it gains one, takes the selected item's text, or "" with none. Changing the Style raises no event.

Exceptions

ArgumentNullException

instance is null.

ArgumentException

instance is not a ComboBox.

Properties

ListCount

The number of items.

public int ListCount { get; }

Property Value

int

ListIndex

The selected item; -1 for none.

public int ListIndex { get; set; }

Property Value

int

Remarks

Setting it raises Click when it moves the selection, and none when it does not.

Exceptions

FormErrorException

Set outside -1 to ListCount - 1: 380, Invalid property value.

NewIndex

The index of the item the last AddItem(string, int?) added; -1 where none was added, and after a RemoveItem(int), a Clear() or a new List of the component.

public int NewIndex { get; }

Property Value

int

SelLength

The component's SelLength: the number of characters selected in the edit box, from SelStart.

public int SelLength { get; set; }

Property Value

int

Remarks

As a single-line TextBox's SelLength.

Exceptions

FormErrorException

Set below 0 or above 65535, or read or set on a Dropdown List: 380, Invalid property value.

SelStart

The component's SelStart: where the edit box's selection starts, or its caret's place where nothing is selected; 0 is before the first character.

public int SelStart { get; set; }

Property Value

int

Remarks

As a single-line TextBox's SelStart. A text from code, or an item chosen with ListIndex, leaves nothing selected, the caret before the first character.

Exceptions

FormErrorException

Set below 0 or above 65535, or read or set on a Dropdown List, which has no edit box: 380, Invalid property value.

SelText

The component's SelText: the text selected in the edit box; "" where nothing is selected.

public string SelText { get; set; }

Property Value

string

Remarks

As a single-line TextBox's SelText: setting it puts the text in place of the selection, the caret after it, and raises Change once, even where the text does not change. Where an item is selected, it selects none, ListIndex -1.

Exceptions

ArgumentNullException

Set to null.

FormErrorException

Read or set on a Dropdown List: 380, Invalid property value.

StyleKeyOverride

Gets the type by which the element is styled.

protected override Type StyleKeyOverride { get; }

Property Value

Type

Remarks

Usually controls are styled by their own type, but there are instances where you want an element to be styled by its base type, e.g. creating SpecialButton that derives from Button and adds extra functionality but is still styled as a regular Button. Override this property to change the style for a control class, returning the type that you wish the elements to be styled as.

Text

The combo's text: a Dropdown List's selected item, or "" with none; the edit box's otherwise.

public string Text { get; }

Property Value

string

Methods

AddItem(string, int?)

Adds an item.

public void AddItem(string item, int? index = null)

Parameters

item string

The item's text.

index int?

Where it goes, from 0; at the end where it is null.

Exceptions

FormErrorException

index is outside 0 to ListCount: 5, Invalid procedure call or argument.

Clear()

Removes every item, as VB's Clear does.

public void Clear()

GetItemData(int)

Gets an item's data, the Long value attached to it.

public int GetItemData(int index)

Parameters

index int

The item's index, from 0.

Returns

int

The item's data.

Exceptions

FormErrorException

index is outside the items: 381, Invalid property array index.

GetItemIcon(int)

Gets an item's icon, the picture drawn before its text. Item icons are an RD-VBA addition.

public byte[]? GetItemIcon(int index)

Parameters

index int

The item's index, from 0.

Returns

byte[]

The picture, as the bytes of its file, or null where the item has none.

Exceptions

FormErrorException

index is outside the items: 381, Invalid property array index.

GetList(int)

Gets an item's text, as code's List(Index) does.

public string GetList(int index)

Parameters

index int

The item's index, from 0.

Returns

string

The item's text, or "" for an index outside the items.

OnApplyTemplate(TemplateAppliedEventArgs)

Called when the control's template is applied. In simple terms, this means the method is called just before the control is displayed.

protected override void OnApplyTemplate(TemplateAppliedEventArgs e)

Parameters

e TemplateAppliedEventArgs

The event args.

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.

OnPropertyChanged(AvaloniaPropertyChangedEventArgs)

Called when a avalonia property changes on the object.

protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs change)

Parameters

change AvaloniaPropertyChangedEventArgs

The property change details.

OnTextInput(TextInputEventArgs)

Invoked when an unhandled Avalonia.Input.InputElement.TextInputEvent 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 OnTextInput(TextInputEventArgs e)

Parameters

e TextInputEventArgs

Data about the event.

PrepareContainerForItemOverride(Control, object?, int)

Prepares the specified element to display the specified item.

protected override void PrepareContainerForItemOverride(Control container, object? item, int index)

Parameters

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.

RemoveItem(int)

Removes an item.

public void RemoveItem(int index)

Parameters

index int

The item's index, from 0.

Exceptions

FormErrorException

index is outside the items: 5, Invalid procedure call or argument.

SetItemData(int, int)

Sets an item's data, the Long value attached to it.

public void SetItemData(int index, int value)

Parameters

index int

The item's index, from 0.

value int

The value.

Exceptions

FormErrorException

index is outside the items: 381, Invalid property array index.

SetItemIcon(int, byte[]?)

Sets an item's icon, the picture drawn before its text. Item icons are an RD-VBA addition.

public void SetItemIcon(int index, byte[]? picture)

Parameters

index int

The item's index, from 0.

picture byte[]

The picture, as the bytes of its file; null or no bytes for none.

Exceptions

FormErrorException

index is outside the items: 381, Invalid property array index. picture is refused by Inspect(byte[]?, out PictureInfo): 481, Invalid picture.

SetList(int, string)

Sets an item's text, as code's List(Index) = text does. The item keeps its data, its icon and its selection, and the combo raises nothing. Where the item is the selected one, the combo's Text is the new text: a Dropdown List's, and the edit box's, as choosing the item puts its text there. Another item's leaves the edit box as it is.

public void SetList(int index, string text)

Parameters

index int

The item's index, from 0.

text string

The text.

Exceptions

FormErrorException

index is outside the items: 381, Invalid property array index.

SetText(string)

Sets the combo's text, as code's Text does.

public void SetText(string text)

Parameters

text string

The text.

Remarks

On a Dropdown List it selects the first item whose whole text it is, without regard to case, and raises Click every time, even where that item is selected already. Otherwise the component's Text takes it, the selection clears even where it is an item's text, and Change is raised, once; nothing happens where it is the text already, compared exactly.

Exceptions

FormErrorException

On a Dropdown List, no item's whole text is text: 383, with VB's description "'Text' property is read-only".

UpdateSelectionFromEvent(Control, RoutedEventArgs)

Updates the selection based on an event that may have originated in a container that belongs to the control.

public override bool UpdateSelectionFromEvent(Control container, RoutedEventArgs eventArgs)

Parameters

container Control
eventArgs RoutedEventArgs

Returns

bool

True if the event was accepted and handled, otherwise false.

See Also
ShouldTriggerSelection(Visual, PointerEventArgs)
ShouldTriggerSelection(Visual, KeyEventArgs)