Click or drag to resize

AsyncTask Class

a task descriptor object that hold the information for a long running task (with progress dialog) and allows access to the log messages and progress information of the window
Inheritance Hierarchy

Namespace:  Articy.Api.Plugins
Assembly:  ArticyApp (in ArticyApp.dll) Version: 1.0.0
public class AsyncTask

The AsyncTask type exposes the following members.

Public methodAsyncTask
Create a task descriptor object
Public propertyAfterAsyncAction
An Action callback that is executed in the main UI thread after the background thread has finished. The progress window is still open at this point. May be null.
Public propertyAsyncAction
An action callback that executes the tasks main process in a background thread. The Result property is set to the return value of this action.
Public propertyBeforeAsyncAction
An Action callback to a method that is called before the progress window opens. It is called in the context of main UI thread. May be null. Return false to directly cancel the task before the progress dialog shows up
Public propertyCloseProgressMode
Defines if and when the progress window is closed after the task has finished. Defaults to NoError
Public propertyCommandDescriptor
The command descriptor at the time this task was created
Public propertyError
contains the exception of asynchronous background task if one was caught.
Public propertyInfoLid
The Loca-Id or literal text for the info area of the progress window
Public propertyMessagesVisible
current visibly state of the message area, can be changed from the background task
Public propertyName
The name of the task, will be used when logging an exception
Public propertyProgressBarVisible
current visibly state of the progress bar, can be changed from the background task
Public propertyResult
The result is set to the result of the AsyncAction return value. It will be set to false if an exception was caught from the AsyncAction. task to be used in the So the AfterAsyncAction action can react on that return value. For more complex handling you should use the UserData member
Public propertySelection
property that contains the selection at the time the command was executed to this task
Public propertyShowMessages
set to true if you want to open the dialog with visible messages
Public propertyShowProgressBar
set to true if you want to open the dialog with visible progress bar
Public propertyTitleLid
The Loca-Id or literal text of the title of the progress window
Public propertyUserData
an user defined parameter object for the task
Public methodAddMessage
Adds a string to the progress log
Public methodSetMaxProgress
set the maximum value for the progress bar
Public methodSetProgress
sets the current progress value
See Also