Animation control – PB Docs 2021

AccessibleDescription

String

A description of the control and/or its purpose for
use by accessibility tools such as readers for visually impaired
users.

AccessibleName

String

A label that briefly describes the control, such as
the text in a button or the name of a menu item.

AccessibleRole

AccessibleRole (enumerated)

Describes what kind of user interface element the
control is.

AnimationName

String

Specifies the name of the file that contains the
AVI clip. The AVI clip cannot have a sound
channel.

AutoPlay

Boolean

Specifies whether the animation starts as soon as
the AVI clip is opened. Values are:

TRUE — Control
plays automatically when opened.

FALSE — Control
does not play automatically when opened
(default).

Border

Boolean

Specifies whether the control has a border. Values
are:

TRUE — Control has a border.

FALSE
— Control does not have a border.

BorderStyle

BorderStyle (enumerated)

Specifies the style of the border of the control.
Values
are:

StyleBox!

StyleLowered!

StyleRaised!

StyleShadowBox!

BringToTop

Boolean

Specifies whether PowerBuilder moves the control to
the top of the front-to-back order of the window. Values
are:

TRUE — Control moved to top.

FALSE
— Control not moved to top.

ClassDefinition

PowerObject

An object of type PowerObject containing
information about the class definition of the object or
control.

DragAuto

Boolean

Specifies whether PowerBuilder puts the control
automatically into Drag mode. Values are:

TRUE —
When the control is clicked, the control is automatically in
Drag mode.

FALSE — When the control is clicked, the
control is not automatically in Drag mode. You have to put the
control into Drag mode manually by using the Drag
function.

DragIcon

String

Specifies the name of the stock icon or the file
containing the icon you want to use to display when the user
drags the control (the ICO file). The default icon is a box the
size of the control.

When the user drags the
control, the icon displays when the control is over an area in
which the control can be dropped (a valid drop area). When the
control is over an area that is not a valid drop area, the
No-Drop icon displays.

Enabled

Boolean

Specifies whether the control is enabled (can be
selected). Values are:

TRUE — Control can be
selected.

FALSE — Control cannot be
selected.

Height

Integer

Specifies the height of the control, in
PowerBuilder units.

OriginalSize

Boolean

Specifies whether the width and height properties
of an animation control are set to the size of the AVI clip.
Values are:

TRUE — Width and height set to original
values.

FALSE — Existing width and height not
changed.

In the Window painter, setting OriginalSize
to true overrides the existing width and height.

Pointer

String

Specifies the name of the stock pointer or the file
containing the pointer used for the control.

PowerTipText

Long

Specifies a PowerTip for the
control.

TabOrder

Integer

Specifies the tab value of the animation within the
window (0 means the user cannot tab to the
control).

Tag

String

Specifies the tag value assigned to the
control.

Transparent

Boolean

Specifies whether the background of the control
matches the background of the window it is on, creating a
transparent effect. Values are:

TRUE — Control is
transparent.

FALSE — Control is not
transparent.

Visible

Boolean

Specifies whether the control is visible. Values
are:

TRUE — Control is visible.

FALSE
— Control is not visible.

Width

Integer

Specifies the width of the control, in PowerBuilder
units.

X

Integer

Specifies the X position (distance from the left
edge of the window), in PowerBuilder units.

Y

Integer

Specifies the Y position (distance from the top of
the window), in PowerBuilder units.

Clicked

When the control is clicked
(selected)

Constructor

Immediately before the Open event occurs in the
window

Destructor

Immediately after the Close event occurs in the
window

DoubleClicked

When the control is double-clicked (selected and
activated)

DragDrop

When a dragged control is dropped on the
control

DragEnter

When a dragged control enters the
control

DragLeave

When a dragged control leaves the
control

DragWithin

When a dragged control is within the
control

GetFocus

Just before the control receives focus (before it
is selected and becomes active)

Help

When the user presses the F1 key or drags the
context help button (question mark) from the title bar to a menu
item or control

LoseFocus

When the control loses focus (becomes
inactive)

Other

When a Windows message occurs that is not a
PowerBuilder event

RButtonDown

When the right mouse button is pressed on the
control

Start

When an animation has started
playing

Stop

When an animation has stopped
playing

ClassName

String

Returns the name assigned to the
control

Drag

Integer

Starts or ends the dragging of the
control

GetContextService

Integer

Creates a reference to a context-specific instance
of the specified service

GetParent

PowerObject

Returns a reference to the name of the parent
object

Hide

Integer

Makes the control invisible

Move

Integer

Moves the control to a specified
location

Play

Integer

Starts playing the AVI clip in the
control

PointerX

Integer

Returns the distance of the pointer from the left
edge of the control

PointerY

Integer

Returns the distance of the pointer from the top of
the control

PostEvent

Boolean

Adds an event to the end of the message queue for
the control

Resize

Integer

Changes the size of the control

Seek

Integer

Displays a specified frame in an AVI
clip

SetFocus

Integer

Sets focus to the control

SetPosition

Integer

Specifies the position of the control in the
front-to-back order of the window

SetRedraw

Integer

Controls automatic redrawing of the control after
each change in its properties

Show

Integer

Makes the control visible

Stop

Integer

Stops playing the AVI clip in the
control

TriggerEvent

Integer

Triggers a specified event in the control and
executes the script for the event

TypeOf

Object

Returns the type of the control