CancelEventModel Class

The CancelEvent action cancels an event before it is completed.

Inheritance Hierarchy

Namespace: Livit.Learn.Model.Actions
Assembly: Livit.Learn.Model (in Livit.Learn.Model.dll) Version: 0.0.0.0

Syntax

[SerializableAttribute]
public class CancelEventModel : ActionModel

The CancelEventModel type exposes the following members.

Constructors

	Name	Description
	CancelEventModel	Initializes a new instance of the CancelEventModel class

Properties

	Name	Description
	Attached	Defines an attached property. (Inherited from BaseModel.)
	Comments	(Development) Includes comments in the XML code. (Inherited from BaseModel.)
	Conditions	(Inherited from ConditionsDependantModel.)
	ConditionTimeout	(Inherited from ConditionsDependantModel.)
	DataContext	Contains a source of all bindings defined for element. (Inherited from BaseModel.)
	ExternalXmlPath	(Inherited from BaseModel.)
	GlobalOrderIndex	(Inherited from ActionModel.)
	HashedPath	(Inherited from ActionModel.)
	Id	Defines a unique identifier for an element in the simulation. (Inherited from BaseModel.)
	IgnoreInPH	(Inherited from ActionModel.)
	IsIdAutogenerated	(Inherited from BaseModel.)
	IsRunning	(Inherited from ActionModel.)
	IsTransient	(Inherited from ActionModel.)
	IsTransientInstance	(Inherited from ActionModel.)
	MessageText	Displays Message as tooltip on Parent Element when invoked
	NotifyUser	Notify User with Cancellation Sound Effect
	TemplateVersionId	Contains a id of source template. (Inherited from BaseModel.)
	XmlComments	(Development) Used as temporary storage for XML comments (like ) to keep them. (Inherited from BaseModel.)

Methods

	Name	Description
	DeepCopy	Creates an in-memory clone of this object using a BinaryFormatter to ensure all child properties are copied as well. (Inherited from BaseModel.)
	ShallowCopy	(Inherited from BaseModel.)
	ToString	Returns a string that represents the current object. (Inherited from BaseModel.)
	UpdateModels	This method will update this model and all its child models. (Inherited from BaseModel.)

Remarks

This action is used inside an EventTrigger to prevent the event from being completed.

The CancelEvent may not always successfully preempt the event due to various interactions with other elements in the platform and should be tested.

Examples

This CancelEvent action will cancel the PreviewDrop event before it is complete.

XML

<EventTrigger Event="PreviewDrop">
  <Conditions>
    ...
  </Conditions>
  <Actions>
    <CancelEvent />
  </Actions>
</EventTrigger>