Skip to content

XUITagCanvasAutocompletePopup

Inherits DesktopTextInputCanvas

Description

The customisable autocomplete popup that appears in the tag canvas when autocomplete options are available.

Properties

Name Type Read-Only
mBuffer Picture
mOwner WeakRef
mScrollPosY Integer
mSelectedIndex Integer
Owner XUITagCanvas
ScrollPosY Integer
SelectedIndex Integer

Methods

Name Parameters Returns
Constructor owner As XUITagCanvas
ScrollToSelectedIndex
Update maxWidth As Integer, maxHeight As Integer

Property Descriptions

mBuffer As Picture

The picture that represents the popup. Drawn in the Paint() event.


mOwner As WeakRef

The tag canvas that owns this popup.


mScrollPosY As Integer

The vetical scroll offset. 0 is baseline. Positive indicates scrolling down. Backs the ScrollPosY computed property.


mSelectedIndex As Integer

0-based index of the currently selected option in the popup.


Owner As XUITagCanvas

The tag canvas that owns this popup.


ScrollPosY As Integer

The vertical scroll offset. 0 is baseline. Positive indicates scrolling down. Refreshes the popup.


SelectedIndex As Integer

0-based index of the currently selected option in the popup.


Method Descriptions

Constructor(owner As XUITagCanvas)

owner is the XUITagCanvas that owns this popup. A new WeakRef to it will be created.


ScrollToSelectedIndex()

Scrolls the popup to wholly display the selected index if it is not already. Refreshes the canvas.

Assumes SelectedIndex is valid.


Update(maxWidth As Integer, maxHeight As Integer)

Resizes and redraws this autocomplete popup using the autocomplete data from its owner.

maxwidth is the maximum permissable width of the popup. maxHeight is the maximum permissable height of the popup.