<Spreadsheet>.Replace (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Spreadsheet functions

Prefix syntax

Replace

Presentation

Example

See also

<Spreadsheet>.Replace (Function)

In french: <Tableur>.Remplace

Finds and replaces a value in a Spreadsheet control.

Remark: This operation can be canceled by the user via Ctrl + Z.

Example

// Replace VAT by Value A.T
nRepl is int = PSHEET_MySpreadsheet.Replace("VAT" , "Value A.T.")
IF nRepl = 0 THEN
Info("Not found")
ELSE
Info("[%nRepl%] elements have been replaced.")
END

Syntax

<Result> = <Spreadsheet control>.Replace(<Sought value> , <ReplaceBy> [, <Cell> [, <Options>]])

<Result>: Integer

Number of replacements done.
0 if no replacement was performed.

<Spreadsheet control>: Control name

Name of the Spreadsheet control to be used.

<Sought value>: Real or character string

Value to find in the Spreadsheet control in order to be replaced.

<ReplaceBy>: Real or character string

New value that will replace the sought value.

<Cell>: Optional character string

Name of cell to modify.
If this parameter is specified, only the corresponding values in this cell will be replaced.
If this parameter is not specified, all the corresponding values (in the current worksheet or in all worksheets, according to the <Options> parameters) will be modified.

<Options>: Optional Integer constant

Search options:
psheetSearchWithCase Search while taking the case into account.
psheetSearchContain "Contains" search.
psheetSearchInFormula Search in the formulas only.
psheetSearchExact "Exact" search.
psheetSearchCurrentWorksheet Search in the current worksheet.
psheetSearchNoCase Search ignoring the case.
psheetSearchAnyWorksheet Search in all worksheets of workbook.

By default, the search is performed according to the following combination of constants: psheetSearchWithCase + psheetSearchCurrentWorksheet + psheetSearchExact

Component: wd280obj.dll