[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TProgressBar

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TProgress Bar - a bar that depicts what proportion of a process has been completed.

Declaration

Source position: comctrls.pp line 1828

type TProgressBar = class(TCustomProgressBar)

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderWidth: TBorderWidth;

  

Width of the Border around the control; default is zero.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

The font to be used for text display in this control.

  property Hint: TTranslateString;

  

The text to show in the Hint window for the control.

  property Max: Integer;

  

Specifies the maximum value for the Position in the progress bar.

  property Min: Integer;

  

Specifies the minimum value for the Position in the progress bar.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus; This is a good place for checking the finished user input.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnStartDock: TStartDockEvent;

  

Event handler for the start of a docking operation.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property Orientation: TProgressBarOrientation;

  

Specifies the orientation and direction for the progress bar.

  property ParentColor: Boolean;

  

Use the Color from the Parent control, when enabled.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control.

  property Position: Integer;

  

The current position for the progress bar.

  property ShowHint: Boolean;

  

Enables the Hint display.

  property Smooth: Boolean;

  

Indicates if the progress bar indicator is drawn as a smooth solid bar, as opposed to individual bar segments.

  property Step: Integer;

  

Increment applied to the value in Position in the StepIt method.

  property Style: TProgressBarStyle;

  

Drawing style for the progress bar.

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

  property BarShowText: Boolean;

  

Indicates if status text is draw over the progress bar.

end;

Inheritance

TProgressBar

  

TProgress Bar - a bar that depicts what proportion of a process has been completed.

|

TCustomProgressBar

  

Implements the base class for progress bar controls.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components which have an associated widget.

|

TComponent

?

TObject

Description

TProgress Bar is a TCustomProgressBar descendant that implements a control which depicts the progress of a process, or the proportion of the process that has been completed. A series of colored rectangles appears in the control filling it from left to right or from top to bottom to represent the progress for the process.

See also

How To Use Standard Controls

  

How to use StdCtrls, ComCtrls or ExtCtrls.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.