PPListBox

Inheritance Hierarchy

          IComponent

          IControl

          IListBox

          PPListBox

Description

The PPListBox component is identical to the ListBox component that has its own style similar to that of Foresight Analytics Platform.

Comments

Unlike ListBox, style of the PPListBox component does not depend on style and settings of the operating system. Functional settings and features of the PPListBox and ListBox components are the same.

Example

Properties of the PPListBox Component

  Property name Brief description

Align

The Align property determines behavior of the component when its parent component is resized.

AllowDrag

The AllowDrag property determines whether an object can be dragged from the component.

AllowDrop

The AllowDrop property determines whether the component can accept a dragged object.

Anchors

The Anchors property returns settings that determine the percentage of the size change for the current component when the parent component is resized.

BorderStyle

The BorderStyle property determines the look (style) of the component border.

Brush

The Brush property determines the brush that is used to fill component area.

ClientHeight

The ClientHeight property is used to receive or specify the height of the component’s client area.

ClientWidth

The ClientWidth property is used to receive or specify the width of the component’s client area.

Color

The Color property determines a component background color.

Columns

The Columns property determines the number of columns, in which the elements (lines) of the list are displayed.

ComponentCount

The ComponentCount property returns the number of child components.

Components

The Components property returns the child component.

Cursor

The Cursor property determines the look of the cursor over the component.

Data

The Data property is used to store any custom data.

Enabled

The Enabled property determines whether the component is available for the user.

Focused

The Focused property returns True if the focus is set on the component.

Font

The Font property determines the set of characteristics describing the font that is used to display text.

Height

The Height property determines component height.

HelpContext

The HelpContext property determines a unique index for the context help section for this component.

Hint

The Hint property determines a component tooltip text.

IntegralHeight

The IntegralHeight property determines whether a list element, which does not fit into the component window, should be displayed by adjusting the component height.

ItemHeight

The ItemHeight property determines the height of the elements (lines) of the list.

ItemIndex

The ItemIndex property determines index of the selected component element.

Items

The Items property determines the list of component lines.

Left

The Left property determines the coordinate of the left border of the component.

MultiSelect

The MultiSelect property determines whether multiple selection of elements (lines) from the list is available.

Name

The Name property determines a component name.

Parent

The Parent property determines a parent component.

ParentColor

The ParentColor property determines whether the component inherits the color of the parent component.

ParentFont

The ParentFont property determines whether the component uses the font of the parent component.

ParentShowHint

The ParentShowHint property determines whether a tooltip is displayed.

PopupMenu

The PopupMenu property determines the context menu opened by clicking the component with the additional mouse button.

Scrolls

The Scrolls property returns parameters of component's scrollbars.

SelCount

The SelCount property returns the number of selected elements.

Selected

The Selected property returns whether the specified element has a selection.

ShowHint

The ShowHint property enables and disables showing a component tooltip.

Sorted

The Sorted property determines whether the elements (lines) of the list must be automatically sorted in alphabetical order.

TabOrder

The TabOrder property determines the component position in the tab order.

TabStop

The TabStop property determines whether the component is focused when the TAB key is pressed.

TabWidth

The TabWidth property determines the width of the tabulation symbol.

Tag

The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as he wishes.

Text

The Text property determines the row identifying the component for the user.

Top

The Top property determines the coordinate of the top border of the component.

TopIndex

The TopIndex property determines the index of the first visible row in the component.

Visible

The Visible property determines visibility of the component during execution.

Width

The Width property determines component width.

Methods of the PPListBox Component

  Method name Brief description

BringToFront

The BringToFront method brings a component to front.

ClientToScreen

The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system into screen coordinates.

DoDragDrop

The DoDragDrop method enables the user to start dragging operation.

GetImage

The GetImage method returns the image of the component with all the child components.

ScreenToClient

The ScreenToClient method converts screen coordinates of a point into coordinates specified relative to the component coordinate system.

SendToBack

The SendToBack method sends a component to back.

SetFocus

The SetFocus method sets focus to this component.

Events of the PPListBox Component

  Event name Brief description

OnBeginDrag

The OnBeginDrag event occurs for a component when the user starts to drag an object from the component.

OnChange

The OnChange event occurs if the last selected element is changed in the component.

OnClick

The OnClick event occurs if the user clicks the component area.

OnDblClick

The OnDblClick event occurs if the user double-clicks the component area.

OnDragDrop

The OnDragDrop event occurs for the component if the user drops a dragged object over it.

OnDragEnter

The OnDragEnter event occurs when a dragged object crosses the borders of this component.

OnDragLeave

The OnDragLeave event occurs when a dragged object leaves the borders of this component.

OnDragOver

The OnDragOver event occurs for the component when the user drags an object over it.

OnEnter

The OnEnter event occurs when the component receives focus.

OnExit

The OnExit event occurs when the component loses focus.

OnHScroll

The OnHScroll event occurs when horizontal scrollbar slider changes its position.

OnKeyDown

The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.

OnKeyPress

The OnKeyPress event occurs if the component is focused when the user presses a character key.

OnKeyPreview

The OnKeyPreview event occurs prior to each event related to key pressing.

OnKeyUp

The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.

OnMouseDown

The OnMouseDown event occurs if the pointer is in component's area and a mouse key is pressed.

OnMouseEnter

The OnMouseEnter event occurs when mouse cursor enters the component area.

OnMouseHover

The OnMouseHover event occurs when mouse cursor is held in the component area.

OnMouseLeave

The OnMouseLeave event occurs when mouse cursor leaves the component area.

OnMouseMove

The OnMouseMove event occurs on moving the cursor over component.

OnMouseUp

The OnMouseUp event occurs on releasing mouse button when the cursor is in the component area.

OnMouseWheel

The OnMouseWheel event occurs if the component is focused when the mouse wheel is rotated.

OnVScroll

The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

Platform Components