Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose

The state-election macro is used to restrict the list of possible states available from the state selection drop-down box. The user can select from the current state along with those listed with the macro. This macro must be used inside of a {state} macro.

Info
titleNote

This macro cannot be used when the {approval} macro is also present.

Syntax

Code Block
languagenone
title{state-selection} Syntax
{state:state_name}
   {state-selection:states=state_name1[,state_name2][,state_name3]...}
{state}

Parameters

Parameters

Mandatory

Default

Description

states

Yes

Comma-delimited list of states to display in the current state. All states listed must be defined with a {state} macro in the current workflow.

Example

The code below restricts the state selections available when a page is in the Approved state to Approved (current state is always displayed), For Review, and Cancelled.

Code Block
languagenone
{state:Approved|taskable=true}
  {state-selection:states=For Review,Cancelled}
{state}