Class ProfileCategory
Represents a category containing ProfileConfigurations
Implements
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class ProfileCategory : CorePropertyChanged, IStorageModel
Fields
Empty
Represents an empty profile category.
Declaration
public static readonly ProfileCategory Empty
Field Value
Type | Description |
---|---|
ProfileCategory |
Properties
EntityId
Gets the unique ID of this category
Declaration
public Guid EntityId { get; }
Property Value
Type | Description |
---|---|
Guid |
IsCollapsed
Gets or sets a boolean indicating whether the category is collapsed or not
Note: Has no implications other than inside the UI
Declaration
public bool IsCollapsed { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsSuspended
Gets or sets a boolean indicating whether this category is suspended, disabling all its profiles
Declaration
public bool IsSuspended { get; set; }
Property Value
Type | Description |
---|---|
bool |
Name
Gets or sets the name of the profile category
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Order
The order in which this category appears in the update loop and sidebar
Declaration
public int Order { get; set; }
Property Value
Type | Description |
---|---|
int |
ProfileConfigurations
Gets a read only collection of the profiles inside this category
Declaration
public ReadOnlyCollection<ProfileConfiguration> ProfileConfigurations { get; }
Property Value
Type | Description |
---|---|
ReadOnlyCollection<ProfileConfiguration> |
Methods
AddProfileConfiguration(ProfileConfiguration, int?)
Adds a profile configuration to this category
Declaration
public void AddProfileConfiguration(ProfileConfiguration configuration, int? targetIndex)
Parameters
Type | Name | Description |
---|---|---|
ProfileConfiguration | configuration | |
int? | targetIndex |
Load()
Loads the model from its associated entity
Declaration
public void Load()
OnProfileConfigurationAdded(ProfileConfigurationEventArgs)
Invokes the ProfileConfigurationAdded event
Declaration
protected virtual void OnProfileConfigurationAdded(ProfileConfigurationEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
ProfileConfigurationEventArgs | e |
OnProfileConfigurationRemoved(ProfileConfigurationEventArgs)
Invokes the ProfileConfigurationRemoved event
Declaration
protected virtual void OnProfileConfigurationRemoved(ProfileConfigurationEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
ProfileConfigurationEventArgs | e |
Save()
Saves the model to its associated entity
Declaration
public void Save()
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
Events
ProfileConfigurationAdded
Occurs when a profile configuration is added to this ProfileCategory
Declaration
public event EventHandler<ProfileConfigurationEventArgs>? ProfileConfigurationAdded
Event Type
Type | Description |
---|---|
EventHandler<ProfileConfigurationEventArgs> |
ProfileConfigurationRemoved
Occurs when a profile configuration is removed from this ProfileCategory
Declaration
public event EventHandler<ProfileConfigurationEventArgs>? ProfileConfigurationRemoved
Event Type
Type | Description |
---|---|
EventHandler<ProfileConfigurationEventArgs> |