<Document variable>.Add (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Document variable>.Add (Function)

In french: <Variable Document>.Ajoute

Adds at the end of a Document variable:

an element,
a document, a paragraph,
a text,
an image,
a fragment.

Example

MyDocument is Document

// Adds an image
// Select the image file
sFile is string
sFile = fImageSelect(fCurrentDir(), "", "Add an image",
"JPEG (*.JPG)" + TAB + "*.jpg" + CR + "PNG (*.PNG)" + TAB +
"*.png" + CR + "All files (*.*)" + TAB + "*.*")

IF sFile = "" THEN
RETURN
END

// The image file is transferred into an Image variable
img is Image = sFile

// Add the image at the end of document
MyDocument.Add(img)

MyDocument is Document

// Add a page break
MyDocument.Add(Charact(12))

Syntax

<Result> = <Document>.Add(<Object to add>)

<Result>: docFragment variable

Versions 24 and later
docFragment variable with the added fragment.
New in version 24
docFragment variable with the added fragment.
docFragment variable with the added fragment.

<Document>: Document variable

Name of Document variable to use.

<Object to add>: Type of added object

Object to add:
Element: Name of the Variable of type docElement corresponding to the element to be added.
Document: Name of the Variable of type Document corresponding to the Document to be added.
Paragraph: Name of the Variable of type docParagraph corresponding to the paragraph to be added. This paragraph must have been retrieved from a document, it cannot be created from nothing because the array of paragraph elements is read-only.
Text in character string format: Text to add.
Versions 24 and later
You can use the following constants in the text to add to manage the different possible breaks:
docColumnBreak Adds a column break in a multicolumn section. If the section is not multicolumn, a page break is added.
docLineBreak Adds a line break.
docPageBreak Adds a page break.
docParagraphBreak Adds a paragraph break.
New in version 24
You can use the following constants in the text to add to manage the different possible breaks:
docColumnBreak Adds a column break in a multicolumn section. If the section is not multicolumn, a page break is added.
docLineBreak Adds a line break.
docPageBreak Adds a page break.
docParagraphBreak Adds a paragraph break.
You can use the following constants in the text to add to manage the different possible breaks:
docColumnBreak Adds a column break in a multicolumn section. If the section is not multicolumn, a page break is added.
docLineBreak Adds a line break.
docPageBreak Adds a page break.
docParagraphBreak Adds a paragraph break.
Image: Name of Image variable to add.
Fragment: Name of docFragment variable to add.

Component: wd260mdl.dll