Find & Replace

Packages	`@univerjs/sheets-find-replace`

CORE

This interface class provides methods to find and replace text in the univer.

This class should not be instantiated directly. Use factory methods on univerAPI instead.

Overview

@univerjs/sheets-find-replace

Method	Description
`ensureCompleteAsync`	-
`findAll`	-
`findNext`	-
`findPrevious`	-
`getCurrentMatch`	-
`matchCaseAsync`	-
`matchEntireCellAsync`	-
`matchFormulaTextAsync`	-
`replaceAllWithAsync`	-
`replaceWithAsync`	-

APIs

Getters & Queries

`findAll`

Signature

findAll(): FRange[]

Returns

FRange[] — See signature above.

Source: @univerjs/sheets-find-replace

`findNext`

Signature

findNext(): Nullable<FRange>

Returns

any — See signature above.

Source: @univerjs/sheets-find-replace

`findPrevious`

Signature

findPrevious(): Nullable<FRange>

Returns

any — See signature above.

Source: @univerjs/sheets-find-replace

`getCurrentMatch`

Signature

getCurrentMatch(): Nullable<FRange>

Returns

any — See signature above.

Source: @univerjs/sheets-find-replace

Miscellaneous

`ensureCompleteAsync`

Signature

async ensureCompleteAsync(): Promise<Nullable<IFindComplete>>

Returns

Promise<Nullable<IFindComplete<IFindMatch<unknown>>>> — See signature above.

Source: @univerjs/sheets-find-replace

`matchCaseAsync`

Signature

async matchCaseAsync(matchCase: boolean): Promise<IFTextFinder>

Parameters

matchCase boolean — No description

Returns

Promise<IFTextFinder> — See signature above.

Source: @univerjs/sheets-find-replace

`matchEntireCellAsync`

Signature

async matchEntireCellAsync(matchEntireCell: boolean): Promise<IFTextFinder>

Parameters

matchEntireCell boolean — No description

Returns

Promise<IFTextFinder> — See signature above.

Source: @univerjs/sheets-find-replace

`matchFormulaTextAsync`

Signature

async matchFormulaTextAsync(matchFormulaText: boolean): Promise<IFTextFinder>

Parameters

matchFormulaText boolean — No description

Returns

Promise<IFTextFinder> — See signature above.

Source: @univerjs/sheets-find-replace

`replaceAllWithAsync`

Signature

async replaceAllWithAsync(replaceText: string): Promise<number>

Parameters

replaceText string — No description

Returns

Promise<number> — See signature above.

Source: @univerjs/sheets-find-replace

`replaceWithAsync`

Signature

async replaceWithAsync(replaceText: string): Promise<boolean>

Parameters

replaceText string — No description

Returns

Promise<boolean> — See signature above.

Source: @univerjs/sheets-find-replace

Table of Contents