Skip to content
Spreadsheet Engine

SetDefinedNameOptions

type SetDefinedNameOptions<AbortOnError> = object;

AbortOnError extends true | false = false

abortOnError?: AbortOnError;

Return null and make no change if the formula has any errors, rather than making the defined name anyway and recording the error with addError.

false

qualifyUnprefixedReferences?: boolean;

Name the first sheet explicitly in any reference of a workbook-scoped name that names an address but no sheet. Set false to store the formula exactly as given.

true

sheet?: WorkSheet | null;

Sheet to scope the name to, or null for workbook scope.

null

validateNow?: boolean;

Validate the formula here. Set false only if the caller takes that on itself.

true