flow:interview

This component embeds a Flow interview in the page.

Example 

1<!-- Page: -->
2<apex:page controller="exampleCon">
3<!-- embed a simple flow -->
4	<flow:interview name="my_flow" interview="{!my_interview}"></flow:interview>
5	<!-- get a variable from the embedded flow using my_interview.my_variable -->
6	<apex:outputText value="here is my_variable : {!my_interview.my_variable}"/>
7</apex:page>
8
9/*** Controller ***/
10public class exampleCon {
11    Flow.Interview.my_flow my_interview {get; set;}
12}

Attributes 

Attribute NameAttribute TypeDescriptionRequired?API VersionAccess
allowShowPauseBooleanA Boolean value that allows the flow to display the Pause button. The Pause button appears on a flow screen only if this attribute is set to true for the <flow:interview> component, the ‘Let Users Pause Flows’ setting is enabled for your organization, and the currently displayed screen has been configured to show the Pause button. 33.0
buttonLocationStringThe area of the page block where the navigation buttons should be rendered. Possible values include ‘top’, ‘bottom’, or ‘both’. If not specified, this value defaults to ‘both’. 21.0
buttonStyleStringOptional style applied to the command buttons. Can only be used for in-line styling, not for CSS classes. 21.0
finishLocationApexPages.PageReferenceA PageReference that can be used to determine where the flow navigates when it finishes. 21.0
idStringAn identifier that allows the component to be referenced by other components in the page. 14.0global
interviewFlow.InterviewAn object that can be used to represent the FlowInterview. 21.0
nameStringThe unique name of the flow.Yes21.0
pausedInterviewIdStringId of a paused interview to resume. 33.0
renderedBooleanA Boolean value that specifies whether the component is rendered on the page. If not specified, this value defaults to true. 14.0global
rerenderObjectThe ID of one or more components that are redrawn when the result of the action method returns to the client. This value can be a single ID, a comma-separated list of IDs, or a merge field expression for a list or collection of IDs. 21.0
showHelpBooleanShould the help link be displayed. 21.0

See Also