<Word Processing>.Insert (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Word Processing>.Insert (Function)

In french: <Traitement de texte>.Insère

Inserts an object in a Word Processing control. The objects that can be used are:

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

Example

// Inserts an image cursor location
// Select the image file
sFile is string
sFile = fImageSelect(fCurrentDir(), "", ...
"Insert 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
img = sFile

// Declare an Image element (that will be inserted into the document)
elt is docElement
elt.Type = typeDocElementImage
elt.Image.BufferImage = img
elt.Image.Wrapping = docWrappingAlignedOnText

// Calculate the width and height of the image found in the element
// The image size is expressed in pixels in the Image variable.
// This size is converted into mm in the element (unit used in a document)
elt.Image.Width = img.Width * 25.4 / 96.0
elt.Image.Height = img.Height * 25.4 / 96.0
// Image position
elt.Image.X = 0
elt.Image.Y = 0

WP_MyDocument.Insert(WP_MyDocument.Cursor, elt)

doc is Document <- WP_MyDocument.Value
// Find the bookmark position
fragmentBookmark is docFragment = doc.Bookmark["Bookmark 1"]
IF fragmentBookmark <> Null THEN
// Insert text at the end of bookmark
let nInsertionPosition = fragmentBookmark.EndPosition
// Actual insertion
WP_MyDocument.Insert(nInsertionPosition, "Text to insert at bookmark position")
ELSE
Erreur("'Bookmark 1' bookmark not found in the document")
END

Syntax

Inserting an object at a position Hide the details

<Result> = <Word Processing control>.Insert(<Position> , <Element>)

<Result>: docFragment variable

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

<Word Processing control>: Control name

Name of a Word Processing control to use

<Position>: Integer

Position where the element will be inserted. This position is expressed in number of characters.

<Element>: Type corresponding to the element to insert

Element to insert:
Element: Name of the docElement variable that corresponds to the element to insert.
Document: Name of the Document variable that corresponds to the document to insert.
Paragraph: Name of the docParagraph variable that corresponds to the paragraph to insert.
Text in character string format: Text to Insert.
Versions 24 and later
You can use the following constants in the insertion text 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 to.
New in version 24
You can use the following constants in the insertion text 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 to.
You can use the following constants in the insertion text 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 to.
Image: Name of the Image variable that will be inserted at the specified position.
Fragment: Name of the docFragment variable that will be inserted at the specified position.

Component: wd270mdl.dll