AnimationGetParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Animation functions

Image field: Available parameters and their values
Static Text control: available parameters and their values

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

AnimationGetParameter (Function)

In french: AnimationLitParamètre

Reads the value of one of the animation parameters defined for an Image or Static Text control.

New in version 2025

It is now possible to read the animation parameters used for animated text in a Static Text control.

In this version, you can only read the value of the animation parameters defined for a Static Text control.

Example

IF AnimationGetParameter(IMG_Image1, acpLoop) = True THEN
	AnimationSetParameter(IMG_Image1, acpLoop, False)
END

IF AnimationGetParameter(STC_CustomerNameSta, acpColor) = Transparent THEN
	AnimationSetParameter(STC_CustomerNameSta, acpColor, LightYellow)
END

Syntax

Reading the animation parameters of an image (Image control) Hide the details

<Result> = AnimationGetParameter(<Image control> , <Parameter name>)

<Result>: Type of expected parameter

Value of sought parameter.

<Image control>: Control name

Name of the Image control to be used.

<Parameter name>: Constant or character string

Name of parameter to read.
acpDirection (or "Direction") Scroll direction.
"Scrolling" animation only.
These parameters can be combined.
1 (default): left to right
2: right to left
4: from bottom to top
8: top to bottom
Example of combination:
3 (2+1): left right: gradual widening from the center
5 (4+1) from bottom to top and from right to left
This constant is not available.
acpDirectionAlternate (or "DirectionAlternate") Read the image drawings from the first one to the last one, then from the last one to the first one continuously (this parameter is set to False by default).
acpDuration (or "Duration") Amount of time for displaying each drawing of the animation in milliseconds (300 ms by default).
acpLoop (or "Loop") Read the image drawings from the first one to the last one continuously (this parameter is set to True by default).
acpNbImageX (or "NumberOfImagesX") Number of drawings found in the width of image file. Depending on the specified number, the image will be automatically divided into as many drawings as necessary (1 by default).
"Image to animate" animation only.
This constant is not available.
acpNbImageY (or "NumberOfImagesY") Number of drawings found in the height of image file. Depending on the specified number, the image will be automatically divided into as many drawings as necessary (1 by default).
"Image to animate" animation only.
This constant is not available.
acpNbStep (or "NumberOfSteps") 10 by default
"Scrolling" animation only.
This constant is not available.
acpReverse (or "Reverse") Read the image drawings from the last one (bottom right) to the first one (top left) (this parameter is set to False by default).

Reading the animation parameters of a static text (Static Text control) Hide the details

<Result> = AnimationGetParameter(<Static Text control> , <Parameter name>)

<Result>: Type of expected parameter

Value of sought parameter.

<Static Text control>: Control name

Name of the Static Text control to be used.

<Parameter name>: Constant or character string

Name of parameter to read.
acpColor (or "Color") Blinking color. This parameter can correspond to a color constant. This color corresponds to Transparent by default.
"Blinking" animation only.
acpDirection (or "Direction") Scroll direction.
"Scrolling" animation only.
These parameters cannot be combined.
1 (default): left to right
2: right to left
4: from bottom to top
8: top to bottom
acpDuration (or "Duration") Time for displaying each animation element in milliseconds (300 ms by default)
New in version 2025
acpLoop (or "Loop")
Continuous Dequeue (this setting is True by default).
"Scrolling" animation only.
Note: This feature is only available from version 2025 Update 1.
New in version 2025
acpNbLoopMax (or "NombreBoucleMax")
Number of loops for continuous dequeue (0 unlimited number of loops).
"Scrolling" animation only.
Note: This feature is only available from version 2025 Update 1.
acpNbPixel (or "NumberOfPixels") Number of pixels for each scrolling step.
"Scrolling" animation only.

Remarks

Image field: Available parameters and their values

Two types of animations are available for Image controls:

Image to animate (animation performed by WINDEV or WINDEV Mobile),
Scrolling.


Parameters common to the different animations
Loop	Read the image drawings from the first one to the last one continuously (this parameter is set to True by default).
Reverse	Read the image drawings from the last one (bottom right) to the first one (top left) (this parameter is set to False by default).
DirectionAlternate	Read the image drawings from the first one to the last one, then from the last one to the first one continuously (this parameter is set to False by default).
Duration	Amount of time for displaying each drawing of the animation in milliseconds (300 ms by default).
Parameter specific to the "Image to animate"
NumberOfImagesX	Number of drawings found in the width of image file. Depending on the specified number, the image will be automatically divided into as many drawings as necessary (1 by default). This parameter cannot be defined programmatically.
NumberOfImagesY	Number of drawings found in the height of image file. Depending on the specified number, the image will be automatically divided into as many drawings as necessary (1 by default). This parameter cannot be defined programmatically.
Parameter specific to "Scrolling"
Direction	Scroll direction. These parameters can be combined. 1 (default): left to right 2: right to left 4: from bottom to top 8: top to bottom Example of combination: 3 (2+1): left right: gradual widening from the center 5 (4+1) from bottom to top and from right to left
NumberOfSteps	10 by default.

Static Text control: available parameters and their values

Two types of animations are available for Static Text controls:

Blinking,
Scrolling.


Parameters common to the different animations.
Duration	Amount of time for displaying each drawing of the animation in milliseconds (300 ms by default).
Parameter specific to "Blinking"
Color	Blinking color. This parameter can correspond to a color constant. This color corresponds to Transparent by default.
Settings specific to "Scrolling"
New in version 2025 Loop	Continuous Dequeue (this parameter corresponds to True by default). Note: This feature is only available from version 2025 Update 1.
New in version 2025 MaxLoopCount	Number of scroll loops to perform (0 for unlimited scrolling number. Note: This feature is only available from version 2025 Update 1.
NumberOfPixels	Number of pixels for each scrolling step.
Direction	Scroll direction. These parameters cannot be combined. 1 (default): left to right 2: right to left 4: from bottom to top 8: from top to bottom.

Component: wd300obj.dll