Class ApplyPropertyAction

Class Hierarchy

An ApplyPropertyAction sets a property to the requested value for as long as the condition is met in the DataTrigger that sets off this action. When the trigger condition is no longer met, Kanzi rolls back the value of that property to the value before the action was applied, or to the value set while Kanzi was applying an ApplyPropertyAction. Use the ApplyPropertyAction only with a DataTrigger.

For example, when the value of a property changes from 5 to 9 while Kanzi is applying an ApplyPropertyAction on that property, when a DataTrigger that set off that action, rolls back that property value, the value is 9, and not 5.

When you want to set a value of a property only when a condition in a Trigger is met, always use a DataTrigger. For example, use one DataTrigger with an ApplyPropertyAction instead of any other trigger to set the value of a property when the condition in that trigger is met and another trigger to roll back the value of the same property when the condition in the first trigger is no longer met.

Since Kanzi 3.9.0

Sets a property to the requested value for as long as the conditions are met in a Data Trigger that contains this action. When the conditions are no longer met, Kanzi rolls back the value of that property to the value before the action was applied.

Inherits properties and message types from ApplyPropertyActionMetadata.

Synopsis

Methods
create()

Creates an instance of ApplyPropertyAction

ApplyPropertyAction.ApplyPropertyAction:create(name)

Creates an instance of ApplyPropertyAction.

Parameters
name (string)

Name of this action instance.

Return Values
(ApplyPropertyAction)

Shared pointer to the created ApplyPropertyAction instance.