PPButton

Inheritance Hierarchy

          IComponent

          IControl

          IButton

          IPPButton

          PPButton

Description

The PPButton component is an analog of the Button component that has its own style similar to Prognoz Platform 9.

Comments

Unlike Button the style of the PPButton component does not depend on the style and settings of the operating system. Functional settings and features of the PPButton and Button components are the same.

Example

Properties of the PPButton Component

  Property name Brief description
Align The Align property determines component alignment within its parent component.
AllowDrag The AllowDrag  property determines whether an object can be dragged from the component.
AllowDrop The AllowDrop  property determines whether the component can accept the 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.
Brush The Brush  property specifies the brush used to fill the component area.
CancelButton The CancelButton property determines whether the OnClick  event is handled on clicking the ESC button.
ClientHeight The ClientHeight  property determines the height of the client component area.
ClientWidth The ClientWidth  property determines the width of the client component area.
Color The Color  property determines the background color of the component.
ComponentCount The ComponentCount property returns the number of child components.
Components The Components property returns a child component.
Cursor The Cursor  property determines how the cursor looks like when you hover over a component during form execution.
Data The Data property is used to store any custom data.
DefaultButton The DefaultButton property determines that clicking the ENTER key is equal to clicking this button.
Enabled The Enabled  property determines whether a component is available for a user.
Focused The Focused  property returns  True if this component is focused.
Font The Font  property determines the set of characteristics, describing the font, used to display text.
Height The Height  property determines the component height.
HelpContext The HelpContext  property determines the unique index for a section of a context help for this component.
Hint The Hint  property determines the hint text for the component.
Left The Left  property determines the coordinate of the left border of the component.
ModalResult The ModalResult property determines the result returned after clicking the button in the modal form on closing this form.
Name The Name property determines the component name.
Parent The Parent  property determines the parent component.
ParentColor The ParentColor  property determines whether a component inherits the color of the parent component.
ParentFont The ParentFont  property determines whether a component should use the font of the parent component.
ParentShowHint The ParentShowHint property determines whether a tooltip is displayed.
PopupMenu The PopupMenu property determines the context menu to be displayed on the right-click.
Scrolls The Scrolls  property returns parameters of component's scrollbars.
ShowHint The ShowHint  property enables and disables showing a hint for the component.
TabOrder The TabOrder  property determines the component position in the tab order.
TabStop The TabStop property determines whether the focus is set to a component when the TAB key is pressed.
Tag The Tag property is not used by the compiler. A user can change the value of the  Tag  property and use it as he wishes.
Text The Text  property determines the row identifying a component for a user.
Top The Top  property determines the coordinate of the top border of the component.
Visible The Visible  property determines the visibility of the component during execution.
Width The Width  property determines the component width.

Methods of the PPButton 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 to screen coordinates.
DoDragDrop The DoDragDrop method starts 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 to 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 PPButton Component

  Event name Brief description
OnBeginDrag The OnBeginDrag  event occurs for a component when a user starts to drag an object from the component.
OnClick The OnClick  event occurs if a user clicks a component area using the main mouse button.
OnDblClick The OnDblClick  event occurs if a user double-clicks a component area using the mouse button.
OnDragDrop The OnDragDrop  event occurs for a component if a 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 this component when a user drags a dragged object over it.
OnEnter The  OnEnter  event occurs when a component receives focus.
OnExit The  OnExit  event occurs when a component loses focus.
OnHScroll The  OnHScroll  event occurs on changing position of horizontal scrollbar slider.
OnKeyDown The  OnKeyDown  event occurs if a component is focused and a keyboard key is pressed.
OnKeyPress The  OnKeyPress  event occurs if a component is focused when a user presses a character key.
OnKeyPreview The  OnKeyPreview  event occurs prior to each event requiring clicking.
OnKeyUp The  OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
OnMouseDown The  OnMouseDown event occurs if the cursor is in component's area and a mouse button is pressed.
OnMouseEnter The  OnMouseEnter occurs when the mouse cursor enters the component's area.
OnMouseHover The  OnMouseHover event occurs when the mouse cursor lingers in component area.
OnMouseLeave The  OnMouseLeave event occurs when the mouse cursor leaves the component area.
OnMouseMove The  OnMouseMove event occurs when the mouse cursor is moved over the component.
OnMouseUp The  OnMouseUp event occurs if user releases mouse button when the cursor is in the component area.
OnMouseWheel The  OnMouseWheel event occurs if a component is focused when a user rotates mouse wheel.
OnVScroll The  OnVScroll  event occurs on changing position of vertical scrollbar slider.

See also:

Prognoz Platform Components