Table of Contents

Class SettingPropertyGroupAttribute

Namespace
MCM.Abstractions.Attributes
Assembly
MCMv5.dll

Tells the settings menu that this setting property should be in a group. All settings will automatically be grouped together if they have a SettingPropertyGroupAttribute with the same GroupName.

[AttributeUsage(AttributeTargets.Property)]
public sealed class SettingPropertyGroupAttribute : Attribute, IPropertyGroupDefinition
Inheritance
SettingPropertyGroupAttribute
Implements
Inherited Members

Constructors

SettingPropertyGroupAttribute(string)

Tells the settings menu that this setting property should be in a group. All settings will automatically be grouped together if they have a SettingPropertyGroupAttribute with the same GroupName.

public SettingPropertyGroupAttribute(string groupName)

Parameters

groupName string

The name of the setting group. Groups can set to be sub groups by separating the parent group's name and this group's name with a '/'. For example, "Group 1/Group 2" will name this group "Group 2" and place it as a sub group in "Group 1".

Properties

Default

The default group used for settings that don't have a group explicitly set.

public static IPropertyGroupDefinition Default { get; }

Property Value

IPropertyGroupDefinition

GroupName

The name of the settings group. Includes SubGroup notation if present.

public string GroupName { get; }

Property Value

string

GroupOrder 

public int GroupOrder { get; set; }

Property Value

int

This page was last modified at 12/23/2022 11:49:56 +02:00 (UTC).

Commit Message
Author:    Aragas
Commit:    aa889a1db7974dc13c9ff22e5740d958a2228b18

* Added MCM Source Package NuGet for easier integration
Edit this page