Play method

  • Article

Plays the transition.

Syntax

HRESULT retVal = object.Play(varDuration);

Parameters

  • varDuration [in, optional]
    Type: VARIANT

    VARIANT that specifies the length of the transition in seconds.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Call this method when ready to run the effect to switch from the previous element state to the new element state.

The minimum value for varDuration is 0.0; you may specify any type that can be converted to a VARIANT of type VT_R4.

A VARIANT of type VT_USERDEFINED can be used to specify a maximum playback length; the currently applied Duration value is used unless it exceeds this length.

The HTMLFrameSiteEvents::onfilterchange event is fired when playback finishes.

See also

Reference

ICSSFilterDispatch::Apply

ICSSFilterDispatch::Duration