Skip to Main Content
Return to Navigation

Scroll

These are the actions associated with the Scroll step type.

The Scroll ID field is required for all Scroll action types.

Action

Description

Takes an action based on the row specified by Key_Set.

Parameters

ret=&variable;

The return value. It returns the position index for the field acted upon, based on the row identified using Key_Set.

Specify the action in the Value column.

This table lists the valid values for the Action action.

Value

Description

ins

Insert a row. If the current row is the first row, then use the existing row.

ins+

Always insert a row.

delins

Delete all rows, and then insert into the first row.

del

Delete the row specified by the Key_Set action.

delall

Delete all rows. No further processing.

delsel

Look for the row and delete it. Do not add a fail if the row does not exist.

upd

Find a specified row to work with. If the row is not found, insert a new row or use the first row for the first time.

upd+

Find a specified row to work with. If is not found, always insert a new row.

sel

Find a row specified by the Key_Set action.

find

Use the scroll Find link. Format: find=text_to_find

not

Check that the row is not in the scroll. Add a Fail to the log if the row is found.

Definition

Description

Use the Definition action to override the default name object of scroll buttons and the scroll parent. This is necessary, for example, when a page uses custom objects (such as links or pushbuttons) to handle conventional scroll actions such as adding or deleting rows from the scroll.

Parameters

def=value;

One of the definition values. Example:

def=parent;

The following table gives valid values for the def parameter.

type=value;

Thestep type for the new action.

Example 1:

type=Image;

Example 2:

type=PushButton;
value=value;

The scroll parent variable or the new object recognition string.

Example 1:

value=&Scr1;

Example 2:

value=Name=$ICField3$newm$0$$img$0;

This table lists the valid values for the def parameter:

Value

Description

add

Override the Add new row button.

del

Override the Delete row button.

next

Override the Next button.

prev

Override the Previous button.

first

Override the First button.

last

Override the Last button.

parent

Reassign the parent for a specific scroll area.

Examples

This example uses the Definition action with the def=Add parameter to assign the Add action to the image $ICField3$newm$0$$mg$0:

Image: Example of a Definition action with def=Add parameter

This example illustrates using the Definition action with def=Add parameter.

Example of a Definition action with def=Add parameter

In this example the Definition action with a def=parent parameter reassigns the parent:

Image: Example of the Definition action with the def=parent parameter

This example illustrates using the Definition action with the def=parent parameter

Example of the Definition action with the def=parent parameter

ModalGrid_Close

Description

Closes a modal grid.

ModalGrid_Open

Description

Opens a modal grid.

Key_Set

Description

Defines each key field of a scroll. Use multiple Key_Set steps for scrolls with multiple key fields.

Specify the step type and field name as parameters. Specify the key value in the Value column.

Parameters

type=value;

The step type for the key field.

Example:

type=Text;
name=value;

The name of the key field.

Example

Image: Example of the Key_Set and Action actions

This example illustrates using Key_Set and Action

Example of the Key_Set and Action actions

Reset

Description

Resets all the scroll variables and closes the scroll section in the log.

RowCount

Description

Returns the number of rows for the defined scroll.

Example

Image: Example of RowCount action

This example illustrates using the RowCount action to perform a loop.

Example of RowCount action