<Word Processing>.Add (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Word Processing functions

Prefix syntax

Add

Presentation

Example

See also

<Word Processing>.Add (Function)

In french: <Traitement de texte>.Ajoute

Adds at the end of a Word Processing control:

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

Example

// 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
WP_NoName1.Add(img)

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

Syntax

<Result> = <Word Processing control>.Add(<Object to add>)

<Result>: docFragment variable

docFragment variable with the added fragment.

<Word Processing control>: Control name

Name of the Word Processing control to use.

<Object to add>: Type of added object

Object to add:
Element: Name of the docElement variable that corresponds to the element to add.
Document: Name of the Document variable that corresponds to the document to add.
Paragraph: Name of the docParagraph variable that corresponds to the paragraph to add. 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.
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: wd280mdl.dll