Struct DropEvent

Namespace

Sdl3Sharp.Events

Assembly

Sdl3Sharp.dll

Represents an event that occurs when text data or a file is being drag'n'dropped onto the application

public struct DropEvent : ICommonEvent<DropEvent>, ICommonEvent, ISpanFormattable, IFormattable

Implements

ICommonEvent<DropEvent>

ICommonEvent

ISpanFormattable

IFormattable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Associated EventTypes:

• DropFile
• DropText
• DropBegin
• DropCompleted
• DropPosition

Properties

Data

Gets the text for DropText events or the file name for DropFile events

public string? Data { readonly get; set; }

Property Value

string

The text for DropText events, the file name for DropFile events, or null for other events

Remarks

Reading this property can be very expensive, you should consider caching it's value.

Setting this property is not supported and will lead the property to throw a NotSupportedException.

Exceptions

NotSupportedException

When setting this property

Source

Gets the source application that sent this drop event

public string? Source { readonly get; set; }

Property Value

string

The source application that sent this drop event, or null if that information isn't available

Remarks

Reading this property can be very expensive, you should consider caching it's value.

Setting this property is not supported and will lead the property to throw a NotSupportedException.

Exceptions

NotSupportedException

When setting this property

Timestamp

Gets or sets the timestamp of the current event

public ulong Timestamp { readonly get; set; }

Property Value

ulong

The timestamp of the current event, in nanoseconds in nanoseconds since the initialization of SDL

Remarks

The value of this property usually describes the time passed, in nanoseconds since the initialization of SDL. It can be properly populated by using NanosecondTicks.

Type

Gets or sets the type of the current event

public EventType Type { readonly get; set; }

Property Value

EventType

The type of the current event

Remarks

When setting this property, the value must be one of the EventType.Drop* values. Otherwise, it will lead the property to throw an ArgumentException!

Exceptions

ArgumentException

When setting this property, the value was not one of the EventType.Drop* values

WindowId

Gets or sets the window Id of the Window that was dropped on, if any

public uint WindowId { readonly get; set; }

Property Value

uint

The window Id of the Window that was dropped on, if any, or 0

X

Gets or set the X coordinate, relative to the Window

public float X { readonly get; set; }

Property Value

float

The X coordinate, relative to the Window

Remarks

The value of this property is not valid for DropBegin events.

Y

Gets or set the Y coordinate, relative to the Window

public float Y { readonly get; set; }

Property Value

float

The Y coordinate, relative to the Window

Remarks

The value of this property is not valid for DropBegin events.

Methods

ToString()

Returns the fully qualified type name of this instance.

public override readonly string ToString()

Returns

string

The fully qualified type name.

ToString(IFormatProvider?)

Formats the value of the current instance using the specified format.

public readonly string ToString(IFormatProvider? formatProvider)

Parameters

formatProvider IFormatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

ToString(string?)

Formats the value of the current instance using the specified format.

public readonly string ToString(string? format)

Parameters

format string

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

Returns

string

The value of the current instance in the specified format.

ToString(string?, IFormatProvider?)

Formats the value of the current instance using the specified format.

public readonly string ToString(string? format, IFormatProvider? formatProvider)

Parameters

format string

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider IFormatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider?)

Tries to format the value of the current instance into the provided span of characters.

public readonly bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = null)

Parameters

destination Span<char>

The span in which to write this instance's value formatted as a span of characters.

charsWritten int

When this method returns, contains the number of characters that were written in destination.

format ReadOnlySpan<char>

A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.

provider IFormatProvider

An optional object that supplies culture-specific formatting information for destination.

Returns

bool

true if the formatting was successful; otherwise, false.

Operators

explicit operator DropEvent(in Event)

Converts a general Event to an event of type DropEvent

public static explicit operator DropEvent(in Event @event)

Parameters

event Event

The general Event to convert to an event of type DropEvent

Returns

DropEvent

Remarks

The Type of the given event must be one of the EventType.Drop* values. Otherwise, it will lead the method to throw an ArgumentException!

Exceptions

ArgumentException

The Type of the given event was not one of the EventType.Drop* values

implicit operator Event(in DropEvent)

Converts an event of type DropEvent to a general Event

public static implicit operator Event(in DropEvent @event)

Parameters

event DropEvent

The event of type DropEvent to convert to a general Event

Returns

Event

Remarks

This conversion usually requires the event to be copied into a new general Event structure. Note: This can impact performance!