Class ProfileCategory

Namespace

Artemis.Core

Assembly

Artemis.Core.dll

Represents a category containing ProfileConfigurations

public class ProfileCategory : CorePropertyChanged, IStorageModel

Inheritance

object

CorePropertyChanged

ProfileCategory

Implements

IStorageModel

Fields

Empty

Represents an empty profile category.

public static readonly ProfileCategory Empty

Field Value

ProfileCategory

Properties

EntityId

Gets the unique ID of this category

public Guid EntityId { get; }

Property Value

Guid

IsCollapsed

Gets or sets a boolean indicating whether the category is collapsed or not

Note: Has no implications other than inside the UI

public bool IsCollapsed { get; set; }

Property Value

bool

IsSuspended

Gets or sets a boolean indicating whether this category is suspended, disabling all its profiles

public bool IsSuspended { get; set; }

Property Value

bool

Name

Gets or sets the name of the profile category

public string Name { get; set; }

Property Value

string

Order

The order in which this category appears in the update loop and sidebar

public int Order { get; set; }

Property Value

int

ProfileConfigurations

Gets a read only collection of the profiles inside this category

public ReadOnlyCollection<ProfileConfiguration> ProfileConfigurations { get; }

Property Value

ReadOnlyCollection<ProfileConfiguration>

Methods

AddProfileConfiguration(ProfileConfiguration, ProfileConfiguration?)

Adds a profile configuration to this category

public void AddProfileConfiguration(ProfileConfiguration configuration, ProfileConfiguration? target)

Parameters

configuration ProfileConfiguration

target ProfileConfiguration

Load()

Loads the model from its associated entity

public void Load()

OnProfileConfigurationAdded(ProfileConfigurationEventArgs)

Invokes the ProfileConfigurationAdded event

protected virtual void OnProfileConfigurationAdded(ProfileConfigurationEventArgs e)

Parameters

e ProfileConfigurationEventArgs

OnProfileConfigurationRemoved(ProfileConfigurationEventArgs)

Invokes the ProfileConfigurationRemoved event

protected virtual void OnProfileConfigurationRemoved(ProfileConfigurationEventArgs e)

Parameters

e ProfileConfigurationEventArgs

Save()

Saves the model to its associated entity

public void Save()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Events

ProfileConfigurationAdded

Occurs when a profile configuration is added to this ProfileCategory

public event EventHandler<ProfileConfigurationEventArgs>? ProfileConfigurationAdded

Event Type

EventHandler<ProfileConfigurationEventArgs>

ProfileConfigurationRemoved

Occurs when a profile configuration is removed from this ProfileCategory

public event EventHandler<ProfileConfigurationEventArgs>? ProfileConfigurationRemoved

Event Type

EventHandler<ProfileConfigurationEventArgs>