Edit

ITextFont::SetAnimation method (tom.h)

  • Article

Sets the animation type.

Syntax

HRESULT SetAnimation(
  [in] long Value
);

Parameters

[in] Value

Type: long

The animation type. It can be one of the following values.

Animation type Value
tomNoAnimation 0
tomLasVegasLights 1
tomBlinkingBackground 2
tomSparkleText 3
tomMarchingBlackAnts 4
tomMarchingRedAnts 5
tomShimmer 6
tomWipeDown 7
tomWipeRight 8

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns the following COM error code. For more information about COM error codes, see Error Handling in COM.

Return code Description
E_INVALIDARG
 Invalid argument.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

GetAnimation

ITextFont

Reference

Text Object Model