Skip to main content
Version: 20 R7 BETA

OBJECT Get auto spellcheck

OBJECT Get auto spellcheck ( {* ;} object ) -> Function result

ParameterTypeDescription
*OperatorIf specified, object is an object name (string)If omitted, object is a variable or field
objectanyObject Name (if * is specified) or Variable or field (if * is omitted)
Function resultBooleanTrue = automatic spell-checking, False = no automatic spell-checking

This command is not thread-safe, it cannot be used in preemptive code.

Description

The OBJECT Get auto spellcheck command returns the status of the Auto spellcheck option for the object(s) designated by the object and * parameters for the current process.

If you pass the optional * parameter, this indicates that the object parameter is an object name (a string). If you do not pass this parameter, this indicates that the object is a variable or a field. In this case, you pass a reference instead of a name.

The command returns True when automatic spell-checking is enabled for the object and False when it is not.

See also

OBJECT SET AUTO SPELLCHECK