Class CompassFilterCategoryEntry

This represents the individual filter entry in the tree view for the filter table.

Inheritance

System.Object

CompassFilterCategoryEntry

Namespace: Phoenix.Controls.Compass

Assembly: Phoenix.Controls.Compass.dll

Syntax

public class CompassFilterCategoryEntry : BindableBase

Constructors

CompassFilterCategoryEntry(String, String)

Initializes a new instance of the CompassFilterCategoryEntry class. If this constructor is given a path to the object type, it will create the parent/child structure itself.

Declaration

public CompassFilterCategoryEntry(string name, string path = null)

Parameters

Type	Name	Description
System.String	name	Either the name of the filter entry, or the path to the filter entry.
System.String	path	The path to this element.

Properties

Children

Gets the children under this filter entry. This is intended for paths to a type for organizing in the tree view.

Declaration

public ObservableCollection<CompassFilterCategoryEntry> Children { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<CompassFilterCategoryEntry>

EnabledInCompass

Gets or sets a value indicating whether compass objects are enabled in the compass view.

Declaration

public bool EnabledInCompass { get; set; }

Property Value

Type	Description
System.Boolean

EnabledInGame

Gets or sets a value indicating whether objects in the game are enabled.

Declaration

public bool EnabledInGame { get; set; }

Property Value

Type	Description
System.Boolean

HandleEnabledChangedCommand

Gets delegate that handles processing the in-game filter changing.

Declaration

public DelegateCommand HandleEnabledChangedCommand { get; }

Property Value

Type	Description
DelegateCommand

Remarks

This is used instead of in a PropertyChanged event since the delegate causes a recursive function that changes the value of all children's enabled status in game. The recursive function should not trigger again for child elements, so a delegate is used here to ensure the function runs just once. This delegate was preferred over using a PropertyChanged event to keep the setter function for this.EnabledInGame clean.

Name

Gets or sets the name of the filter entry.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Path

Gets the path to this element.

Declaration

public string Path { get; }

Property Value

Type	Description
System.String

Methods

AddNewFilterChild(String)

Adds a new filter entry to the children of this current filter.

Declaration

public void AddNewFilterChild(string entryName)

Parameters

Type	Name	Description
System.String	entryName	Either the name of the filter item, or the path to the filter item.