<< Click to Display Table of Contents >> VpeRenderRTFStream |
[Professional Edition and above]
Computes the dimensions of a given RTF stream, based on the method VpeWriteRTFFile().
int VpeRenderRTFStream(
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, y2 may be set to VFREE
Returns:
The method returns one of the following values, indicating the AutoBreak status:
Constant Name |
Value |
Comment |
RENDER_NO_BREAK |
0 |
NO Auto Break will occur |
RENDER_BREAK |
1 |
Auto Break will occur |
RENDER_SKIP_BREAK |
2 |
Auto Break will occur, but no text will be placed on the current page, all text will be skipped to the next page (VRENDERWIDTH and VRENDERHEIGHT are not set) |
Remarks:
VFREE: only the y2 coordinate may be set to VFREE, not x2.
In case of an error, LastError is set.
The computed dimensions can be retrieved with
VpeGet(hDoc, VRENDERWIDTH)
VpeGet(hDoc, VRENDERHEIGHT)
"Rendering Objects" in the Programmer's Manual