API

[Top]  [Chapter]  [Previous]  [Next]

Predefined actions which are used by the toolbar

Description

In the PackageFile Manager you can click on "wpa Commands" to display a sorted table with the available action names. It can also automatically create C# template code or XML lines to be inserted in the "edit layout". This "edit layout" is used to create the toolbar and panels displayed by TextDynamic.

 

WPA actions can be used in your code as well. There are several methods to create a list of the available actions, to get the current, maybe localized, caption and hint and of course to execute the action.

Since all actions have an id we recommend to fill an array with the ids of the actions which are used by your application. Now you can use this index everywhere you need to executed or check an action.

The event OnUpdateGUI is very useful to update a custom menu or toolbar - you are not forced to use the one implemented inside of TextDynamic. Using the method wpaGetFlags you get the enabled/checked state of all actions in form of an array (OCX as WideString, .NET as Bytes[])

 

WPDLLInt.wpaCheck

This method is used to check the selected/hidden/disabled state for the action identified by the provided name.

WPDLLInt.wpaExec

Execute an action identified by an ID.

WPDLLInt.wpaGetFlags

This method retrieves the state of all WPA actions.

WPDLLInt.wpaProcess

Executes a named action.

WPDLLInt.wpaSetFlags

This method can be used to update the flags provided by wpaGetFlags.

 

IWPMemo.wpaCheck

IWPMemo.wpaExec

IWPMemo.wpaGetCaption

IWPMemo.wpaGetID

IWPMemo.wpaProcess

IWPMemo.wpaSetCaption

 

List of action names ..... ->


[idh_cat_wpa_actions.htm]    Copyright © 2007 by WPCubed GmbH