AntdUI/doc/wiki/en/Control/Tree.md

Home・UpdateLog・Config・Theme

Tree

👚

Multiple-level structure list.

• DefaultProperty：Items
• DefaultEvent：SelectChanged

Property

Name	Description	Type	Default Value
ForeColor	Text color	Color?	null
ForeActive	Activate Text color	Color?	null
BackHover	Hover background color	Color?	null
BackActive	Activate background color	Color?	null
Gap	Gap	int	8
GapIndent	Gap indent	int?	null
Radius	Rounded corners	int	6
Round	Rounded corner style	bool	false
IconRatio	Icon Scale	float	1F
Checkable	Add Checkbox checkbox in front of the node	bool	false
CheckStrictly	Node selection is fully controlled in Checkable state The selected status of parent-child nodes is no longer associated	bool	true
BlockNode	Nodes occupy a row	bool	false
Multiple	Support selecting multiple nodes	bool	false
Items	Data TreeItem[]	TreeItem[]	[]
SelectItem	Selected item	TreeItem?	null
Empty	Is it displayed	bool	true
EmptyText	Display text when data is empty	string?	null
EmptyImage	Display image with empty data	Image?	null
PauseLayout	Pause Layout	bool	false

Event

Name	Description	Return Value	Parameters
SelectChanged	Occurred when the value of the Select attribute is changed	void	MouseEventArgs args, TreeItem item, Rectangle rect
CheckedChanged	Occurred when the value of the Checked attribute is changed	void	TreeItem item, bool value Select Value
BeforeExpand	Occurred before Expand is changed	void	TreeItem item, bool value Expand value
AfterExpand	Occurred after Expand is changed	void	TreeItem item, bool value Expand value
NodeMouseClick	Click Item Event	void	MouseEventArgs args, TreeItem item, Rectangle rect
NodeMouseDoubleClick	Double click event	void	MouseEventArgs args, TreeItem item, Rectangle rect
NodeMouseMove	Mobile event	void	TreeItem item, Rectangle rect, bool hover
NodeMouseDown	Mouse down event	void	MouseEventArgs args, TreeItem item, Rectangle rect
NodeMouseUp	Mouse up event	void	MouseEventArgs args, TreeItem item, Rectangle rect

Method

Name	Description	Return Value	Parameters
ExpandAll	Expand all	void	bool value true expand, false collapse
GetCheckeds	Get all selected items	List<TreeItem>	bool Indeterminate whether to include Indeterminate = true
Select	Select specified item	bool	TreeItem item, bool focus set focus = true
SelectID	Select specified item (ID)	bool	string id ID, bool focus set focus = true
SelectName	Select specified item (Name)	bool	string name name, bool focus set focus = true
USelect	Deselect all	void	bool clear clear selection = true
SetCheckeds	Select All/Select None	void	bool check whether to select
Focus	Jump to specified item	void	TreeItem item, int gap gap = 0, bool force force = false
VisibleAll	Set all Visible	void	bool value whether visible = true
Remove	Remove menu	void	TreeItem item item
ReverseCheckItem	Reverse select node item	void	TreeItem item item
GetSelects	Get all selected items	List<TreeItem>	None
FindID	Find node by ID	TreeItem?	string id ID
FindName	Find node by name	TreeItem?	string name name
Search	Search filter	void	string search search text
HitTest	Hit test	TreeItem?	int x X coordinate, int y Y coordinate, out TreeCType type type

Data

TreeItem

Name	Description	Type	Default Value
ID	ID	string?	null
Name	Name	string?	null
Icon	Icon	Image?	null
IconSvg	Icon SVG	string?	null
Text	Text	string	Required
🌏 LocalizationText	International Text	string?	null
SubTitle	Subtitle	string	null
🌏 LocalizationSubTitle	International Subtitle	string?	null
Fore	Font color	Color?	null
Back	Background color	Color?	null
Visible	Is it displayed	bool	true
Enabled	Enable	bool	true
Expand	Expand	bool	true
CanExpand	Can it be expanded	bool	Read only
Checked	Checked state	bool	false
CheckState	Checked state	CheckState	Unchecked
Sub	Subset ♾️	TreeItem[]	[]
Tag	User defined data	object?	null
PARENTITEM	Parent object	TreeItem?	null