SpreadCE Help

Macro control functions

[ ] indicates optional parameters

ARGUMENT([name_text], [type], [reference])
BREAK()
ELSE()
ELSE.IF(logical_test)
END.IF()
GOTO(reference)
IF(logical_test)
NEXT()
RETURN([value])
SET.NAME(name_text, [value])
SET.VALUE(reference, values)
WAIT(serial_number)
WHILE(logical_test)

Macro control functions

ARGUMENT([name_text], [type], [reference])

Defines an argument for a custom function.

name_text | The defined name that will be assigned to the argument. If this parameter is omitted then no name will be assigned.
type | The acceptable data type(s) for the argument value. It can be any combination of the following (to specify more than one value, add the numbers together):

1 | Number
2 | Text
4 | Logical
8 | Reference
16 | Error
64 | Array

| If this parameter is omitted it defaults to 7.
reference | The cell reference where the argument value will be stored. If this parameter is omitted then the argument value will not be stored.

BREAK()

Ends the processing of a WHILE-NEXT loop. The macro will continue with the statement after the NEXT function.

ELSE()

Introduces the block of statements to be processed when the corresponding IF or ELSE.IF condition is false.

ELSE.IF(logical_test)

Specifies another logical test that conditions a block of statements when the corresponding IF or ELSE.IF condition is false.

logical_test | An expression that results in TRUE or FALSE.

END.IF()

Specifies the end of the block of statements conditioned by the corresponding IF or ELSE.IF.

GOTO(reference)

Forces the macro to continue with the statement at the reference.

reference | The reference of the cell where macro execution is to continue.

IF(logical_test)

Specifies a logical test that conditions the execution of a block of statements.

logical_test | An expression that results in TRUE or FALSE.

NEXT()

Specifies the end of the block of statements contained in a WHILE-NEXT loop. The logical test in the corresponding WHILE statement will be done again, and if it is true then the block of statements in the loop will be executed again, otherwise execution will continue with the statement after this NEXT.

RETURN([value])

Forces the macro to end, and if it is a custom function then to return the specified value.

value | For custom functions, the value to be returned.

SET.NAME(name_text, [value])

Assigns a defined name to the specified value.

name_text | The defined name to use.
value | The value to be associated with the name. If this parameter is omitted then the name is deleted.

SET.VALUE(reference, values)

Stores the specified values in the specified cells on the macro sheet. Do not use this function to try to update cells on a worksheet.

reference | The cells where the values are to be stored.
values | The values to be stored.

WAIT(serial_number)

Forces the macro to wait until the date/time specified by the serial number.

serial_number | The date/time when the macro is to resume.

WHILE(logical_test)

Specifies a logical test that conditions the execution of a block of statements multiple times. The statements between the WHILE and NEXT functions will be repeated as long as the logical test returns the value TRUE.

logical_test | An expression that results in TRUE or FALSE.