Class CallbackEventHandlerExtensions
Namespace: Aspid.FastTools.UIElements
Assembly: Aspid.FastTools.dll
Provides extension methods for CallbackEventHandler.
public static class CallbackEventHandlerExtensions
Inheritance
object ← CallbackEventHandlerExtensions
Methods
RegisterCallbackOnceSelf<T, TEventType>(T, EventCallback<TEventType>, TrickleDown)
Registers a callback that runs for one event and is then removed, via RegisterCallbackOnce<T>.
public static T RegisterCallbackOnceSelf<T, TEventType>(this T element, EventCallback<TEventType> callback, TrickleDown useTrickleDown = TrickleDown.NoTrickleDown) where T : CallbackEventHandler where TEventType : EventBase<TEventType>, new()
Parameters
element T
The element to modify.
callback EventCallback<TEventType>
The callback to invoke when the first event reaches the element.
useTrickleDown TrickleDown
Selects the phase of the callback: TrickleDown for trickle-down, NoTrickleDown for bubble-up.
Returns
T
The element, for chaining.
Type Parameters
T
The element type.
TEventType
The event type to listen for.
Remarks
Name both type arguments unless the callback has a typed parameter: RegisterCallbackOnceSelf<Button, ClickEvent>(OnClick).
RegisterCallbackOnceSelf<T, TEventType, TUserArgsType>(T, EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
Registers a callback with user arguments that runs for one event and is then removed, via RegisterCallbackOnce<T1, T2>.
public static T RegisterCallbackOnceSelf<T, TEventType, TUserArgsType>(this T element, EventCallback<TEventType, TUserArgsType> callback, TUserArgsType userArgs, TrickleDown useTrickleDown = TrickleDown.NoTrickleDown) where T : CallbackEventHandler where TEventType : EventBase<TEventType>, new()
Parameters
element T
The element to modify.
callback EventCallback<TEventType, TUserArgsType>
The callback to invoke when the first event reaches the element.
userArgs TUserArgsType
The value passed to the callback.
useTrickleDown TrickleDown
Selects the phase of the callback: TrickleDown for trickle-down, NoTrickleDown for bubble-up.
Returns
T
The element, for chaining.
Type Parameters
T
The element type.
TEventType
The event type to listen for.
TUserArgsType
The type of the user arguments.
Remarks
Name all type arguments unless the callback has typed parameters: RegisterCallbackOnceSelf<Button, ClickEvent, int>(OnClick, 5).
RegisterCallbackSelf<T, TEventType>(T, EventCallback<TEventType>, TrickleDown)
Registers a callback for an event via RegisterCallback<T>.
public static T RegisterCallbackSelf<T, TEventType>(this T element, EventCallback<TEventType> callback, TrickleDown useTrickleDown = TrickleDown.NoTrickleDown) where T : CallbackEventHandler where TEventType : EventBase<TEventType>, new()
Parameters
element T
The element to modify.
callback EventCallback<TEventType>
The callback to invoke when the event reaches the element.
useTrickleDown TrickleDown
Selects the phase of the callback: TrickleDown for trickle-down, NoTrickleDown for bubble-up.
Returns
T
The element, for chaining.
Type Parameters
T
The element type.
TEventType
The event type to listen for.
Remarks
Name both type arguments unless the callback has a typed parameter: RegisterCallbackSelf<Button, ClickEvent>(OnClick).
RegisterCallbackSelf<T, TEventType, TUserArgsType>(T, EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
Registers a callback with user arguments for an event via RegisterCallback<T1, T2>.
public static T RegisterCallbackSelf<T, TEventType, TUserArgsType>(this T element, EventCallback<TEventType, TUserArgsType> callback, TUserArgsType userArgs, TrickleDown useTrickleDown = TrickleDown.NoTrickleDown) where T : CallbackEventHandler where TEventType : EventBase<TEventType>, new()
Parameters
element T
The element to modify.
callback EventCallback<TEventType, TUserArgsType>
The callback to invoke when the event reaches the element.
userArgs TUserArgsType
The value passed to the callback with every event.
useTrickleDown TrickleDown
Selects the phase of the callback: TrickleDown for trickle-down, NoTrickleDown for bubble-up.
Returns
T
The element, for chaining.
Type Parameters
T
The element type.
TEventType
The event type to listen for.
TUserArgsType
The type of the user arguments.
Remarks
Name all type arguments unless the callback has typed parameters: RegisterCallbackSelf<Button, ClickEvent, int>(OnClick, 5).
UnregisterCallbackSelf<T, TEventType>(T, EventCallback<TEventType>, TrickleDown)
Removes a callback for an event via UnregisterCallback<T>.
public static T UnregisterCallbackSelf<T, TEventType>(this T element, EventCallback<TEventType> callback, TrickleDown useTrickleDown = TrickleDown.NoTrickleDown) where T : CallbackEventHandler where TEventType : EventBase<TEventType>, new()
Parameters
element T
The element to modify.
callback EventCallback<TEventType>
The callback to remove.
useTrickleDown TrickleDown
The phase the callback was registered for: TrickleDown for trickle-down, NoTrickleDown for bubble-up.
Returns
T
The element, for chaining.
Type Parameters
T
The element type.
TEventType
The event type the callback listens for.
Remarks
Name both type arguments unless the callback has a typed parameter: UnregisterCallbackSelf<Button, ClickEvent>(OnClick).
UnregisterCallbackSelf<T, TEventType, TUserArgsType>(T, EventCallback<TEventType, TUserArgsType>, TrickleDown)
Removes a callback with user arguments for an event via UnregisterCallback<T1, T2>.
public static T UnregisterCallbackSelf<T, TEventType, TUserArgsType>(this T element, EventCallback<TEventType, TUserArgsType> callback, TrickleDown useTrickleDown = TrickleDown.NoTrickleDown) where T : CallbackEventHandler where TEventType : EventBase<TEventType>, new()
Parameters
element T
The element to modify.
callback EventCallback<TEventType, TUserArgsType>
The callback to remove.
useTrickleDown TrickleDown
The phase the callback was registered for: TrickleDown for trickle-down, NoTrickleDown for bubble-up.
Returns
T
The element, for chaining.
Type Parameters
T
The element type.
TEventType
The event type the callback listens for.
TUserArgsType
The type of the user arguments.
Remarks
Name all type arguments unless the callback has typed parameters: UnregisterCallbackSelf<Button, ClickEvent, int>(OnClick).