Sign in Join
FPDoc Onlineexperiment

TCustomListBox.ItemFullyVisible function

Member of TCustomListBoxpublicIn unit StdCtrls

Returns True if the item is fully visible in the scrollable list.

Declaration

pascal
function ItemFullyVisible(Index: Integer): Boolean

Arguments

Index

Ordinal position for the item examined in the method.

Function result

True when the specified item is fully visible in the list box control.

Description

ItemFullyVisible is a Boolean function used to determine the item at the position in Index is fully visible in the list box control. The return value is False under the following conditions:

  • Index is out of range for the values in Items.
  • An item rectangle could not be retrieved from the widgetset class.
  • The item rectangle is invalid or obscured in the control (where Top < 0 or Bottom > ClientHeight).

Use ItemVisible to determine if the specified item is at least partially visible in the list box control.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.