Class CancelEventArgs

Provides information about the OnCancel event callback.

Inheritance

object

CancelEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Inputs

Assembly: Syncfusion.Blazor.dll

Syntax

public class CancelEventArgs

Remarks

This event is triggered when a chunk file upload operation is canceled. It provides information about the cancellation status and the file that was being uploaded when the operation was canceled. This event allows developers to handle cancellation scenarios and take appropriate action.

Constructors

CancelEventArgs()

Declaration

public CancelEventArgs()

Properties

Cancel

Gets or sets a value indicating whether the chunk file upload cancel action has been canceled.

Declaration

[JsonPropertyName("cancel")]
public bool Cancel { get; set; }

Property Value

Type	Description
bool	`true` if the cancel action has been canceled; otherwise, `false`.

Remarks

This property allows you to prevent the cancellation of a file upload operation by setting it to true. This provides an opportunity to implement conditional cancellation logic based on application requirements.

Event

Gets or sets the original event arguments associated with the cancel operation.

Declaration

[Obsolete("This event argument property is obsolete; it should no longer be used.", false)]
[JsonPropertyName("event")]
public object Event { get; set; }

Property Value

Type	Description
object	An object containing the original event arguments for the current event, or `null` if no event arguments are available.

Remarks

This property provides access to the underlying event arguments that triggered the cancel operation. Note: This property is obsolete and should no longer be used in new implementations.

FileData

Gets or sets the details of the file that was canceled during upload.

Declaration

[JsonPropertyName("fileData")]
public FileInfo FileData { get; set; }

Property Value

Type	Description
FileInfo	A FileInfo object containing the details of the canceled file, or `null` if no file data is available.

Remarks

This property contains comprehensive information about the file that was being uploaded when the cancel operation occurred, including file name, size, type, and upload status. This information can be used for logging, user feedback, or cleanup operations.