DocSave (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DocSave (Function)

In french: DocSauve

Saves a document in "docx" format. The saved document remains open. To close it, you must use DocClose.

Caution: This documentation presents the last features of the Word Processing control. Make sure that all the necessary modules are updated.

Example

// Choose the directory and the backup name
sFileName is string = fSelect(CompleteDir(fExeDir()),"presentation.docx", ...
"Selecting DocX files","Docx file (*.docx)" + TAB + "*.docx" , "*.docx", fselCreate)

// Save the file
DocSave(WP_NoName1, sFileName)

IF ErrorOccurred THEN
Error(StringBuild("The %1 file was not saved.", sFileName), ErrorInfo())
RETURN
END

Syntax

<Result> = DocSave(<Document> [, <File path>])

<Result>: Boolean

True if the backup was performed,
False otherwise.

<Document>: Character string (with or without quotes)

Document to use. This document can correspond to:
a Document variable.
a Word Processing control.

<File path>: Optional character string (with quotes)

Full path and name of "docx" file.

If this parameter is specified, the file is saved at the specified location (the existing file is overwritten if necessary).
If the backup is successful, the Property FilePath of the Variable of type Document manipulated contains <HEX@ Path >. The "docx" file remains opened.
IF the "docx" document is saved with a path that differs from the initial one (corresponds to "Save as"), the source file is closed, the document is saved in the new file and the new "docx" file remains opened.
If this parameter is not specified, the path taken into account is the path specified in the FilePath property of the Variable of type Document manipulated.

Business / UI classification : UI Code

Component : wd260mdl.dll