TComplexRender Class

Special helper class to render formatted list items.

TComplexRender = class;

File

ecComplRend

Description

This class is used to render formatted items in TAutoCompletePopup component and to render formatted hint text of syntax memo.

It allows:

Images.
Columns with aligning.
Styles.

Text macros which can be used to format items:

/I#/- image, where # - image index

/S#/- style changing, where # - style number. Number 0 means no style (i.e. default font is used), number 1 is style with index 0 in Styles collection. Style is applied to all text up to the end of item (line) or to the next entry of /S#/ macro.

/T/ - columns separators. Specifies column break and alignment in the next column (text after macro). If this macro is at the start of item it specifies only alignment of the first column.

/T/ - left aligned column

/TR/- right aligned column

/TC/- center aligned column

/X/ - tag defined at runtime using OnGetCustomElem event.

Mapping of items.

It is possible to order and hide lines (items) using index mapping.

To manage it use methods: AddIndex, ClearIndex, ReleaseIndex.

Group

Classes

Topics

Topic	Description
TComplexRender Methods	The methods of the TComplexRender class are listed here.
TComplexRender Properties	The properties of the TComplexRender class are listed here.
TComplexRender Events	The events of the TComplexRender class are listed here.

Legend

	Method
	protected
	virtual
	Property
	read only
	Event

TComplexRender Events

TComplexRender Events	Description
OnGetCustomElem	Occurs when custom tag is detected in formatting string.

TComplexRender Methods

TComplexRender Methods	Description
AddCustomElem	Calls OnGetCustomElem event and adds formatting element to the item.
AddIndex	Adds item to visible items list.
ClearIndex	Creates or clears index mapping. All items are invisible. Visible items should be added by AddIndex method.
Create	Creates and initializes a TComplexRender instance.
CustomTagCount	Returns number of custom tags /X/ (defined at runtime) in the item string.
Destroy	Destroys an instance of TComplexRender.
ItemHeight	Returns height of the item.
ItemWidth	Returns width of visible item.
MapIndex	Returns item index of visible item with number Index.
ParseItem	Parses item string and creates corresponding description object.
ParseItems	Parses all items and updates column widths.
ReleaseIndex	Removes mapping of items. All items are visible in the original order.
UpdateColumns	Calculates width of columns.
VisibleCount	Returns number of visible items.

TComplexRender Properties

TComplexRender Properties	Description
Canvas	Specifies Canvas where items are drawn.
ColumnSpace	Specifies additional space between columns.
Font	Specifies default font.
IndexMap	List of mapped indexes.
Formatted	Specifies whether items should be parsed to get formatting data.
Height	Returns Height of all visible items.
Images	Specifies image list.
Items	Specifies items.
MaxItemHeight	Returns maximum height list of visible items.
Styles	Specifies styles collection.
Width	Returns width of all visible items.
WithColumns	Specifies whether columns widths should be calculated.

Links

Classes, Legend, Members, Topics, TComplexRender Methods, TComplexRender Properties, TComplexRender Events, TComplexRender Events, TComplexRender Methods, TComplexRender Properties

Contents | Index

What do you think about this topic? Send feedback!