DocInsert (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Word Processing functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DocInsert (Function)

In french: DocInsère

Inserts an object into a Word Processing document or replaces the content of the current fragment. The objects that can be used are:

an element,
a document,
a paragraph,
a text,
an image,
a fragment,
a table of contents.

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

DocInsert(WP_MyDocument, 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
DocInsert(WP_MyDocument, nInsertionPosition, "Text to insert at bookmark position")
ELSE
Error("'Bookmark 1' bookmark not found in the document")
END

Syntax

Inserting an object at a position Hide the details

<Result> = DocInsert(<Document> , <Position> , <Element>)

<Result>: docFragment variable

docFragment variable with the inserted fragment.

<Document>: Document variable or character string

Document to use. This document corresponds to:
the name of a Word Processing control.
a variable of type Document.

<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.
Caution: The following elements of the inserted document are not preserved:
The default layout of the inserted document (e.g. margins).
The parameters of the main section of the inserted document (e.g. headers and footers).
Paragraph: Name of the docParagraph variable that corresponds to the paragraph to insert.
Text in character string format: Text to Insert.
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.

Replacing a fragment by an object (text, document, fragment, paragraph, ...) Hide the details

<Result> = DocInsert(<Fragment> , <Object to use>)

<Result>: docFragment variable

docFragment variable with the inserted fragment.

<Fragment>: docFragment variable

Name of the docFragment variable to be used. The content of this fragment will be replaced with the specified object.

<Object to use>: Variable corresponding to the object type

Objet replacing the fragment content. This object can correspond to:
a character string.
You can use the following constants in the 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.
the name of a variable of type docElement.
the name of a variable of type Document.
the name of a variable of type docParagraph.
the name of a variable of type Image.
the name of a variable of type docFragment.
the name of a variable of type docTableOfContents.

Business / UI classification: UI Code

Component: wd300mdl.dll