ReplaceOptions
ReplaceOptions class
Represent the replace options.
class ReplaceOptions;
Constructors
| Name | Description |
|---|---|
| constructor() | Default Constructor. |
Methods
| Method | Description |
|---|---|
| getCaseSensitive() | Indicates if the searched string is case sensitive. |
| setCaseSensitive(boolean) | Indicates if the searched string is case sensitive. |
| getMatchEntireCellContents() | Indicates whether to match entire cells contents |
| setMatchEntireCellContents(boolean) | Indicates whether to match entire cells contents |
| getRegexKey() | Indicates whether the searched key is regex. If true then the searched key will be taken as regex. |
| setRegexKey(boolean) | Indicates whether the searched key is regex. If true then the searched key will be taken as regex. |
| getFontSettings() | The rich formatted settings for the replaced text. |
| setFontSettings(FontSetting[]) | The rich formatted settings for the replaced text. |
| getStyleFlags() | Gets and sets flags of applying font settings. |
| setStyleFlags(StyleFlag[]) | Gets and sets flags of applying font settings. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
getCaseSensitive()
Indicates if the searched string is case sensitive.
getCaseSensitive() : boolean;
setCaseSensitive(boolean)
Indicates if the searched string is case sensitive.
setCaseSensitive(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMatchEntireCellContents()
Indicates whether to match entire cells contents
getMatchEntireCellContents() : boolean;
Remarks
The default value is true.
setMatchEntireCellContents(boolean)
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()
Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
getRegexKey() : boolean;
setRegexKey(boolean)
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()
The rich formatted settings for the replaced text.
getFontSettings() : FontSetting[];
Returns
setFontSettings(FontSetting[])
The rich formatted settings for the replaced text.
setFontSettings(value: FontSetting[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FontSetting[] | The value to set. |
getStyleFlags()
Gets and sets flags of applying font settings.
getStyleFlags() : StyleFlag[];
Returns
setStyleFlags(StyleFlag[])
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;