ReplaceOptions

ReplaceOptions class

Represent the replace options.

class ReplaceOptions;

Constructors

Constructor	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
caseSensitive	boolean	Indicates if the searched string is case sensitive.
matchEntireCellContents	boolean	Indicates whether to match entire cells contents
regexKey	boolean	Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
fontSettings	FontSetting[]	The rich formatted settings for the replaced text.
styleFlags	StyleFlag[]	Gets and sets flags of applying font settings.

Methods

Method	Description
getCaseSensitive()	@deprecated. Please use the ‘caseSensitive’ property instead. Indicates if the searched string is case sensitive.
setCaseSensitive(boolean)	@deprecated. Please use the ‘caseSensitive’ property instead. Indicates if the searched string is case sensitive.
getMatchEntireCellContents()	@deprecated. Please use the ‘matchEntireCellContents’ property instead. Indicates whether to match entire cells contents
setMatchEntireCellContents(boolean)	@deprecated. Please use the ‘matchEntireCellContents’ property instead. Indicates whether to match entire cells contents
getRegexKey()	@deprecated. Please use the ‘regexKey’ property instead. Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
setRegexKey(boolean)	@deprecated. Please use the ‘regexKey’ property instead. Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
getFontSettings()	@deprecated. Please use the ‘fontSettings’ property instead. The rich formatted settings for the replaced text.
setFontSettings(FontSetting[])	@deprecated. Please use the ‘fontSettings’ property instead. The rich formatted settings for the replaced text.
getStyleFlags()	@deprecated. Please use the ‘styleFlags’ property instead. Gets and sets flags of applying font settings.
setStyleFlags(StyleFlag[])	@deprecated. Please use the ‘styleFlags’ property instead. Gets and sets flags of applying font settings.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

caseSensitive

Indicates if the searched string is case sensitive.

caseSensitive : boolean;

matchEntireCellContents

Indicates whether to match entire cells contents

matchEntireCellContents : boolean;

Remarks

The default value is true.

regexKey

Indicates whether the searched key is regex. If true then the searched key will be taken as regex.

regexKey : boolean;

fontSettings

The rich formatted settings for the replaced text.

fontSettings : FontSetting[];

styleFlags

Gets and sets flags of applying font settings.

styleFlags : StyleFlag[];

getCaseSensitive()

@deprecated. Please use the ‘caseSensitive’ property instead. Indicates if the searched string is case sensitive.

getCaseSensitive() : boolean;

setCaseSensitive(boolean)

@deprecated. Please use the ‘caseSensitive’ property instead. Indicates if the searched string is case sensitive.

setCaseSensitive(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getMatchEntireCellContents()

@deprecated. Please use the ‘matchEntireCellContents’ property instead. Indicates whether to match entire cells contents

getMatchEntireCellContents() : boolean;

Remarks

The default value is true.

setMatchEntireCellContents(boolean)

@deprecated. Please use the ‘matchEntireCellContents’ property instead. Indicates whether to match entire cells contents

setMatchEntireCellContents(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is true.

getRegexKey()

@deprecated. Please use the ‘regexKey’ property instead. Indicates whether the searched key is regex. If true then the searched key will be taken as regex.

getRegexKey() : boolean;

setRegexKey(boolean)

@deprecated. Please use the ‘regexKey’ property instead. Indicates whether the searched key is regex. If true then the searched key will be taken as regex.

setRegexKey(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getFontSettings()

@deprecated. Please use the ‘fontSettings’ property instead. The rich formatted settings for the replaced text.

getFontSettings() : FontSetting[];

Returns

FontSetting[]

setFontSettings(FontSetting[])

@deprecated. Please use the ‘fontSettings’ property instead. The rich formatted settings for the replaced text.

setFontSettings(value: FontSetting[]) : void;

Parameters:

Parameter	Type	Description
value	FontSetting[]	The value to set.

getStyleFlags()

@deprecated. Please use the ‘styleFlags’ property instead. Gets and sets flags of applying font settings.

getStyleFlags() : StyleFlag[];

Returns

StyleFlag[]

setStyleFlags(StyleFlag[])

@deprecated. Please use the ‘styleFlags’ property instead. Gets and sets flags of applying font settings.

setStyleFlags(value: StyleFlag[]) : void;

Parameters:

Parameter	Type	Description
value	StyleFlag[]	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;