<< Click to Display Table of Contents >> Navigation:  Text Block Object > VpeRenderTextBlock

[Not supported by the Community Edition]

This method is useful to compute space-requirements of a Text Block Object, without inserting it into a document. Using this method, your application can make decisions regarding the layout of a Text Block, for example to issue a page break in advance.

The method renders a portion of text from the beginning of a Text Block Object, with the specified number of text lines, according to the current width and font properties.

When you render a portion of a Text Block Object, the text is removed from the Text Block Object. With successive calls to this method, you can continue to render the next part in another column or on another page.

When you have finished rendering, you can call the method VpeTextBlockReset() to restore the whole original text you had initially supplied to the Text Block Object. This way you can re-use the Text Block Object, and call VpeWriteTextBlock() - and all of its other methods and properties - to insert it finally into the document.

VpeCoord VpeRenderTextBlock(

VpeHandle hDoc

VpeHandle hTextBlock,

int nLineCount

)

VpeHandle hDoc

Document Handle

VpeHandle hTextBlock

handle of the Text Block Object

int nLineCount

the number of text lines, which shall be rendered in the document

Returns:

The bottom coordinate of the rendered text.

Remarks:

All remarks of the method VpeWriteTextBlock() do also apply to this method.