Command WR GET PICTURE IN PAGE INFO

4D Write

WR GET PICTURE IN PAGE INFO

version 2004 (Modified)


WR GET PICTURE IN PAGE INFO (area; pictureNumber; page; behind; firstPage; horizPos; verticalPos; width; height; origWidth; origHeight)

ParameterTypeDescription
areaLongint4D Write area
pictureNumberLongintPicture number
pageLongintPicture location
behindInteger0=Picture is in front of the text,
1=Picture is behind the text
firstPageInteger***Obsolete, do not use***
horizPosNumberHorizontal position in the page
verticalPosNumberVertical position in the page
widthNumberCurrent width of the picture
heightNumberCurrent height of the picture
origWidthNumberOriginal width of the picture
origHeightNumberOriginal height of the picture

Description

The WR GET PICTURE IN PAGE INFO command returns information about the picture whose number was passed in pictureNumber, as it currently appears in the 4D Write area referenced by area.

Warning: this command should not be used with pictures that are part of the text flow.

page allows you to know in which page the picture is displayed.

If page is greater than -1, the picture is displayed in the page whose number was returned. This value takes into account the page numbering as it is currently defined.

If page equals -11, the picture is visible on the right-hand pages if the even- and odd-numbered headers are different; otherwise, it is visible on every page.

If page equals -12, the picture is visible on the left-hand pages if the even- and odd-numbered headers are different.

behind

If behind is equal to 0, the picture is in front of the text.

If behind is equal to 1, the picture is behind the text.

firstPage

This parameter is kept only for compatibility reasons and should not be used starting with version 2004.

horizPos and vertPos return the coordinates of the picture's upper left corner in relation to the upper left corner of the page. Those values are expressed in the current default units for the document.

width and height return the current dimensions of the picture.

origWidth and origHeight return the original dimensions of the picture before any modification. If the picture was not resized, origWidth and origHeight return the same values as width and height. Those values are expressed in the current default units for the document.

Note: It may be convenient to change the current unit to pixels for some computations.

Example

See the example for the WR SET PICTURE IN PAGE INFO command.

See Also

WR DELETE PICTURE IN PAGE, WR GET PICTURE SIZE, WR SET PICTURE IN PAGE INFO.