peoplecodeapi - SetTransferAttributes

Syntax

SetTransferAttributes(enable_animation, [add_to_history], [back_label], [user_data], [qry_string_array])

Description

Use the SetTransferAttributes function to set certain transfer-related properties when executing a transfer to a different page or component. SetTransferAttributes can be invoked prior to the transfer (for example, in a FieldChange program) or after the transfer in the target component (for example, in a page Activate program).

Parameters

Field or Control	Definition
`enable_animation`	Specifies a Boolean value indicating whether to animate the transfer. The default value is False.
`add_to_history`	Specifies a Boolean value indicating whether to track the transfer in the Back button history stack. The default value is True. Note: The Back button is a user interface widget that appears in the portal header of classic pages and in the fluid page banner; it is not the browserâs back button.
`back_label`	Specifies a custom label for the Back button as a string value.
`user_data`	Specify any additional transfer attributes as name/value pairs using the following format: `Name1@Value1;Name2@Value2;...;NameN@ValueN` Specify the empty string, "", when no additional attributes need to be set. Use the `returntolastpage` attribute to specify which page is displayed when returning to this component via the Back button: `returntolastpage@0` â The Back button returns the user to the first page of the component. This is the system default behavior for components. `returntolastpage@1` â The Back button returns the user to the last viewed page of the component. The `returntolastpage` attribute overrides any page navigation settings specified in Application Designer. For fluid components, this is set on the Fluid tab; see . For classic components, this is set on the Internet tab; see .
`qry_string_array`	Specifies an array of array of string containing name/value pairs to be used as query string parameters constituting the history record.

Returns

None.