Skip to content

Class SEvent

Definition

Namespace: StardewUI.Framework.Dom
Assembly: StardewUI.dll

An event attribute in a StarML document.

public record SEvent : StardewUI.Framework.Dom.IEvent, 
    IEquatable<StardewUI.Framework.Dom.SEvent>

Inheritance
Object ⇦ SEvent

Implements
IEvent, IEquatable<SEvent>

Members

Constructors

Name Description
SEvent(string, string, IReadOnlyList<SArgument>, ContextRedirect) An event attribute in a StarML document.
SEvent(Event, IReadOnlyList<SArgument>) Initializes a new SArgument from the data of a parsed argument.

Properties

Name Description
Arguments The arguments to the event handler.
ContextRedirect The redirect to use for the context on which the method named HandlerName should exist.
EqualityContract
HandlerName The name of the event handler (method) to run on the bound or redirected context.
Name The event name, i.e. name of the event field on the target IView.

Details

Constructors

SEvent(string, string, IReadOnlyList<SArgument>, ContextRedirect)

An event attribute in a StarML document.

public SEvent(string Name, string HandlerName, System.Collections.Generic.IReadOnlyList<StardewUI.Framework.Dom.SArgument> Arguments, StardewUI.Framework.Dom.ContextRedirect ContextRedirect);
Parameters

Name   string
The event name, i.e. name of the event field on the target IView.

HandlerName   string
The name of the event handler (method) to run on the bound or redirected context.

Arguments   IReadOnlyList<SArgument>
The arguments to the event handler.

ContextRedirect   ContextRedirect
The redirect to use for the context on which the method named HandlerName should exist.


SEvent(Event, IReadOnlyList<SArgument>)

Initializes a new SArgument from the data of a parsed argument.

public SEvent(StardewUI.Framework.Grammar.Event e, System.Collections.Generic.IReadOnlyList<StardewUI.Framework.Dom.SArgument> arguments);
Parameters

e   Event
The parsed event.

arguments   IReadOnlyList<SArgument>
The event arguments.


Properties

Arguments

The arguments to the event handler.

public System.Collections.Generic.IReadOnlyList<StardewUI.Framework.Dom.SArgument> Arguments { get; set; }
Property Value

IReadOnlyList<SArgument>


ContextRedirect

The redirect to use for the context on which the method named HandlerName should exist.

public StardewUI.Framework.Dom.ContextRedirect ContextRedirect { get; set; }
Property Value

ContextRedirect


EqualityContract

protected System.Type EqualityContract { get; }
Property Value

Type


HandlerName

The name of the event handler (method) to run on the bound or redirected context.

public string HandlerName { get; set; }
Property Value

string


Name

The event name, i.e. name of the event field on the target IView.

public string Name { get; set; }
Property Value

string