版本: 2022.3
语言英语
  • C#

PropertyTable

UnityEditor.Search中的类

/

继承自:IMGUI.Controls.TreeView

建议更改

成功!

感谢您帮助我们提高Unity文档的质量。尽管我们无法接受所有投稿,但我们确实会阅读用户提出的每项建议,并在适用的情况下进行更新。

关闭

投稿失败

由于某些原因,您的建议无法提交。请在几分钟后再试一次。感谢您抽出时间帮助我们提高Unity文档的质量。

关闭

取消

描述

PropertyTable 提供了一个IMGUI小部件,用于在表格视图中显示搜索属性结果。

构造函数

PropertyTable创建一个搜索属性表。

公共方法

Dispose不需要属性表时,必须确保将其弃用。
FrameColumn根据搜索列进行框定。表格视图将滚动视图以显示框定的列。
OnGUI绘制搜索属性表的内容。

继承的成员

属性

baseIndent用于树折叠箭头和内容之前的所有行的缩进。
cellMargin当使用MultiColumnHeader时,此值调整除树折叠列之外的所有列提供的单元格矩形。
columnIndexForTreeFoldouts当使用MultiColumnHeader时,此值应设置为折叠箭头应出现的列索引。
customFoldoutYOffset自定义折叠箭头的垂直偏移。
depthIndentWidth返回折叠箭头对于每个递增的深度值的缩进量。
enableItemHovering如果想要项目悬停效果,则将此属性设置为true。默认值是false。
extraSpaceBeforeIconAndLabel用于控制默认图标和标签之前的间距。例如,可用于将切换按钮放置在内容左侧。
foldoutOverride将回调注册到此属性以覆盖TreeView中的折叠按钮。
foldoutWidth内置折叠箭头的宽度。
getNewSelectionOverride将回调注册到此字段以覆盖TreeView如何处理按键和鼠标点击引起的选择更改。
hasSearchTreeView当前的搜索状态。
hoveredItem使用此属性检测鼠标光标当前在TreeView中悬停于哪个TreeViewItem。此属性仅在设置enableItemHovering属性为true时有效。
isDragging如果用户目前正在TreeView中拖动一个或多个项目,则为true,否则为false。
isInitialized通过调用Reload()初始化TreeView。因此,直到调用Reload()第一次时返回false。
multiColumnHeader获取TreeView的MultiColumnHeader。如果TreeView是在没有MultiColumnHeader的情况下创建的,则可以为null。
rootItemTreeView隐藏的根项目(它永远不会被渲染)。
rowHeight如果GetCustomRowHeight未被覆盖,则TreeView中每行的固定高度。
searchStringTreeView当前的搜索字符串。
showAlternatingRowBackgrounds启用此选项以显示交替的行背景颜色。
showBorder启用此选项以在TreeView周围显示边框。
showingHorizontalScrollBar如果水平滚动条正在显示,则为true,否则为false。
showingVerticalScrollBar如果垂直滚动条正在显示,则为true,否则为false。
状态TreeView的状态(展开状态、选择、滚动等)
totalHeight返回TreeView行高度的总和、多列标题高度(如果使用)和边框(如果使用)。
treeViewControlIDTreeView用来获取键盘控制焦点使用的控制ID。
treeViewRectTreeView正在渲染到的Rect。
useScrollView在绘制TreeView的内容时,它是否会被ScrollView包裹?

公共方法

BeginRename显示TreeViewItem的更名覆盖。
CollapseAll折叠TreeView中的所有展开项。
EndRename如果显示更名覆盖,则结束更名。如果在没有显示更名覆盖时调用此方法,则此方法不执行任何操作。
ExpandAll展开TreeView中的所有折叠项。
FrameItem这将通过展开该项目的祖先来揭示具有ID id的项目(id),并确保它在ScrollView中可见。
GetExpanded返回当前在TreeView中展开的TreeViewItem ID的列表。
GetRows这是在BuildRows中构建的TreeViewItems的列表。
GetSelection返回当前选中的TreeViewItem ID的列表。
HasFocus如果TreeView及其EditorWindow具有键盘焦点,则返回true。
HasSelection如果TreeView有选择,则返回true。
IsExpanded如果ID为id的TreeViewItem当前展开,则返回true。
IsSelected如果ID为id的TreeViewItem当前被选中,则返回true。
Reload调用此方法以强制TreeView重新加载数据。这会反过来调用BuildRoot和BuildRows。
Repaint请求刷新TreeView渲染在其中的窗口。
SelectAllRows选择TreeView中的所有行。
SetExpanded设置单个TreeViewItem为展开或折叠。
SetExpandedRecursive在id项下展开或折叠所有项目。
SetFocus调用此函数将键盘焦点切换到TreeView。
SetFocusAndEnsureSelectedItem调用此函数将键盘焦点切换到TreeView并确保选择一个项目。使用此函数以启用TreeView的关键导航。
SetSelection设置TreeView的选择项。

受保护的方法

AddExpandedRows将完整树的展开行添加到输入列表中。只有在BuildRoot中构建了完整树时才使用此方法。
AfterRowsGUI在所有行调用RowGUI之后调用此方法。
BeforeRowsGUI在调用任何行的RowGUI之前调用此方法。
BuildRoot必须实现的要求抽象方法。默认情况下,此方法应创建TreeViewItem的完整树并返回根。
BuildRows覆盖此方法以控制如何生成行。
CanBeParent覆盖此方法以控制哪些项目允许成为父项。
CanChangeExpandedState覆盖此方法以控制项目是否可以通过键盘或鼠标展开或折叠。
CanMultiSelect覆盖此方法以控制项目是否可以成为多选的一部分。
CanRename覆盖此方法以控制项目是否可以通过快捷键或点击已选中的项目来更名。
CanStartDrag每当点击并拖拽TreeViewItem时都会调用此函数。它默认返回false。
CenterRectUsingSingleLineHeight修改输入rect,使其居中且高度等于EditorGUIUtility.singleLineHeight。
CommandEventHandling自动调用此函数并处理“SelectAll”和“FrameSelection”的ExecuteCommand事件。覆盖此函数以扩展或避免命令事件。
ContextClicked覆盖此方法以处理任何项目以外的(但仍然在TreeView rect内)的上下文点击。
ContextClickedItem重写此方法以处理包含 TreeViewItem.id 的项的上下文点击。
DoesItemMatchSearch重写此函数以扩展或更改搜索行为。
DoubleClickedItem重写此方法以处理项上的双击事件。
ExpandedStateChanged重写以在项展开或折叠时接收通知。这是一个通用通知,表示展开状态已更改。
FindItem通过 ID 查找 TreeViewItem。
FindRowOfItem返回给定 TreeViewItem 的行。
FindRows在将 TreeViewItem ID 转换为 TreeViewItems 时非常有用,使用当前行。
GetAncestors此方法用于显示当前处于折叠项下的项。例如。
GetCellRectForTreeFoldouts对于多列设置的实用工具。此方法将输入行矩形与 columnIndexForTreeFoldouts 定义的列矩形进行剪辑,以获取折叠箭头出现的单元格矩形。
GetContentIndent返回项的水平内容偏移量。这是内容应开始的位置(在折叠箭头之后)。
GetCustomRowHeight重写以控制单独的行高。
GetDescendantsThatHaveChildren返回具有子项的所有后裔项。
GetFirstAndLastVisibleRows返回 TreeView 整体滚动视图中可见行的第一个和最后一个索引。
GetFoldoutIndent返回项的水平折叠偏移量。这是折叠箭头渲染的位置。
GetRenameRect如果 RowGUI 中使用自定义 GUI 处理,请重写此方法。此方法用于控制重命名覆盖显示的控件。
GetRowRect获取行的矩形。
HandleDragAndDrop重写此函数以控制 TreeView 的拖放行为。
KeyEvent重写此方法以处理 TreeView 拥有键盘焦点时的事件。
RefreshCustomRowHeights根据 GetCustomRowHeight 返回的高度更新自定义行矩形的缓存。
RenameEnded当用户完成重命名过程、重命名覆盖失去焦点或使用 EndRename 关闭时调用。
RowGUI重写此方法以向 TreeView 的行添加自定义 GUI 内容。
SearchChanged重写此方法以在搜索字符串更改时接收通知。
SelectionChanged重写此方法以在选择更改时接收通知。
SelectionClick在 RowGUI 中使用此方法来执行鼠标点击的逻辑。
SetupDragAndDrop当 CanStartDrag 返回 true 时调用此函数。
SingleClickedItem重写此方法以处理项上的单 clicked 事件。
SortItemIDsInRowOrder返回一个按在 TreeView 中显示的顺序排序的列表。

静态方法

CreateChildListForCollapsedParent创建一个虚拟的 TreeViewItem 列表。当重写 BuildRows 以防止构建完整项树时很有用。
IsChildListForACollapsedParent用于检查 childList 是否与 CreateChildListForCollapsedParent 方法返回的相同的实用方法。
SetupDepthsFromParentsAndChildren使用输入 TreeViewItem 的深度设置所有后裔 TreeViewItem 的正确深度,这是一个实用方法。
SetupParentsAndChildrenFromDepths使用设置顺序和深度值初始化所有行父项和子项属性的实用方法。

委托

DoFoldoutCallback用于覆盖 TreeView 折叠的回调签名。请参阅 foldoutOverride。
GetNewSelectionFunction回调确定 TreeView 如何根据键和鼠标点击处理选择更改。