The main interface More...

Public Member Functions
HRESULT	About (void)
	Displays the control's credits
HRESULT	CloseAnimation (void)
	Closes the currently opened animation clip
HRESULT	DisplayFrame ([in] LONG frameNumber,[out, retval] VARIANT_BOOL *pSuccess)
	Displays a single frame of the animation
HRESULT	LoadSettingsFromFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's settings from the specified file
HRESULT	OpenAnimationFromFile ([in] BSTR filePath,[out, retval] VARIANT_BOOL *pSuccess)
	Opens the specified animation file and displays the first frame
HRESULT	OpenAnimationFromResource ([in] LONG hModule,[in] LONG resourceID,[in] BSTR resourceTypeName,[out, retval] VARIANT_BOOL *pSuccess)
	Opens the specified animation resource and displays the first frame
HRESULT	Refresh (void)
	Advises the control to redraw itself
HRESULT	SaveSettingsToFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Saves the control's settings to the specified file
HRESULT	StartReplay ([in, defaultvalue(0)] LONG startFrame,[in, defaultvalue(-1)] LONG endFrame,[in, defaultvalue(-2)] LONG repeats,[out, retval] VARIANT_BOOL *pSuccess)
	Starts playing the animation
HRESULT	StopReplay ([out, retval] VARIANT_BOOL *pSuccess)
	Stops playing the animation
Properties
AnimationBackStyleConstants	AnimationBackStyle `[get, set]`
	Controls drawing of the animation's background
AppearanceConstants	Appearance `[get, set]`
	Controls the style of the control's outer border
SHORT	AppID `[get]`
BSTR	AppName `[get]`
BSTR	AppShortName `[get]`
VARIANT_BOOL	AutoStartReplay `[get, set]`
	Specifies whether replay starts automatically after the animation has been loaded
OLE_COLOR	BackColor `[get, set]`
	Specifies the control's background color
BorderStyleConstants	BorderStyle `[get, set]`
	Controls the style of the control's inner border
LONG	Build `[get]`
VARIANT_BOOL	CenterAnimation `[get, set]`
	Specifies whether the animation is centered within the control
BSTR	CharSet `[get]`
DisabledEventsConstants	DisabledEvents `[get, set]`
	Controls which events are fired
VARIANT_BOOL	DontRedraw `[get, set]`
	Controls redrawing of the control
VARIANT_BOOL	Enabled `[get, set]`
	Controls whether the control accepts user input
LONG	HoverTime `[get, set]`
	Controls when the `MouseHover` event is fired
OLE_HANDLE	hWnd `[get]`
	Retrieves the control's window handle
VARIANT_BOOL	IsPlaying `[get]`
	Retrieves whether the control is currently playing an animation
VARIANT_BOOL	IsRelease `[get]`
IPictureDisp	MouseIcon `[get, set]`
	Controls the control's mouse cursor
MousePointerConstants	MousePointer `[get, set]`
	Controls the control's mouse cursor
BSTR	Programmer `[get]`
VARIANT_BOOL	RegisterForOLEDragDrop `[get, set]`
	Controls the control's behavior in drag'n'drop operations
VARIANT_BOOL	SupportOLEDragImages `[get, set]`
	Controls the control's behavior in drag'n'drop operations
BSTR	Tester `[get]`
BSTR	Version `[get]`
	Retrieves the control's version

Detailed Description

The main interface

Author:: Timo "TimoSoft" Kunze This is the control's main interface. It wraps the control window.

See also:: _IAnimationEvents

Member Function Documentation

HRESULT About ( void )

Displays the control's credits

Displays some information about this control and its author.

HRESULT CloseAnimation ( void )

Closes the currently opened animation clip

See also:: OpenAnimationFromFile, OpenAnimationFromResource, StopReplay

HRESULT DisplayFrame	(	[in] LONG	frameNumber,
		[out, retval] VARIANT_BOOL *	pSuccess
	)

Displays a single frame of the animation

Parameters:

[in] frameNumber The zero-based index of the frame to display.

Returns:: True, if the frame was displayed successfully; otherwise False.

See also:: StartReplay, StopReplay, OpenAnimationFromFile, OpenAnimationFromResource

HRESULT LoadSettingsFromFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Loads the control's settings from the specified file

Parameters:

[in] file The file to read from.

Returns:: True if the settings could be loaded; otherwise False.

See also:: SaveSettingsToFile

HRESULT OpenAnimationFromFile	(	[in] BSTR	filePath,
		[out, retval] VARIANT_BOOL *	pSuccess
	)

Opens the specified animation file and displays the first frame

Parameters:

[in] filePath The path of the animation file to open.

Returns:: True, if the specified file was opened successfully; otherwise False.

See also:: OpenAnimationFromResource, CloseAnimation, AutoStartReplay, StartReplay, DisplayFrame

HRESULT OpenAnimationFromResource	(	[in] LONG	hModule,
		[in] LONG	resourceID,
		[in] BSTR	resourceTypeName,
		[out, retval] VARIANT_BOOL *	pSuccess
	)

Opens the specified animation resource and displays the first frame

Parameters:

[in]	hModule	The handle of the module from which to load the animation resource.
[in]	resourceID	The ID of the resource to load.
[in]	resourceTypeName	The type name of the resource to load. Set it to an empty string if you want to load an AVI animation. Otherwise set it to the name of the type under which the animation is stored in the resource file.

Returns:: True, if the specified resource was opened successfully; otherwise False.

See also:: OpenAnimationFromFile, CloseAnimation, AutoStartReplay, StartReplay, DisplayFrame

HRESULT SaveSettingsToFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Saves the control's settings to the specified file

Parameters:

[in] file The file to write to.

Returns:: True if the settings could be saved; otherwise False.

See also:: LoadSettingsFromFile

HRESULT StartReplay	(	[in, defaultvalue(0)] LONG	startFrame,
		[in, defaultvalue(-1)] LONG	endFrame,
		[in, defaultvalue(-2)] LONG	repeats,
		[out, retval] VARIANT_BOOL *	pSuccess
	)

Starts playing the animation

Parameters:

[in]	startFrame	The zero-based index of the frame at which the animation shoult start.
[in]	endFrame	The zero-based index of the frame at which the animation shoult end. If set to `-1`, the animation will be played up to the last frame.
[in]	repeats	The number of repeats of the animation. If set to `-1`, the animation will repeat until it is stopped using the `StopReplay` method. If set to `-2`, the animation will repeat as often as recommended by the animation itself. If the animation does not specify a number of repeats, it will repeat until it is stopped using the `StopReplay` method.

Returns:: True, if the animation was started successfully; otherwise False.

See also:: StopReplay, IsPlaying, AutoStartReplay, OpenAnimationFromFile, OpenAnimationFromResource, DisplayFrame, _IAnimationEvents::StartedReplay

HRESULT StopReplay ( [out, retval] VARIANT_BOOL * pSuccess )

Stops playing the animation

Returns:: True, if the animation was stopped successfully; otherwise False.

See also:: StartReplay, IsPlaying, CloseAnimation, DisplayFrame, _IAnimationEvents::StoppedReplay

Property Documentation

AnimationBackStyleConstants AnimationBackStyle [get, set]

Controls drawing of the animation's background

Retrieves or sets how the animation's background is drawn. Any of the values defined by the AnimationBackStyleConstants enumeration is valid.

Attention:: Changing this property destroys and recreates the control window.

See also:: BackColor, AnimationBackStyleConstants

AppearanceConstants Appearance [get, set]

Controls the style of the control's outer border

Retrieves or sets the kind of border that is drawn around the control. Any of the values defined by the AppearanceConstants enumeration is valid.

See also:: BorderStyle, AppearanceConstants

SHORT AppID [get]

BSTR AppName [get]

BSTR AppShortName [get]

VARIANT_BOOL AutoStartReplay [get, set]

Specifies whether replay starts automatically after the animation has been loaded

Retrieves or sets whether replay of the animation is started automatically after the animation was loaded. If set to True, the animation starts automatically (playing all frames in an endless loop), otherwise not.

See also:: OpenAnimationFromFile, OpenAnimationFromResource, StartReplay, _IAnimationEvents::StartedReplay

OLE_COLOR BackColor [get, set]

Specifies the control's background color

Retrieves or sets the control's background color.

Remarks:: This property isn't supported for comctl32.dll version 6.0 or newer.

See also:: AnimationBackStyle

BorderStyleConstants BorderStyle [get, set]

Controls the style of the control's inner border

Retrieves or sets the kind of inner border that is drawn around the control. Any of the values defined by the BorderStyleConstants enumeration is valid.

See also:: Appearance, BorderStyleConstants

LONG Build [get]

VARIANT_BOOL CenterAnimation [get, set]

Specifies whether the animation is centered within the control

Retrieves or sets whether the animation is centered within the control. If set to True, the animation is centered, otherwise not.

Attention:: Changing this property destroys and recreates the control window.

BSTR CharSet [get]

DisabledEventsConstants DisabledEvents [get, set]

Controls which events are fired

Retrieves or sets the events that won't be fired. Disabling events increases performance. Any combination of the values defined by the DisabledEventsConstants enumeration is valid.

See also:: DisabledEventsConstants

VARIANT_BOOL DontRedraw [get, set]

Controls redrawing of the control

Enables or disables automatic redrawing of the control. Disabling redraw while doing large changes on the control may increase performance. If set to False, the control will redraw itself automatically; otherwise not.

VARIANT_BOOL Enabled [get, set]

Controls whether the control accepts user input

Enables or disables the control for user input. If set to True, it reacts to user input; otherwise not.

LONG HoverTime [get, set]

Controls when the MouseHover event is fired

Retrieves or sets the number of milliseconds the mouse cursor must be located over the control's client area before the MouseHover event is fired. If set to -1, the system hover time is used.

See also:: _IAnimationEvents::MouseHover

OLE_HANDLE hWnd [get]

Retrieves the control's window handle

Retrieves the control's window handle.

Remarks:: This property is read-only.

See also:: _IAnimationEvents::RecreatedControlWindow, _IAnimationEvents::DestroyedControlWindow

VARIANT_BOOL IsPlaying [get]

Retrieves whether the control is currently playing an animation

Retrieves whether the control is currently playing an animation. If True, it is playing an animation; otherwise not.

See also:: StartReplay, StopReplay, _IAnimationEvents::StartedReplay, _IAnimationEvents::StoppedReplay

VARIANT_BOOL IsRelease [get]

IPictureDisp MouseIcon [get, set]

Controls the control's mouse cursor

Retrieves or sets a user-defined mouse cursor. It's used if MousePointer is set to mpCustom.

See also:: MousePointer, MousePointerConstants

MousePointerConstants MousePointer [get, set]

Controls the control's mouse cursor

Retrieves or sets the cursor's type that's used if the mouse cursor is placed within the control's client area. Any of the values defined by the MousePointerConstants enumeration is valid.

See also:: MouseIcon, MousePointerConstants

BSTR Programmer [get]

VARIANT_BOOL RegisterForOLEDragDrop [get, set]

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control is registered as a target for OLE drag'n'drop. If set to True, the control accepts OLE drag'n'drop actions; otherwise not.

See also:: SupportOLEDragImages, _IAnimationEvents::OLEDragEnter

VARIANT_BOOL SupportOLEDragImages [get, set]

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control creates an IDropTargetHelper object, so that a drag image can be displayed during OLE drag'n'drop. If set to True, the control creates the object; otherwise not.

Remarks:: Requires shell32.dll version 5.0 or higher.

See also:: RegisterForOLEDragDrop, IDropTargetHelper

BSTR Tester [get]

BSTR Version [get]

Retrieves the control's version

Remarks:: This property is read-only.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation