alfresco-ng2-components/docs/start-form.component.md
Andy Stark bf6d0284e0 [ADF-1586] Added Core doc files (#2681)
* [ADF-1586] Added core doc files

* [ADF-1586] Added core doc files
2017-11-21 09:50:11 +00:00

1.5 KiB

Start Form component

Displays the Start Form for a process.

Start Form screenshot

Basic Usage

<adf-start-form
    [processDefinitionId]="currentProcessDef.id"
    (outcomeClick)="onOutcomeClick($event)">
</adf-start-form>

Properties

Name Type Default Description
processDefinitionId string Definition ID of the process to start.
processId string Process ID of the process to start.
showOutcomeButtons boolean true Should form outcome buttons be shown?
showRefreshButton boolean true
readOnlyForm boolean false Is the form read-only (ie, can't be edited)?

Events

Name Description
outcomeClick Emitted when the user clicks one of the outcome buttons that completes the form.

Details

The Start Process component uses the Start Form component to display the start form for the process.

The outcomeClick event is passed a string containing the ID of the outcome button that the user clicked. You can pass this value to the startProcess method (defined in the Process service) when activating the process, if necessary.