Table of Contents

Class RDFormsListBox

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

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

public sealed class RDFormsListBox : ListBox, 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
ListBox
RDFormsListBox
Implements
IDataContextProvider
ILogical
IThemeVariantHost
IResourceHost
IResourceNode
IStyleHost
ISetLogicalParent
ISetInheritanceParent
INamed
IInputElement
IDataTemplateHost
ISetterValue
IChildIndexProvider
Inherited Members
ListBox.ScrollProperty
ListBox.SelectedItemsProperty
ListBox.SelectionProperty
ListBox.SelectionModeProperty
ListBox.SelectAll()
ListBox.UnselectAll()
ListBox.Scroll
ListBox.SelectedItems
ListBox.Selection
ListBox.SelectionMode
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.UpdateSelectionFromEvent(Control, RoutedEventArgs)
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. AddItem(string, int?), RemoveItem(int) and Clear() change it, keep its ItemData and ItemIcon in step, and keep the selection on the items that stay. An added item's data is 0.

An item's icon, its ItemIcon, is drawn before its text, 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 metafile icon is not drawn. Item icons are an RD-VBA addition.

Its Click comes from two places, as measured with VB6. A left press on an item raises Click at its release, before MouseUp, whether or not the selection changed and wherever the release lands; the press selects at once, and the selection follows the pointer over the items while the button is held. A left press below the items, and any right or middle press, selects nothing and raises no Click. A key or code that moves the selection raises Click, with ListIndex already the new value; setting it again, a key that can go no further, and a change to the items raise none.

With a MultiSelect of Simple or Extended, ListIndex is the item with the focus, 0 from the start, and the selection is a set of items apart from it. Simple toggles the item pressed, whatever the modifiers; its arrow keys move only the focus, and Space toggles. Extended selects the item pressed alone, toggles it with Ctrl, and with Shift selects from the anchor, the last item pressed or reached without Shift. A drag moves the focus, and on an Extended list selects from the anchor too. Every key such a list takes raises Click, whether or not anything changed.

It raises DblClick, GotFocus, LostFocus, KeyDown, KeyPress, KeyUp, MouseDown, MouseMove and MouseUp. A key's Click comes after its KeyDown, and its KeyPress where it types a character, and before its KeyUp. Where its MultiSelect is None, a character typed selects the next item that starts with it, after the selected one and from the top again past the last, compared without regard to case, and raises Click where the selection moved.

Its rows are a line of its font high, inside a border of 2 pixels on each side. Where IntegralHeight is True, its height is snapped to whole rows, at least one, as measured with VB6.

Constructors

RDFormsListBox(ComponentInstance)

Creates a list that shows a ListBox.

public RDFormsListBox(ComponentInstance instance)

Parameters

instance ComponentInstance

The ListBox.

Remarks

It follows its MultiSelect set later, from code, as a list made with the new value: it keeps its items, and the item at ListIndex stays selected where it was. To None, no other item stays selected; to Simple or Extended from None, the selected item takes the focus, the first item where none is selected.

Exceptions

ArgumentNullException

instance is null.

ArgumentException

instance is not a ListBox.

Properties

ListCount

The number of items.

public int ListCount { get; }

Property Value

int

ListIndex

The selected item, or on a multi-select list the focused one; -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 is set again. On a multi-select list it moves the focus, and selects and clears nothing.

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

SelCount

The number of items selected.

public int SelCount { get; }

Property Value

int

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 text of the item at ListIndex, or "" where there is none.

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.

public void Clear()

CreateContainerForItemOverride(object?, int, object?)

Creates or a container that can be used to display an item.

protected override Control CreateContainerForItemOverride(object? item, int index, object? recycleKey)

Parameters

item object
index int
recycleKey object

Returns

Control

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.

GetSelected(int)

Gets whether an item is selected.

public bool GetSelected(int index)

Parameters

index int

The item's index, from 0.

Returns

bool

Whether it is selected.

Exceptions

FormErrorException

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

OnKeyDown(KeyEventArgs)

Handles directional navigation within the Avalonia.Controls.ItemsControl.

protected override void OnKeyDown(KeyEventArgs e)

Parameters

e KeyEventArgs

The key events.

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 list raises nothing.

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.

SetSelected(int, bool)

Selects or clears an item, and raises Click when that changes something.

public void SetSelected(int index, bool selected)

Parameters

index int

The item's index, from 0.

selected bool

Whether to select it.

Remarks

On a single-select list it moves the selection. On a multi-select one, selecting an item adds it and moves the focus to it, and clearing it removes it and leaves the focus.

Exceptions

FormErrorException

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

SetText(string)

Selects the first item whose whole text is text, without regard to case, or none, and raises Click even when the selection does not move. On a multi-select list it raises Click and changes nothing.

public void SetText(string text)

Parameters

text string

The text.