Sign in Join
FPDoc Onlineexperiment

TToolBar.IsVertical function

Member of TToolBarprotectedIn unit ComCtrls

Indicates if the tool bar is oriented to display buttons and controls vertically.

Declaration

pascal
function IsVertical: Boolean; virtual

Function result

True when the buttons on the control are displayed vertically.

Description

IsVertical is a Boolean function in TToolBar used to determine if the tool bar displays its buttons or controls using a vertical orientation. The return value is determined by the value in the Orientation property, as follows:

tboVertical
The return value is True.
tboHorizontal
The return value is False.
tboAutomatic
Causes the value in Align to be used to determine the result. alNone, alClient, and alCustom return True when the Height for the control is larger than its Width. alLeft or alRight cause the result to be set to True.

If the tool bar is parented by a TCoolBar control, the value in the Vertical property in the parent control is used as the return value.

IsVertical is used in the in the AlignControls and WrapButtons methods when the position and layout for buttons on the control are calculated.

Modified in LCL version 5.0 to use Orientation, or Align when Orientation is tboAutomatic.

See also

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