<Document variable>.ToHTML (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Document variable>.ToHTML (Function)

In french: <Variable Document>.VersHTML

Converts a Document variable into an HTML file.

Example

d is Document = "text.docx"
IF MyDocument.ToHTML("text.htm") THEN
Info("Document converted to HTML format")
END

// Exports the content of a Word Processing control to HTML
// Click code of "HTML export" button
MyDocument is Document
MyDocument <- WP_MyDoc
MyDocument.ToHTML(fExeDir() + [fSep] + "wp.htm")

Syntax

<Result> = <Document to convert>.ToHTML([<Path>] [, <Managing the CSS styles>])

<Result>: Boolean or Buffer

If <Path> is specified:
True if the file was generated,
False otherwise. To get the details of the error, use ErrorInfo.
If <Path> is not specified, <Result> corresponds to a buffer containing the HTML code.

<Document to convert>: Document variable

Name of Document variable to use.

<Path>: Optional character string

Path of HTML file to generate. If the path is not specified, the HTML code is returned in buffer format.

<Managing the CSS styles>: Optional constant

Versions 24 and later
Style attributes to use:
dthWithCSS
(Default value) Applies external CSS styles
The CSS code is generated in a ".CSS" file external to the HTML page. This file is created in the same directory as the generated HTML page. It has the same name as the HTML page, with the ".CSS" extension. A link to this file is added into the HTML code of the page.
If the document contains images, these ones are saved in a sub-directory named like the generated HTML file.
dthWithoutCSS Applies inline CSS styles: the CSS code is generated and integrated into the HTML code of the generated page. Each tag contains the CSS styles applied to it.
If the document contains images, they are integrated and are encoded in base64.
This constant allows, for example, to create an HTML generation adapted to new email messaging.
Remark: if an image contained in an email is over 100 KB, it will be displayed as an attachment, even if it has been encoded in base64.
New in version 24
Style attributes to use:
dthWithCSS
(Default value) Applies external CSS styles
The CSS code is generated in a ".CSS" file external to the HTML page. This file is created in the same directory as the generated HTML page. It has the same name as the HTML page, with the ".CSS" extension. A link to this file is added into the HTML code of the page.
If the document contains images, these ones are saved in a sub-directory named like the generated HTML file.
dthWithoutCSS Applies inline CSS styles: the CSS code is generated and integrated into the HTML code of the generated page. Each tag contains the CSS styles applied to it.
If the document contains images, they are integrated and are encoded in base64.
This constant allows, for example, to create an HTML generation adapted to new email messaging.
Remark: if an image contained in an email is over 100 KB, it will be displayed as an attachment, even if it has been encoded in base64.
Style attributes to use:
dthWithCSS
(Default value) Applies external CSS styles
The CSS code is generated in a ".CSS" file external to the HTML page. This file is created in the same directory as the generated HTML page. It has the same name as the HTML page, with the ".CSS" extension. A link to this file is added into the HTML code of the page.
If the document contains images, these ones are saved in a sub-directory named like the generated HTML file.
dthWithoutCSS Applies inline CSS styles: the CSS code is generated and integrated into the HTML code of the generated page. Each tag contains the CSS styles applied to it.
If the document contains images, they are integrated and are encoded in base64.
This constant allows, for example, to create an HTML generation adapted to new email messaging.
Remark: if an image contained in an email is over 100 KB, it will be displayed as an attachment, even if it has been encoded in base64.

Business / UI classification: UI Code

Component: wd260mdl.dll