Volume Control
Application-specific hotkeys for Windows
VolumeControl.Core.Events.InterruptEventArgs< T > Class Template Reference

Event arguments that include an incoming and outgoing value, as well as a settable Handled property to interrupt the sender. More...

Inheritance diagram for VolumeControl.Core.Events.InterruptEventArgs< T >:
Collaboration diagram for VolumeControl.Core.Events.InterruptEventArgs< T >:

Public Member Functions

 InterruptEventArgs (T outgoingValue, T incomingValue)
 Creates a new InterruptEventArgs<T> instance with the specified outgoingValue and incomingValue . More...
 

Properties

bool Handled [get, set]
 Gets or sets whether this event has been completely handled or whether the sender should continue its own processing. More...
 
virtual T OutgoingValue [get]
 Gets the current (outgoing) value that will be replaced by the IncomingValue when Handled is false. More...
 
virtual T IncomingValue [get]
 Gets the incoming value. More...
 

Detailed Description

Event arguments that include an incoming and outgoing value, as well as a settable Handled property to interrupt the sender.

Template Parameters
TThe type of value for this event.

Constructor & Destructor Documentation

◆ InterruptEventArgs()

VolumeControl.Core.Events.InterruptEventArgs< T >.InterruptEventArgs ( outgoingValue,
incomingValue 
)

Creates a new InterruptEventArgs<T> instance with the specified outgoingValue and incomingValue .

Parameters
outgoingValueThe current value that will be replaced by the incomingValue when Handled is still false after all handlers have finished with this event.
incomingValueThe new value that will potentially be replacing the outgoingValue .

References VolumeControl.Core.Events.InterruptEventArgs< T >.IncomingValue, and VolumeControl.Core.Events.InterruptEventArgs< T >.OutgoingValue.

Property Documentation

◆ Handled

Gets or sets whether this event has been completely handled or whether the sender should continue its own processing.

Returns
true when the sender should be interrupted; otherwise, false.

◆ IncomingValue

virtual T VolumeControl.Core.Events.InterruptEventArgs< T >.IncomingValue
get

◆ OutgoingValue

virtual T VolumeControl.Core.Events.InterruptEventArgs< T >.OutgoingValue
get

Gets the current (outgoing) value that will be replaced by the IncomingValue when Handled is false.

Referenced by VolumeControl.Core.Events.InterruptEventArgs< T >.InterruptEventArgs().


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