[]
        
(Showing Draft Content)

C1.C1Preview.C1PrintDocument.RenderBlockText

RenderBlockText Method

RenderBlockText(string)

Renders a block of text into the block flow of the current document.

Declaration
public bool RenderBlockText(string text)
Public Function RenderBlockText(text As String) As Boolean
Parameters
Type Name Description
string text

The text to render.

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

The width of the rendered block is set to the width of the page (or column for multi-column layouts), which is equivalent to setting the Width of a RenderObject to "parent.width".

The height of the rendered block is set to auto, which is equivalent to setting the Height of a RenderObject to Auto or "auto".

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, Style)

Renders a block of text into the block flow of the current document, using the specified Style.

Declaration
public bool RenderBlockText(string text, Style style)
Public Function RenderBlockText(text As String, style As Style) As Boolean
Parameters
Type Name Description
string text

The text to render.

Style style

The style to use (can be null).

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, Font, Color, AlignHorzEnum)

Renders a block of text into the block flow of the current document, using the specified font, text color and horizontal alignment.

Declaration
public bool RenderBlockText(string text, Font font, Color textColor, AlignHorzEnum horzAlign)
Public Function RenderBlockText(text As String, font As Font, textColor As Color, horzAlign As AlignHorzEnum) As Boolean
Parameters
Type Name Description
string text

The text to render.

Font font

The Font to use (can be null).

Color textColor

The text color to use.

AlignHorzEnum horzAlign

The horizontal text alignment to use.

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, Font)

Renders a block of text into the block flow of the current document, using the specified font.

Declaration
public bool RenderBlockText(string text, Font font)
Public Function RenderBlockText(text As String, font As Font) As Boolean
Parameters
Type Name Description
string text

The text to render.

Font font

The Font to use (can be null).

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, Font, Color)

Renders a block of text into the block flow of the current document, using the specified font and text color.

Declaration
public bool RenderBlockText(string text, Font font, Color textColor)
Public Function RenderBlockText(text As String, font As Font, textColor As Color) As Boolean
Parameters
Type Name Description
string text

The text to render.

Font font

The Font to use (can be null).

Color textColor

The text color to use.

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, Font, AlignHorzEnum)

Renders a block of text into the block flow of the current document, using the specified font and horizontal alignment.

Declaration
public bool RenderBlockText(string text, Font font, AlignHorzEnum horzAlign)
Public Function RenderBlockText(text As String, font As Font, horzAlign As AlignHorzEnum) As Boolean
Parameters
Type Name Description
string text

The text to render.

Font font

The Font to use (can be null).

AlignHorzEnum horzAlign

The horizontal text alignment to use.

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, AlignHorzEnum)

Renders a block of text into the block flow of the current document, using the specified horizontal alignment.

Declaration
public bool RenderBlockText(string text, AlignHorzEnum horzAlign)
Public Function RenderBlockText(text As String, horzAlign As AlignHorzEnum) As Boolean
Parameters
Type Name Description
string text

The text to render.

AlignHorzEnum horzAlign

The horizontal text alignment to use.

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, Color)

Renders a block of text into the block flow of the current document, using the specified text color.

Declaration
public bool RenderBlockText(string text, Color textColor)
Public Function RenderBlockText(text As String, textColor As Color) As Boolean
Parameters
Type Name Description
string text

The text to render.

Color textColor

The text color to use.

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also

RenderBlockText(string, object, object, Style)

Renders a block of text with the specifed width and height into the block flow of the current document, using the specified Style.

Declaration
public bool RenderBlockText(string text, object width, object height, Style style)
Public Function RenderBlockText(text As String, width As Object, height As Object, style As Style) As Boolean
Parameters
Type Name Description
string text

The text to render.

object width

The width of the block to render (if null, parent width is used).

object height

The height of the block to render (if null, auto height is used).

Style style

The style to use (can be null).

Returns
Type Description
bool

true if no warnings were generated by this call, false otherwise.

Remarks

See RenderBlockText(string) for details on how the width and height of the text block are set.

This method can only be used between calls to StartDoc() and EndDoc() methods on the current document. For details, see RenderBlock(RenderObject).

See Also