<< Click to Display Table of Contents >> RenderRTFFile |
[Professional Edition and above]
Computes the dimensions of a given RTF text file, based on the method WriteRTFFile().
method integer VPE.RenderRTFFile(
VpeCoord Left,
VpeCoord Top,
VpeCoord Right,
VpeCoord Bottom,
string Text
)
VpeCoord Left, Top, Right, Bottom
position and dimensions, y2 may be set to VFREE
string FileName
the file with RTF text that is rendered
Returns:
The method returns one of the following values, indicating the AutoBreak status:
ActiveX / VCL |
Value |
Enum |
Comment |
RENDER_NO_BREAK |
0 |
NoPageBreak |
NO Auto Page Break will occur |
RENDER_BREAK |
1 |
PageBreak |
Auto Page Break will occur |
RENDER_SKIP_BREAK |
2 |
SkipPageBreak |
Auto Page Break will occur, but no text will be placed on the current page, all text will be skipped to the next page (nRenderWidth and nRenderHeight are not set) |
Remarks:
VFREE: only the Bottom coordinate may be set to VFREE, not the Right coordinate.
In case of an error, LastError is set.
The computed dimensions can be retrieved with the properties:
nRenderWidth and nRenderHeight
"Rendering Objects" in the Programmer's Manual