Animation

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • Component
    • Animation

Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.

C#

public class Animation : Component, IExtenderProvider

VB.NET

Public Class Animation
    Inherits Component
    Implements IExtenderProvider

Constructors

Animation()

Initializes a new instance of the Animation class.

Animation(container)

Initializes a new instance of the Animation class attached to a IContainer implementation.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the Animation extender.

Properties

CustomAnimations

List<String>: Manages a collection of used defined animation definitions.

Tag

Object: Returns or sets the object that contains programmer-supplied data associated with this component. (Default: null)

Methods

CanExtend(extendee)

Returns a value indicating whether a control can be extended.

Parameter	Type	Description
extendee	Object	The control to be extended.

Returns: Boolean. true if the control can be extended; otherwise, false.

Clear()

Removes all animations.

Dispose(disposing)

Parameter	Type	Description
disposing	Boolean

GetAnimation(control)

Animation properties.

Parameter	Type	Description
control	Control	The control to get the animation name for.

Returns: Properties. The name of the selected animation.

Throws:

• ArgumentNullException control is null.

OnEnd(e)

Fires the End event.

Parameter	Type	Description
e	AnimationEventArgs

OnStart(e)

Fires the Start event.

Parameter	Type	Description
e	AnimationEventArgs

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

ResetAnimation(control)

Removes all the animation properties from the control .

Parameter	Type	Description
control	Control	Control to remove from the Animation extender.

Run(control)

Runs the animation of the specified Control immediately. If the control doesn't have a configured animation this method doesn't do anything.

Parameter	Type	Description
control	Control	The control to animate.

Events

End

AnimationEventHandler Fired when the animation ends.

Start

AnimationEventHandler Fired when the animation begins.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.