Specifies an action setting for the associated hotkey action method. More...

Inheritance diagram for VolumeControl.Core.Attributes.HotkeyActionSettingAttribute:

Collaboration diagram for VolumeControl.Core.Attributes.HotkeyActionSettingAttribute:

Public Member Functions
	HotkeyActionSettingAttribute (string name, Type valueType)
	Creates a new HotkeyActionSettingAttribute instance with the specified name and valueType . More...

	HotkeyActionSettingAttribute (string name, Type valueType, Type dataTemplateProviderType)
	Creates a new HotkeyActionSettingAttribute instance with the specified name , valueType , and dataTemplateProviderType . More...

	HotkeyActionSettingAttribute (string name, Type valueType, string dataTemplateKey)
	Creates a new HotkeyActionSettingAttribute instance with the specified name , valueType , and dataTemplateKey . More...

	HotkeyActionSettingAttribute (string name, Type valueType, Type dataTemplateProviderType, string dataTemplateKey)
	Creates a new HotkeyActionSettingAttribute instance with the specified name , valueType , dataTemplateProviderType , and dataTemplateKey . More...

Properties
string	Name `[get, set]`
	Gets or sets the name of this action setting. More...

string?	Description `[get, set]`
	Gets or sets the description string for this action setting. More...

Type	ValueType `[get, set]`
	Gets or sets the value type of this action setting. More...

object?	DefaultValue `[get, set]`
	Gets or sets the default value of this action setting. Must be the same type as, or implicitly convertible to, the specified ValueType. More...

bool	IsToggleable `[get, set]`
	Gets or sets whether this action setting can be toggled on/off. More...

bool	StartsEnabled `[get, set]`
	Gets or sets whether this action setting is enabled by default or not. More...

Type?	DataTemplateProviderType `[get, set]`
	Gets or sets the data template provider type to use for this action setting. Only types that implement ITemplateProvider or ITemplateDictionaryProvider are allowed. More...

string?	DataTemplateProviderKey `[get, set]`
	Gets or sets the name of a specific provided data template to use. More...

Detailed Description

Specifies an action setting for the associated hotkey action method.

This attribute can only be used on methods that are also marked with HotkeyActionAttribute.

Constructor & Destructor Documentation

◆ HotkeyActionSettingAttribute() [1/4]

VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute	(	string	name,
		Type	valueType
	)

Creates a new HotkeyActionSettingAttribute instance with the specified name and valueType .

Parameters

name	The name of this action setting. This is used to retrieve the value from the event arguments.
valueType	The type of value that this action setting contains.

References VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.Name, and VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.ValueType.

◆ HotkeyActionSettingAttribute() [2/4]

VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute	(	string	name,
		Type	valueType,
		Type	dataTemplateProviderType
	)

Creates a new HotkeyActionSettingAttribute instance with the specified name , valueType , and dataTemplateProviderType .

Parameters

name	The name of this action setting. This is used to retrieve the value from the event arguments.
valueType	The type of value that this action setting contains.
dataTemplateProviderType	The type of the WPF DataTemplate to use for providing an editor control for the GUI. See DataTemplateProviderType for more information.

References VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DataTemplateProviderType, VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.Name, and VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.ValueType.

◆ HotkeyActionSettingAttribute() [3/4]

VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute	(	string	name,
		Type	valueType,
		string	dataTemplateKey
	)

Creates a new HotkeyActionSettingAttribute instance with the specified name , valueType , and dataTemplateKey .

Parameters

name	The name of this action setting. This is used to retrieve the value from the event arguments.
valueType	The type of value that this action setting contains.
dataTemplateKey	string containing the key name of the target ActionSettingDataTemplate instance to use.

References VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DataTemplateProviderKey, VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.Name, and VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.ValueType.

◆ HotkeyActionSettingAttribute() [4/4]

VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute	(	string	name,
		Type	valueType,
		Type	dataTemplateProviderType,
		string	dataTemplateKey
	)

Creates a new HotkeyActionSettingAttribute instance with the specified name , valueType , dataTemplateProviderType , and dataTemplateKey .

Parameters

name	The name of this action setting. This is used to retrieve the value from the event arguments.
valueType	The type of value that this action setting contains.
dataTemplateProviderType	The type of the WPF DataTemplate to use for providing an editor control for the GUI. See DataTemplateProviderType for more information.
dataTemplateKey	string containing the key name of the target ActionSettingDataTemplate instance to use.

References VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DataTemplateProviderKey, VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DataTemplateProviderType, VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.Name, and VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.ValueType.

Property Documentation

◆ DataTemplateProviderKey

string? VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DataTemplateProviderKey

getset

Gets or sets the name of a specific provided data template to use.

Referenced by VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute().

◆ DataTemplateProviderType

Type? VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DataTemplateProviderType

getset

Gets or sets the data template provider type to use for this action setting.
Only types that implement ITemplateProvider or ITemplateDictionaryProvider are allowed.

When this is null, the default DataTemplate for the specified ValueType is used instead, if one is available.
See the documentation for ITemplateProvider & ITemplateDictionaryProvider for more information.

Returns: A Type representing a class that implements ITemplateProvider or ITemplateDictionaryProvider class Type when a specific provider was specified; otherwise null to automatically select a suitable template for the ValueType.

Referenced by VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute().

◆ DefaultValue

object? VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.DefaultValue

getset

Gets or sets the default value of this action setting. Must be the same type as, or implicitly convertible to, the specified ValueType.

◆ Description

string? VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.Description

getset

Gets or sets the description string for this action setting.

◆ IsToggleable

bool VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.IsToggleable

getset

Gets or sets whether this action setting can be toggled on/off.

When true a checkbox control is shown in the UI to allow users to enable or disable the setting.
You can determine whether an action setting instance is enabled or not by checking the Input.Actions.Settings.IActionSettingInstance.IsEnabled property.

◆ Name

string VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.Name

getset

Gets or sets the name of this action setting.

Referenced by VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute().

◆ StartsEnabled

bool VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.StartsEnabled

getset

Gets or sets whether this action setting is enabled by default or not.

This has no effect when IsToggleable is set to false.

◆ ValueType

Type VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.ValueType

getset

Gets or sets the value type of this action setting.

Referenced by VolumeControl.Core.Attributes.HotkeyActionSettingAttribute.HotkeyActionSettingAttribute().

The documentation for this class was generated from the following file:

/home/runner/work/volume-control/volume-control/VolumeControl.Core/Attributes/HotkeyActionSettingAttribute.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ HotkeyActionSettingAttribute() [1/4]

◆ HotkeyActionSettingAttribute() [2/4]

◆ HotkeyActionSettingAttribute() [3/4]

◆ HotkeyActionSettingAttribute() [4/4]

Property Documentation

◆ DataTemplateProviderKey

◆ DataTemplateProviderType

◆ DefaultValue

◆ Description

◆ IsToggleable

◆ Name

◆ StartsEnabled

◆ ValueType