Show / Hide Table of Contents

Class FancyTree

Functionally similar to Robust.Client.UserInterface.Controls.Tree, but with collapsible sections,

Inheritance
System.Object
Robust.Client.UserInterface.Control
FancyTree
Namespace: Content.Client.UserInterface.Controls.FancyTree
Assembly: Content.Client.dll
Syntax
public sealed class FancyTree : Control

Constructors

| Improve this Doc View Source

FancyTree()

Declaration
public FancyTree()

Fields

| Improve this Doc View Source

AutoExpand

If true, a collapsed item will automatically expand when first selected. If false, it has to be manually expanded by clicking on it a second time.

Declaration
public bool AutoExpand
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultIconCollapsed

Declaration
public const string DefaultIconCollapsed = null
Field Value
Type Description
System.String
| Improve this Doc View Source

DefaultIconExpanded

Declaration
public const string DefaultIconExpanded = null
Field Value
Type Description
System.String
| Improve this Doc View Source

DefaultIconNoChildren

Declaration
public const string DefaultIconNoChildren = null
Field Value
Type Description
System.String
| Improve this Doc View Source

DrawLines

Declaration
public bool DrawLines
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IconCollapsed

Declaration
public Texture IconCollapsed
Field Value
Type Description
Robust.Client.Graphics.Texture
| Improve this Doc View Source

IconColor

Color used to modulate the icon textures.

Declaration
public Color IconColor
Field Value
Type Description
Color
| Improve this Doc View Source

IconExpanded

Declaration
public Texture IconExpanded
Field Value
Type Description
Robust.Client.Graphics.Texture
| Improve this Doc View Source

IconNoChildren

Declaration
public Texture IconNoChildren
Field Value
Type Description
Robust.Client.Graphics.Texture
| Improve this Doc View Source

Indentation

Declaration
public const int Indentation = null
Field Value
Type Description
System.Int32
| Improve this Doc View Source

Items

Declaration
public readonly List<TreeItem> Items
Field Value
Type Description
List<TreeItem>
| Improve this Doc View Source

LineColor

Declaration
public Color LineColor
Field Value
Type Description
Color
| Improve this Doc View Source

LineWidth

Declaration
public int LineWidth
Field Value
Type Description
System.Int32
| Improve this Doc View Source

StylePropertyIconCollapsed

Declaration
public const string StylePropertyIconCollapsed = null
Field Value
Type Description
System.String
| Improve this Doc View Source

StylePropertyIconColor

Declaration
public const string StylePropertyIconColor = null
Field Value
Type Description
System.String
| Improve this Doc View Source

StylePropertyIconExpanded

Declaration
public const string StylePropertyIconExpanded = null
Field Value
Type Description
System.String
| Improve this Doc View Source

StylePropertyIconNoChildren

Declaration
public const string StylePropertyIconNoChildren = null
Field Value
Type Description
System.String
| Improve this Doc View Source

StylePropertyLineColor

Declaration
public const string StylePropertyLineColor = null
Field Value
Type Description
System.String
| Improve this Doc View Source

StylePropertyLineWidth

Declaration
public const string StylePropertyLineWidth = null
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

HideEmptyIcon

If true, tree entries will hide their icon if the texture is set to null. If the icon is hidden then the text of that entry will no longer be aligned with sibling entries that do have an icon.

Declaration
public bool HideEmptyIcon { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SelectedIndex

Declaration
public int? SelectedIndex { get; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

SelectedItem

Declaration
public TreeItem SelectedItem { get; }
Property Value
Type Description
TreeItem

Methods

| Improve this Doc View Source

AddItem(TreeItem)

Declaration
public TreeItem AddItem(TreeItem parent = null)
Parameters
Type Name Description
TreeItem parent
Returns
Type Description
TreeItem
| Improve this Doc View Source

Clear()

Declaration
public void Clear()
| Improve this Doc View Source

ExpandParentEntries(Int32)

Declaration
public void ExpandParentEntries(int index)
Parameters
Type Name Description
System.Int32 index
| Improve this Doc View Source

FrameUpdate(FrameEventArgs)

Declaration
protected override void FrameUpdate(FrameEventArgs args)
Parameters
Type Name Description
Robust.Shared.Timing.FrameEventArgs args
Overrides
Robust.Client.UserInterface.Control.FrameUpdate(Robust.Shared.Timing.FrameEventArgs)
| Improve this Doc View Source

QueueRowStyleUpdate()

Declaration
public void QueueRowStyleUpdate()
| Improve this Doc View Source

RecursiveSetExpanded(TreeItem, Boolean, Int32)

Declaration
public void RecursiveSetExpanded(TreeItem item, bool value, int depth)
Parameters
Type Name Description
TreeItem item
System.Boolean value
System.Int32 depth
| Improve this Doc View Source

SetAllExpanded(Boolean, Int32)

Recursively expands or collapse all entries, optionally up to some depth.

Declaration
public void SetAllExpanded(bool value, int depth = null)
Parameters
Type Name Description
System.Boolean value

Whether to expand or collapse the entries

System.Int32 depth

The recursion depth. If negative, implies no limit. Zero will expand only the top-level entries.

| Improve this Doc View Source

SetSelectedIndex(Nullable<Int32>)

Declaration
public void SetSelectedIndex(int? value)
Parameters
Type Name Description
System.Nullable<System.Int32> value
| Improve this Doc View Source

StylePropertiesChanged()

Declaration
protected override void StylePropertiesChanged()
Overrides
Robust.Client.UserInterface.Control.StylePropertiesChanged()
| Improve this Doc View Source

TryGetIndexFromMetadata(Object, out Nullable<Int32>)

Declaration
public bool TryGetIndexFromMetadata(object metadata, out int? index)
Parameters
Type Name Description
System.Object metadata
System.Nullable<System.Int32> index
Returns
Type Description
System.Boolean

Events

| Improve this Doc View Source

OnSelectedItemChanged

Declaration
public event Action<TreeItem>? OnSelectedItemChanged
Event Type
Type Description
System.Nullable<Action<TreeItem>>

Extension Methods

ControlExtension.GetControlOfType<T>(Control)
ControlExtension.GetControlOfType<T>(Control, String)
ControlExtension.GetControlOfType<T>(Control, Boolean)
ControlExtension.GetControlOfType<T>(Control, String, Boolean)
ControlExtension.GetSearchableControls(Control, Boolean)
ControlExtension.ChildrenContainText(Control, String)
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾