RTF Functions > VpeWriteBoxRTFStream

Same as VpeWriteRTFStream(), but pen- and box-settings are used. Outputs RTF text, which is read from a supplied stream, within a rectangle at position x, y, with the right border at x2 and the bottom border at y2. This is very useful for processing rich text stored in a database.

VpeCoord VpeWriteBoxRTFStream(

VpeHandle hDoc,

VpeHandle hStream,

VpeCoord x,

VpeCoord y,

VpeCoord x2,

VpeCoord y2

)

VpeHandle hDoc

Document Handle

VpeHandle hStream

Stream Handle

VpeCoord x, y, x2, y2

position and dimensions

Returns:

VFREE: only the y2 coordinate may be set to VFREE, not x2.

the bottom y-coordinate generated by the output

Remarks:

Keywords in the RTF stream override any VPE API properties. For example, if you set

"\f1 = Arial" and in the RTF stream it is defined as "\f1 = Times New Roman", then "\f1" will be "Times New Roman".

In case of an error, LastError is set.

VPE offers several methods to attach an object's position to margins and relative to the position of previously inserted objects. In addition Text, Rich Text and Picture objects are able to compute their dimensions automatically depending on their visual content.
For details please see "Dynamic Positioning" in the Programmer's Manual.