Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 3.88 KB

task-form.component.md

File metadata and controls

57 lines (46 loc) · 3.88 KB
Raw
Title Added Status Last reviewed
Task Form component
v2.0.0
Active
2020-04-21

Task Form component

Shows a form for a task.

Basic Usage

<adf-task-form 
    [taskId]="taskId">
</adf-task-form>

Class members

Properties

Name Type Default value Description
fieldValidators FormFieldValidator[] [] Field validators for use with the form.
readOnlyForm boolean false Toggles read-only state of the form. All form widgets render as read-only if enabled.
showCancelButton boolean true Toggle rendering of the Cancel button.
showFormCompleteButton boolean true Toggles rendering of the Complete outcome button.
showFormRefreshButton boolean true Toggles rendering of the Refresh button.
showFormSaveButton boolean true Toggles rendering of the Save outcome button.
showFormTitle boolean false Toggles rendering of the form title.
showFormValidationIcon boolean true Toggle rendering of the validation icon next to the form title.
taskId string (required) The id of the task whose details we are asking for.

Events

Name Type Description
cancel EventEmitter<void> Emitted when the "Cancel" button is clicked.
completed EventEmitter<void> Emitted when the form associated with the task is completed.
error EventEmitter<any> Emitted when an error occurs.
executeOutcome EventEmitter<FormOutcomeEvent> Emitted when any outcome is executed. Default behaviour can be prevented via event.preventDefault().
formCompleted EventEmitter<FormModel> Emitted when the form is submitted with the Complete outcome.
formContentClicked EventEmitter<ContentLinkModel> Emitted when the form field content is clicked.
formError EventEmitter<FormFieldModel[]> Emitted when the supplied form values have a validation error.
formLoaded EventEmitter<FormModel> Emitted when the form is loaded or reloaded.
formSaved EventEmitter<FormModel> Emitted when the form is submitted with the Save or custom outcomes.
showAttachForm EventEmitter<void> Emitted when the form associated with the form task is attached.
taskClaimed EventEmitter<string> Emitted when the task is claimed.
taskUnclaimed EventEmitter<string> Emitted when the task is unclaimed (ie, requeued)..

See also