Opens a document in a new modeless window using the appropriate WINDEV editor (word processor, spreadsheet, PDF reader or image editor).
The result can be retrieved via a WLanguage procedure ("callback") when the document editing window is closed.
Remark: Advantage over the asynchronous syntax of
OpenDocument: when
OpenDocumentAsynchronous is used, the document is always opened in asynchronous (non-blocking) mode, whether the WLanguage procedure is specified or not.
INTERNAL PROCEDURE OpenDocumentAsynchronous_Callback(sDoc, nStatusReport)
IF nStatusReport = odOpenModified THEN
Info(sDoc + " has been modified.")
END
END
IF NOT OpenDocumentAsynchronous(sDocument, "My document", ...
odOptionNone, "", OpenDocumentAsynchronous_Callback) THEN
Error("Unable to open the document.")
END
Syntax
<Result> = OpenDocumentAsynchronous(<Document> [, <Title> [, <Options> [, <Password> [, <WLanguage procedure>]]]])
<Result>: Boolean
- True if the type of document to be opened has been detected,
- False otherwise.
<Document>: Character string
Document to open. Corresponds to:- the full or relative path of document file to open.
- a buffer or an HFSQL memo containing the document to open. If the function returns the odOpenModified constant, the <Document> parameter will contain the buffer or HFSQL memo modified and saved in the document edit.
- a variable of type Document, xlsDocument or Image. If the function returns the odOpenModified constant, the <Document> parameter will contain the variable modified and saved during the document edit.
<Title>: Optional character string
Title of window opened to display the document. By default, this parameter corresponds to the title of current window.
<Options>: Optional Integer constant
Options for document opening:
| |
| odOptionMaxWindow | Document opened in read/write in a maximized window. |
odOptionNone
(default value) | Document opened in read/write in a non-maximized window. |
| odOptionReadOnly | Document opened in read-only. This constant can be combined with the odOptionNone and odOptionMaxWindow constants. If an image is opened with the odOptionReadOnly constant, all modification options will be accessible in the image editor and the user will be able to "Save as". For all other types of documents, all modification options proposed by the document editor are not accessible. |
<Password>: Optional character string
- Password to use if the file is protected,
- Empty string ("") if the file is not password-protected.
<WLanguage procedure>: Name of procedure or lambda procedure
Name of the WLangage procedure ("callback") called after the document editing window is closed. For more details on this procedure, see Parameters of the procedure used by OpenDocumentAsynchronous. This WLanguage procedure can correspond to:
- a name of a global procedure,
- a name of an internal procedure,
- a lambda procedure.