Interface FindReplaceOptions

Used for the find/replace dialog.

interface FindReplaceOptions {
    autoFocus?: boolean;
    findOptions?: FindOptions;
    replace?: boolean;
    replaceOptions?: ReplaceOptions;
    replaceText?: string | null;
    scope?: CommandContext.FindScopeOptions;
}

Index

Properties

autoFocus? findOptions? replace? replaceOptions? replaceText? scope?

Properties

`Optional`autoFocus

autoFocus?: boolean

If true the operation will signal to the ui container to autoFocus.

Remarks

For replaceAll this is ignored.

`Optional`findOptions

findOptions?: FindOptions

Options for find.

`Optional`replace

replace?: boolean

If replacing with null then set to true.

`Optional`replaceOptions

replaceOptions?: ReplaceOptions

Options for replace.

`Optional`replaceText

replaceText?: string | null

The text to replace the found text with.

`Optional`scope

scope?: CommandContext.FindScopeOptions

Default value 'Sheet'