CreateAnimation Method (Int32[], Single, Int32)

Collapse AllExpand All Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++

[TCheckBoxFormControlObj]C#

[TCheckBoxFormControlObj]Visual Basic

[TCheckBoxFormControlObj]

Visual C++

DPSF API Documentation

Animations

.CreateAnimation Method (array<Int32>[]()[], Single, Int32)

Animations Class

See Also Send Feedback

Creates a new Animation and returns the Animation's unique ID.

NOTE: Returns -1 if an invalid Picture ID was specified in the PictureRotationOrder.

NOTE: Be sure to Create the Pictures before creating the Animation.

Namespace: DPSF

Assembly: DPSF (in DPSF.dll) Version: 1.5.1.0

Syntax

public int CreateAnimation(

int[] iaPictureRotationOrder,

float fPictureRotationTime,

int iNumberOfTimesToPlay

)

Visual Basic (Declaration)

Public Function CreateAnimation ( _

iaPictureRotationOrder As Integer(), _

fPictureRotationTime As Single, _

iNumberOfTimesToPlay As Integer _

) As Integer

Visual C++

public:

int CreateAnimation(

array<int>^ iaPictureRotationOrder,

float fPictureRotationTime,

int iNumberOfTimesToPlay

)

Parameters

iaPictureRotationOrder

Type: array< System..::.Int32 >[]()[]

An array of Picture IDs that specifies the Order of Pictures to Rotate through in order to produce the Animation

fPictureRotationTime

Type: System..::.Single

How long (in seconds) to wait before switching to the next Picture in the Picture Rotation Order (i.e. The next Frame in the Animation)

iNumberOfTimesToPlay

Type: System..::.Int32

The number of times this Animation should be played (it replays when the end of the Animation is reached). Specify a value of zero to have the Animation repeat forever

Return Value

Returns the new Animation's unique ID. NOTE: Returns -1 if an invalid Picture ID was specified in the PictureRotationOrder.