ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Word Processing functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Opens a Word Processing file (docx format) in Read/Write mode. The docx file is opened and locked until it is closed.
Remark: To create a docx file without using an initial file, all you have to do is create a Document variable (in this case, DocOpen is useless).
Example
// Using a Document variable
d is Document
d = DocOpen("C:\Users\test\Documents\file.docx")
 
IF ErrorOccurred() THEN
Error(ErrorInfo())
RETURN
END
// Using a Word Processing control
DocOpen(WP_MyWP, "C:\Users\test\Documents\file.docx")
 
IF ErrorOccurred() THEN
Error(ErrorInfo())
RETURN
END
Syntax

Associating a docx file with a Document variable Hide the details

<Result> = DocOpen(<Document source> [, <Password>])
<Result>: Document variable
Name of Document variable corresponding to the docx file. This variable can be used in all the DocXXX functions.
In an error occurs, the ErrorOccurred variable is set to True and ErrorInfo returns the details of the error.
<Document source>: Type corresponding to the source
Corresponds to one of the following elements:
  • Full or relative path of docx file to open (up to 260 characters).
  • Name of the Buffer variable with the docx document to display in the Word Processing control.
  • Name of the memo item with the docx document to display in the Word Processing control. This parameter has the following format: <Data file> <Item>.
<Password>: Optional character string
Password to open the docx file to use (if the file is protected by a password).
WINDEV

Associating a docx file with a Word Processing control Hide the details

<Result> = DocOpen(<Word Processing control> , <Document source> [, <Password>])
<Result>: Boolean
  • True if the docx file was opened in the Word Processing control,
  • False otherwise.
<Word Processing control>: Control name
Name of Word Processing control where the docx file will be opened.
<Document source>: Type corresponding to the source
Corresponds to one of the following elements:
  • Full or relative path of docx file to open (up to 260 characters).
  • Name of the Buffer variable with the docx document to display in the Word Processing control.
  • Name of the memo item with the docx document to display in the Word Processing control. This parameter has the following format: <Data file> <Item>.
<Password>: Optional character string
Password to open the docx file to use (if the file is protected by a password).
Business / UI classification: UI Code
Component: wd290mdl.dll
Minimum version required
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/31/2022

Send a report | Local help