TSyntaxTreeView Class

Shows text ranges structure in the memo that is specified in SyntaxMemo property.

TSyntaxTreeView = class(TCustomSyntaxTreeView);

File

ecSyntTree

Description

Using TSyntaxTreeView you can easily navigate through the text. To specify action when user double clicks on a node use ClickAction property.

To synchronize syntax tree with the caret position of the syntax memo set AutoSynchronize property to True. In this mode after changing caret position node that corresponds to the nearest text range will be selected in the tree view.

To make several tree view with different content use GroupIndex property.

Group

Classes

Topics

Topic	Description
IecSyntClient Methods	The methods of the IecSyntClient class are listed here.

IecSyntMemoClient Interface

Topic	Description
IecSyntMemoClient Methods	The methods of the IecSyntMemoClient class are listed here.

IecTextClient Interface

Topic	Description
IecTextClient Methods	The methods of the IecTextClient class are listed here.

TCustomSyntaxTreeView Class

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

TSyntaxTreeView Class

Topic	Description
TSyntaxTreeView Properties	The properties of the TSyntaxTreeView class are listed here.

Legend

	Method
	protected
	virtual
	Property
	Event

TCustomSyntaxTreeView Events

TCustomSyntaxTreeView Class

TCustomSyntaxTreeView Class	Description
OnAcceptRange	Occurs before processing text range for creating new associated tree node.
OnCreateTreeNode	Occurs when new Node is created for the text range Range.
OnLoadProgress	Occurs periodically during updating syntax tree content.
OnTreeUpdated	Occurs when syntax tree is fully updated.
OnCreateGroupNode	Called when new group tree node was created for the given text range.
OnSelectParentNode	Called when selecting parent node for the item Node and given text range.

IecSyntClient Methods

IecSyntClient Methods	Description
Finished	Called when syntax analysis is finished.
FormatChanged	Called when styles of syntax analyzer is changed.

IecSyntMemoClient Interface

IecSyntMemoClient Interface	Description
CaretPosChanged	Is called when caret position is changed.

IecTextClient Interface

IecTextClient Interface	Description
TextChanged	Called after text have been changed.

TCustomSyntaxTreeView Class

TCustomSyntaxTreeView Class	Description
AddNode	Adds new tree Node. This method should be used instead of TTreeNodes.AddChild method.
AttachNodeData	Creates new instance of TSyntNodeRange, links it and stores it in indexes (lists).
CanAcceptRange	Called before processing text range for creating new associated tree node.
Clear	Removes all items in the tree view.
Create	Creates and initializes a TCustomSyntaxTreeView instance.
DblClick	Performs action specified by the ClickAction property.
Destroy	Destroys an instance of TCustomSyntaxTreeView.
DoCreateGroupNode	Called when new group tree node was created for the given text range.
DoCreateTreeNode	Called when new item tree node was created for the given text range.
DoSelectParentNode	Called when selecting parent node for the item Node and given text range.
DoTreeUpdated	Called when syntax tree is fully updated.
FindChild	Looks for child tree node. If Prn is nil searches within root nodes list.
MemoCaretUpdate	Performs action specified by TCustomSyntaxTreeView.ClickAction Property for selected node.
UpdateTree	Updates syntax tree items.

TCustomSyntaxTreeView Properties

TCustomSyntaxTreeView Class

TCustomSyntaxTreeView Class	Description
AutoCollapse	Specifies whether all expanded nodes except parents of selected tree node should be automatically collapsed.
AutoSynchronize	Sets tree view to synchronous mode with the caret position of the syntax memo.
ClickAction	Specifies action when user double clicks on selected tree node.
DblClickExpand	Specifies processing of double click on node.
GroupIndex	Specifies group index to filter text ranges (items).
Items	Lists the individual nodes that appear in the tree view control.
MaxLevels	Specifies maximal number of nodes levels.
SyntaxMemo	Links TreeView control to syntax memo.

TSyntaxTreeView Class

TSyntaxTreeView Class	Description
Align	Determines how the control aligns within its container (parent control).
Anchors	Specifies how the control is anchored to its parent.
AutoCollapse	Specifies whether all expanded nodes except parents of selected tree node should be automatically collapsed.
AutoExpand	Specifies whether the nodes in the tree view automatically expand and collapse depending on the selection.
AutoSynchronize	Sets tree view to synchronous mode with the caret position of the syntax memo.
BevelEdges	Specifies which edges of the control are beveled.
BevelInner	Specifies the cut of the inner bevel.
BevelKind	Specifies the control’s bevel style.
BevelOuter	Specifies the cut of the outer bevel.
BevelWidth	Specifies the width of the inner and outer bevels.
BiDiMode	Specifies the bi-directional mode for the control.
BorderStyle	Determines whether the tree view control has a border.
BorderWidth	Specifies the width of the control’s border.
ChangeDelay	Specifies the delay between when a node is selected and when the OnChange event occurs.
ClickAction	Specifies action when user double clicks on selected tree node.
Color	Specifies the background color of the control.
Constraints	Specifies the size constraints for the control.
Ctl3D	Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
DragCursor	Indicates the image used to represent the mouse pointer when the control is being dragged.
DragKind	Specifies whether the control is being dragged normally or for docking.
DragMode	Determines how the control initiates drag-and-drop or drag-and-dock operations.
Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
Font	Controls the attributes of text written on or in the control.
GroupIndex	Specifies group index to filter text ranges (items).
HideSelection	Determines whether a selected node appears selected when the focus shifts to another control.
HotTrack	Specifies whether list items are highlighted when the mouse passes over them.
Images	Determines which image list is associated with the tree view.
Indent	Specifies the amount of indentation in pixels when a list of child nodes is expanded.
MaxLevels	Specifies maximal number of nodes levels.
MultiSelect	Determines whether the user can select more than one tree node at a time.
MultiSelectStyle	Determines how multiple node selections work.
OnAcceptRange	Occurs before processing text range for creating new associated tree node.
OnAddition	Occurs when new node is added.
OnAdvancedCustomDraw	Occurs at discrete stages during the painting of the tree view control.
OnAdvancedCustomDrawItem	Occurs at discrete stages during the painting of tree view nodes.
OnCancelEdit	Occurs when user cancels editing of a node’s Caption.
OnCanResize	Occurs when an attempt is made to resize the control.
OnChange	Occurs whenever the selection has changed from one node to another.
OnChanging	Occurs when the selection is about to change from one node to another.
OnClick	Occurs when the user clicks the control.
OnCollapsed	Occurs after a node has been collapsed.
OnCollapsing	Occurs when a node is about to be collapsed.
OnCompare	Occurs when two nodes must be compared during a sort of the nodes in the tree view.
OnConstrainedResize	Adjust resize constraints.
OnContextPopup	Occurs when the user right-clicks the control or otherwise invokes the popup menu (such as using the keyboard).
OnCreateGroupNode	Called when new group tree node was created for the given text range.
OnCreateNodeClass	Occurs when a node in the treeview is about to be created.
OnCreateTreeNode	Occurs when new Node is created for the text range Range.
OnCustomDraw	Occurs immediately prior to painting the tree view control.
OnCustomDrawItem	Occurs immediately prior to painting a node in a tree view control.
OnDblClick	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
OnDeletion	Occurs when a node in the tree view is deleted.
OnDragDrop	Occurs when the user drops an object being dragged.
OnDragOver	Occurs when the user drags an object over a control.
OnEdited	Occurs after the user edits the Text property of a node.
OnEditing	Occurs when the user starts to edit the Text property of a node.
OnEndDock	Occurs when the dragging of an object ends, either by docking the object or by canceling the dragging.
OnEndDrag	Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.
OnEnter	Occurs when a control receives the input focus.
OnExit	Occurs when the input focus shifts away from one control to another.
OnExpanded	Occurs after a node is expanded.
OnExpanding	Occurs when a node is about to be expanded.
OnGetImageIndex	Occurs when the tree view looks up the ImageIndex of a node.
OnGetSelectedIndex	Occurs when the tree view looks up the SelectedIndex of a node.
OnKeyDown	Occurs when a user presses any key while the control has focus.
OnKeyPress	Occurs when key pressed.
OnKeyUp	Occurs when the user releases a key that has been pressed.
OnLoadProgress	Occurs periodically during updating syntax tree content.
OnMouseDown	Occurs when the user presses a mouse button with the mouse pointer over a control.
OnMouseMove	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
OnMouseUp	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
OnResize	Occurs immediately after the control is resized.
OnSelectParentNode	Called when selecting parent node for the item Node and given text range.
OnStartDock	Occurs when the user begins to drag a control with a DragKind of dkDock.
OnStartDrag	Occurs when the user begins to drag the control or an object it contains by left-clicking on the control and holding the mouse button down.
OnTreeUpdated	Occurs when syntax tree is fully updated.
ParentBiDiMode	Specifies whether the control uses its parent’s BiDiMode.
ParentColor	Determines where a control looks for its color information.
ParentCtl3D	Determines where a component looks to determine if it should appear three dimensional.
ParentFont	Determines where a control looks for its font information.
ParentShowHint	Determines where a control looks to find out if its Help Hint should be shown.
PopupMenu	Identifies the pop-up menu associated with the control.
ReadOnly	Determines whether the user can edit the node labels.
RightClickSelect	Determines whether the Selected property returns nodes that are selected using the right mouse button.
RowSelect	Specifies whether the entire row of the selected item is highlighted.
ShowButtons	Specifies whether to display plus (+) and minus (-) buttons to the left side of each parent item.
ShowHint	Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
ShowLines	Specifies whether to display the lines that link child nodes to their corresponding parent nodes.
ShowRoot	Specifies whether lines connecting top-level nodes are displayed.
SortType	Determines if and how the nodes in a tree view are automatically sorted.
StateImages	Determines which image list to use for state images.
SyntaxMemo	Links TreeView control to syntax memo.
TabOrder	Indicates the position of the control in its parent's tab order.
TabStop	Determines if the user can tab to a control.
ToolTips	Specifies whether the items in the tree view have tool tips.
Visible	Determines whether the component appears on screen.

Links

Classes, Legend, Members, Topics, TSyntaxTreeView Properties, TCustomSyntaxTreeView Events, IecSyntClient Methods, TCustomSyntaxTreeView Properties

Contents | Index

What do you think about this topic? Send feedback!