Configure trigger actions. More...

Inheritance diagram for TriggerActionItem:

Collaboration diagram for TriggerActionItem:

Public Member Functions
void	SetForwardArgument (string argumentPropertyName, EventArgumentValueTypeEnum argumentValueType, object value)
	Sets the message trigger argument to either a fixed value or to take the value from a property that you set.

void	SetForwardArguments (IEnumerable< Property > argumentPropertyTypes)
	Sets the trigger arguments.

Public Member Functions inherited from ProjectItem
void	AddProperty (Property property)
	Adds a property to an item.

void	AddProperty (string propertyName)
	Adds a property to an item.

void	BeginBatchModification (string batchName)
	Begins a batch modification operation.

bool	CanAddProperty (Property property)
	Checks whether Kanzi Studio allows you to add a specific property to an item.

bool	CanAddProperty (string propertyName)
	Checks whether Kanzi Studio allows you to add a specific property to an item.

void	CommitBatchModification ()
	Commits the current batch modification operation.

bool	Delete ()
	Deletes a project item.

void	DeregisterThumbnailUser (object user)
	Deregisters a registerd thumbnail user.

IEnumerable< Property >	GetAddableProperties ()
	Gets a list of properties which you can add to an item.

T	GetAncestor< T > ()
	Gets the nearest item of given type in the parent tree.

ProjectItem	GetChild (string childName)
	Gets the child item of the current item with the given name.

T	GetChild< T > (string childName)
	Gets the child item of the current item with the given name and type.

int	GetChildIndex (ProjectItem child)
	Gets the index of a child project item within this item's children collection.

IEnumerable< Property >	GetContextProperties ()
	Gets the context properties for this project item.

IEnumerable< Property >	GetFixedProperties ()
	Gets the fixed properties for this project item that cannot be removed.

IEnumerable< Property >	GetFrequentlyAddedProperties ()
	Gets the properties that are frequently added to this type of project item.

ProjectItem	GetProjectItemByPath (string path)
	Gets a project item by its path relative to this project item.

string	GetRelativeProjectPathTo (ProjectItem anotherItem)
	Gets the relative path from this project item to another project item.

IEnumerable< Property >	GetRemovableProperties ()
	Gets a list of properties which you can remove from an item.

BitmapSource	GetThumbnail (int width, int height, bool showChildren, bool showFullScreen, Node contextNode)
	Gets the thumbnail image for a project item.

BitmapSource	GetThumbnail (int width, int height, bool showChildren, bool showFullScreen, Node contextNode, float[] letterboxColorRGBA)
	Gets the thumbnail image for a project item.

IEnumerable< ProjectItem >	GetTreeItemsAsList ()
	Enumerates the items under this ProjectItem including this item itself, children, and grand children.

bool	HasProperty (Property property)
	Checks whether an item has a specific property.

bool	HasProperty (string propertyName)
	Checks whether an item has a specific property.

bool	IsPropertyReadOnly (Property property)
	Checks whether the specified property is read-only on this project item.

void	RegisterThumbnailUser (object user, uint width, uint height, bool showChildren, bool showFullScreen, Node contextNode)
	Registers a user for the thumbnail images for a project item.

void	RemoveProperty (Property property)
	Removes a property from an item.

void	RemoveProperty (string propertyName)
	Removes a property from an item.

void	SetChildIndex (ProjectItem child, int index)
	Sets the index of a child project item within this item's children collection.

void	SetPropertyReadOnlyStatus (Property property, bool? value)
	Sets the read-only status of the specified property on this project item.

void	UpdateValidity ()
	Recalculates the validity the item.

Public Member Functions inherited from PropertyContainer
object	Get (Property property)
	Gets the value of a property.

object	Get (string propertyName)
	Gets the value of a property.

T	Get< T > (TypedProperty< T > property)
	Gets the value of a property.

void	Set (string propertyName, object value)
	Sets the value of a property.

void	Set< T > (TypedProperty< T > property, T value)
	Sets the value of a property.

Public Member Functions inherited from ChildContainer
string	GenerateUniqueChildName (string defaultName)
	Generates a unique name.

string	GetInvalidityReasonOfNewName (string newName)
	Returns the reason why the passed name is not valid.

Properties
int	Delay `[get, set]`
	Gets or sets the delay in milliseconds after which the trigger sets off the action.

MessageType	DispatchMessageActionMessageType `[get, set]`
	Gets or sets the Message Type.

new TriggerActionItemProperties	PropertyTypes `[get]`

ProjectItemReference< ExportedPropertyContainerItem >	RoutingTarget `[get, set]`
	Gets or sets the Target Item to which the action dispatches the message.

TriggerActionType	TriggerActionType `[get]`
	Gets the Trigger Action Type.

Properties inherited from ProjectItem
IEnumerable< ProjectItem >	Children `[get]`
	Gets all child items of a project item.

string	IconLocation `[get]`
	Gets the location of the icon for this project item in Kanzi Studio.

object	IconModifier `[get, set]`
	Gets or sets the icon modifier for this project item.

string	InvalidityReason `[get]`
	Gets the reason why this project item is in an invalid state, or null if the item is valid.

bool	IsDeleted `[get]`
	Gets whether this project item has been deleted.

bool	IsDisposed `[get]`
	Gets whether this project item has been disposed.

bool	IsHidden `[get, set]`
	Gets or sets whether this project item is hidden in Kanzi Studio.

bool	IsReadOnly `[get, set]`
	Gets or sets whether this project item is read-only.

bool	IsValidState `[get]`
	Gets whether this project item is in a valid state.

string	KzbUrl `[get]`
	Gets the kzb URL of a project item.

string	Name `[get, set]`
	Gets or sets the name of a project item.

ProjectItem	Parent `[get, set]`
	Gets or sets the parent of this project item.

string	Path `[get]`
	Gets the path to this project item within the project.

Project	Project `[get]`
	Gets the project in which this item is located.

Type	ProjectItemType `[get]`
	Gets the type of this project item.

PropertyTypeLibrary	PropertyTypeLibrary `[get]`
	Gets the Property Types library of the project of this item which stores all property types you create in a Kanzi Studio project.

object	this[Property property] `[get, set]`
	Gets or sets the value of the specified property on this project item.

object	this[string propertyName] `[get, set]`
	Gets or sets the value of the property with the specified name on this project item.

string	ToolTip `[get]`
	Gets the tooltip text for this project item in Kanzi Studio.

string	TypeDisplayName `[get]`
	Gets the type of a project item.

Properties inherited from PropertyContainer
IEnumerable< Property >	Properties `[get]`
	Gets the properties in a project item or node component.

Additional Inherited Members
Events inherited from ProjectItem
EventHandler< CollectionChangedEventArgs< ProjectItem > >	ChildCollectionChanged
	Occurs when the children collection of this project item changes.

EventHandler< DeletedEventArgs >	Deleted
	Occurs after this project item has been deleted.

EventHandler< DeletedEventArgs >	Deleting
	Occurs when this project item is about to be deleted.

EventHandler< CollectionChangedEventArgs< ProjectItem > >	DescendantChildCollectionChanged
	Occurs when the children collection of this project item or any of its descendants changes.

EventHandler< DeletedEventArgs >	DescendantDeleted
	Occurs after a descendant of this project item has been deleted.

EventHandler< DynamicPropertyChangedEventArgs >	DescendantDynamicPropertyChanged
	Occurs when a dynamic property value changes on this project item or any of its descendants.

EventHandler< ParentChangedEventArgs >	DescendantParentChanged
	Occurs when the parent of this project item or any of its descendants changes.

EventHandler< CollectionChangedEventArgs< string > >	DescendantPropertyCollectionChanged
	Occurs when a property is added to or removed from this project item or any of its descendants.

EventHandler< ProjectItemEventArgs >	Disposing
	Occurs when this project item is being disposed.

EventHandler< DynamicPropertyChangedEventArgs >	DynamicPropertyChanged
	Occurs when a dynamic property value changes on this project item.

EventHandler< ParentChangedEventArgs >	ParentChanged
	Occurs when the parent of this project item changes.

EventHandler< PathChangedEventArgs >	PathChanged
	Occurs when the path of this project item changes.

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDescendantDynamicPropertyChanged
	Occurs before a dynamic property value changes on this project item or any of its descendants.

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDynamicPropertyChanged
	Occurs before a dynamic property value changes on this project item.

EventHandler< CollectionChangedEventArgs< string > >	PropertyCollectionChanged
	Occurs when a property is added to or removed from this project item.

EventHandler< ReplaceEventArgs >	Replacing
	Occurs when this project item is being replaced.

EventHandler	ThumbnailChanged
	Occurs when the thumbnail of this project item changes.

EventHandler	ValidityChanged
	Occurs when the validity state of this project item changes.

Detailed Description

Configure trigger actions.

See also: TriggerNodeComponent, TriggerConditionItem, NodeComponentHost

Examples

To create a dispatch message action and set the Message Type (DispatchMessageActionMessageType), Target Item (RoutingTarget), and Action Delay (Delay) properties:

// OKPropertyNameUsage

        // This example creates two Page nodes, Intro and Main, in the RootPage node, and sets the Default Subpage
        // property of the RootPage node to Intro. It then adds a Navigate to Page action to the Page Activated trigger
        // in the Intro Page node. The action is set off after a delay of two seconds and navigates to the Main Page node.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the RootNode node in the Screens/Screen node.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Create a Page Host node named RootPage in the RootNode node.
            var rootPage = studio.ActiveProject.CreateProjectItem<PageHost>(rootNode.GenerateUniqueChildName("RootPage"), rootNode);
            // Create a Page node named Intro in the RootPage node.
            var introPage = studio.ActiveProject.CreateProjectItem<Page>(rootPage.GenerateUniqueChildName("Intro"), rootPage);
            // Set the Default Subpage property of the RootPage node to the Intro node.
            rootPage.Set(Properties.PageHostDefaultSubPage.Name, "Intro");
            // Create a Page node named Main in the RootPage node.
            studio.ActiveProject.CreateProjectItem<Page>(rootPage.GenerateUniqueChildName("Main"), rootPage);
            // Get the first Page Activated trigger in the Intro Page node.
            var pageActivatedTrigger =
                introPage.Triggers.First(trigger => trigger.Get(
                        Properties.TriggerMessageType) == studio.ActiveProject.MessageTypeLibrary.GetItemByName("Message.Page.Activated"));
            // In the Page Activated trigger create a trigger action, and set:
            // * Trigger Action Type to Dispatch Message Action
            // * Message Type to Navigate To Page
            var navigateToPageAction = pageActivatedTrigger.CreateAction(studio.ActiveProject.TriggerActionTypeLibrary.GetItemByName("Kanzi.DispatchMessageAction"));
            navigateToPageAction.DispatchMessageActionMessageType = studio.ActiveProject.MessageTypeLibrary.GetItemByName("Message.Page.Navigate");
            // In the Navigate To Page action use a relative path to set Target Item to the Main Page node.
            navigateToPageAction.RoutingTarget = new NodeReference<Page>("../Main");
            // In the Navigate To Page action set Action Delay to 2000 ms.
            navigateToPageAction.Delay = 2000;
        }

Member Function Documentation

◆ SetForwardArgument()

void SetForwardArgument	(	string	argumentPropertyName,
		EventArgumentValueTypeEnum	argumentValueType,
		object	value )

Sets the message trigger argument to either a fixed value or to take the value from a property that you set.

Parameters

argumentPropertyName	Message argument name
argumentValueType	Message argument value type: FIXED for the fixed value FORWARD_TRIGGER_ARGUMENT or FORWARD_PROPERTY for the forward argument
value	For the fixed value argument: data type. For the forward arguments: property type.

◆ SetForwardArguments()

void SetForwardArguments ( IEnumerable< Property > argumentPropertyTypes )

Sets the trigger arguments.

Property Documentation

◆ Delay

int Delay

getset

Gets or sets the delay in milliseconds after which the trigger sets off the action.

◆ DispatchMessageActionMessageType

MessageType DispatchMessageActionMessageType

getset

Gets or sets the Message Type.

See also: Project.MessageTypeLibrary

◆ PropertyTypes

new TriggerActionItemProperties PropertyTypes

get

Implements ProjectItem.

◆ RoutingTarget

ProjectItemReference<ExportedPropertyContainerItem> RoutingTarget

getset

Gets or sets the Target Item to which the action dispatches the message.

◆ TriggerActionType

TriggerActionType TriggerActionType

get

Gets the Trigger Action Type.

See also: Project.TriggerActionTypeLibrary

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SetForwardArgument()

◆ SetForwardArguments()

Property Documentation

◆ Delay

◆ DispatchMessageActionMessageType

◆ PropertyTypes

◆ RoutingTarget

◆ TriggerActionType