AddTask

Return to Introduction  Previous page  Next page

Adds a task to a header. The task will be visible on the next redraw.

 

 

Prototypes:

AddTask(LONG HeaderID, STRING Title, LONG ActionFeq, <BYTE MimicButton>, <STRING IconName>, <BYTE DontMimicIcon>, <BYTE IsSeparator>),LONG,PROC

AddTask(STRING Title, LONG ActionFeq, BYTE MimicButton, STRING IconName, BYTE DontMimicIcon, STRING Tooltip, <BYTE IsSeparator>),LONG,PROC

 

Arguments:

HeaderID

A previously obtained ID for parent header the task should be added to. If you ommit this value (i.e. use the first prototype) the task will be added to the last added header.

Title

This is the screentext for this task

ActionFeq

The FEQ (Field Equate Label) for the control that should receive an EVENT:Accepted, when this task is clicked. Set this to zero if you don't want the task to activate a control.

MimicButton

Optional. If a button was specifed as the ActionFeq, you could set MimicButton to True. The task will then be hidden whenever the button is disabled. When the button is enabled, the task will be visible to the user. (Defaults to false)

IconName

Optional. The name of the icon that should be shown to the left of the task. If ommited, no icon is shown. NOTE: The icon MUST be linked into your application.

DontMimicIcon

Optional, If set to True and MimicButton is specified, the icon set in the template settings will be used instead of the icon of the mimiced button.

Tooltip

Tooltip for this task.

IsSeparator

Optional. If you set this to True, the task will become a separator

 

Return value:

This function returns a LONG, representing an ID for this task. The ID is only uniqe within its header. Tasks in different headers could have the same ID.

 

See also:

AddHeader

 

Example:

TaskPanel5.AddTask('Introduction', ?Button1{PROP:Feq}, False, 'user.ico',, 'This is a tooltip...')

 

 



Direct link to this page on our website: http://www.icetips.com/manuals/xptaskpanel/addtask.htm