Class RaisedRoutedEvent
Represents a raised routed event instance that captures the complete context of a routed event occurrence, including sender information, routing direction, and event identity for use in event behavior processing.
Inheritance
Inherited Members
Namespace: Telerik.WinControls
Assembly: Telerik.WinControls.dll
Syntax
public class RaisedRoutedEvent
Remarks
The RaisedRoutedEvent class encapsulates all the information necessary to identify and match specific routed event occurrences within the event behavior system. It serves as a snapshot of a routed event's context at the time it was raised, enabling sophisticated event filtering and behavior triggering based on multiple criteria.
This class is used primarily by the event behavior system to determine whether specific behaviors should be executed in response to routed events. It provides flexible matching capabilities based on event identity, sender characteristics, and routing direction, allowing for precise control over when event behaviors are triggered.
The class supports XML serialization for persistence scenarios and includes specialized methods for event matching that enable complex event behavior conditions to be evaluated efficiently.
Constructors
RaisedRoutedEvent()
Initializes a new instance of the RaisedRoutedEvent class with default values.
Declaration
public RaisedRoutedEvent()
Remarks
This parameterless constructor is required for XML serialization and creates an instance with uninitialized properties that must be set separately before the instance can be used for event matching operations.
RaisedRoutedEvent(RoutedEvent, String, EventBehaviorSenderType, RoutingDirection)
Initializes a new instance of the RaisedRoutedEvent class with the specified event context information.
Declaration
public RaisedRoutedEvent(RoutedEvent routedEvent, string sender, EventBehaviorSenderType senderType, RoutingDirection direction)
Parameters
RoutedEvent
routedEvent
The RoutedEvent definition that identifies the type of event being raised. |
System.String
sender
A string identifier for the event sender, interpreted according to the sender type. |
EventBehaviorSenderType
senderType
The EventBehaviorSenderType that determines how the sender parameter should be interpreted. |
RoutingDirection
direction
The RoutingDirection indicating whether this is a tunneling or bubbling event. |
Remarks
This constructor creates a complete raised routed event context that can be used for precise event matching in the event behavior system. The parameters work together to create a comprehensive filter that can match events based on multiple criteria:
- The routed event provides the event identity and type information
- The sender and sender type specify which elements should trigger behaviors
- The direction indicates whether to match tunneling or bubbling events
Properties
Direction
Gets or sets the routing direction - tunnel or bubble.
Declaration
public RoutingDirection Direction { get; set; }
Property Value
RoutingDirection
|
RoutedEvent
Gets or sets a value indicating the routed event.
Declaration
public RoutedEvent RoutedEvent { get; set; }
Property Value
RoutedEvent
|
RoutedEventFullName
Gets or sets a string value indicating the routed event name.
Declaration
public string RoutedEventFullName { get; set; }
Property Value
System.String
|
Sender
Gets or sets the sender.
Declaration
public string Sender { get; set; }
Property Value
System.String
|
SenderType
Gets or sets the sender's type.
Declaration
public EventBehaviorSenderType SenderType { get; set; }
Property Value
EventBehaviorSenderType
|
Methods
IsSameEvent(RadElement, RoutedEventArgs)
Compares the instance with the other event arguments and the sender of the event.
Declaration
public bool IsSameEvent(RadElement senderElement, RoutedEventArgs eventArgs)
Parameters
RadElement
senderElement
|
RoutedEventArgs
eventArgs
|
Returns
System.Boolean
|
IsSameEvent(RaisedRoutedEvent)
Compares the instance with another event passed as a parameter.
Declaration
public bool IsSameEvent(RaisedRoutedEvent targetEvent)
Parameters
RaisedRoutedEvent
targetEvent
|
Returns
System.Boolean
|