<Spreadsheet>.Save (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Spreadsheet>.Save (Function)

In french: <Tableur>.Sauve

Saves the content of a Spreadsheet control in a file in XLSX format.

Example

// Save the current file
PSHEET_Spreadsheet.Save("Workbook1.XLSX")

// Load the file
PSHEET_NoName1.Load("test.xlsx")
// Modify the file
PSHEET_NoName1["A","1"] = "modified"
// Save under a different name
// The "text1.xlsx" file already exists
IF PSHEET_NoName1.Save("test1.xlsx") = False THEN
// Before version 200051, the existing xlsx file is overwritten.
// From version 200051, the existing xlsx file is not modfified.
// The function returns False and an error
// To overwrite the file, use the psheetOverwriteAllowed constant
Error("File not saved " + ErrorInfo()
ELSE
Info("File saved")
END

Syntax

<Result> = <Spreadsheet control>.Save(<File to save> [, <Option> [, <Password>]])

<Result>: Boolean

True if the file of Spreadsheet control was saved,
False otherwise. ErrorInfo returns more details about the error.

<Spreadsheet control>: Control name

Name of Spreadsheet control to use.

<File to save>: Character string (with quotes)

Name and full path of XLSX file where the content of Spreadsheet control will be saved.

<Option>: Optional Integer constant

How to save the file if the file already exists:
0 (or nothing)
(Default behavior) If the XLSX file already exists and if it is not opened (in the Spreadsheet control or in another application), it is not saved.
psheetOverwriteAllowed If the XLSX file already exists and if it is not opened (in the Spreadsheet control or in another application), it is overwritten.

<Password>: Optional character string (with quotes)

Versions 24 and later
Password to be used to protect the XLSX file when opening it. This password must be specified to open the XLSX file.
New in version 24
Password to be used to protect the XLSX file when opening it. This password must be specified to open the XLSX file.
Password to be used to protect the XLSX file when opening it. This password must be specified to open the XLSX file.

Remarks

To open the ".xlxs" file saved with another application, it must be closed by <Spreadsheet>.Close.
The saved file can be reloaded in a Spreadsheet control via <Spreadsheet>.Load and xlsOpen.
This function can only be used on a Spreadsheet control found in a window.
Versions 23 and later
<Spreadsheet>.Save updates the ..FilePath property of Spreadsheet control by associating the name of loaded file to the Spreadsheet control.
New in version 23
<Spreadsheet>.Save updates the ..FilePath property of Spreadsheet control by associating the name of loaded file to the Spreadsheet control.
<Spreadsheet>.Save updates the ..FilePath property of Spreadsheet control by associating the name of loaded file to the Spreadsheet control.

Related Examples:

Unit examples (WINDEV): The Spreadsheet control

[ + ] Using the Spreadsheet control.
This example explains how to:
- load an xlsx file in a spreadsheet control,
- save the spreadsheet in a file,
- fill the control with data coming from the database,
- insert rows, columns,
- access the cells and handle them (modify their value, their style, ...),
- enter formulas,
- ...

Business / UI classification : UI Code

Component : wd250obj.dll