Class ProgressEventArgs
Provides information about the Progressing event callback.
Inheritance
Namespace: Syncfusion.Blazor.Inputs
Assembly: Syncfusion.Blazor.dll
Syntax
public class ProgressEventArgs : ObjectRemarks
This event is triggered during file upload operations to provide real-time progress information. It enables developers to display upload progress indicators, calculate completion percentages, and provide user feedback during file transfer operations. The event provides both the amount of data transferred and the total file size for accurate progress calculation.
Constructors
ProgressEventArgs()
Declaration
public ProgressEventArgs()Properties
E
Gets or sets the original event arguments associated with the progress event.
Declaration
public object E { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | An object containing the original event arguments, or |
Remarks
This property provides access to the underlying event arguments that triggered the progress event. Note: This property is obsolete and should no longer be used in new implementations. Use other properties of this class for accessing progress information.
File
Gets or sets the details about the file being uploaded.
Declaration
public FileInfo File { get; set; }Property Value
| Type | Description |
|---|---|
| FileInfo | A FileInfo object containing comprehensive file details, or |
Remarks
This property contains detailed information about the file currently being uploaded, including file name, size, type, and upload status. This information is useful for displaying file-specific progress information and managing multiple file uploads simultaneously.
LengthComputable
Gets or sets a value indicating whether the file upload progress is computable.
Declaration
public bool LengthComputable { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Remarks
This property indicates whether the upload progress can be accurately calculated based on the
available information. When true, the Loaded and Total properties
provide reliable data for progress calculation. When false, progress cannot be determined,
and progress indicators should show indeterminate progress.
Loaded
Gets or sets the amount of data that has been uploaded so far.
Declaration
public Decimal Loaded { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | A decimal value representing the number of bytes that have been successfully uploaded. |
Remarks
This property indicates the current progress of the file upload operation in bytes. It can be used in conjunction with the Total property to calculate the upload percentage and display progress indicators to users. The value increases as more data is transferred.
Operation
Gets or sets the type of upload operation being performed.
Declaration
public string Operation { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string describing the upload operation type, or |
Remarks
This property indicates the specific type of upload operation that is currently in progress. It helps distinguish between different types of upload operations, such as initial upload, retry operations, or chunk-based uploads, allowing for operation-specific handling and reporting.
Stream
Gets the stream containing the uploaded file data.
Declaration
public Stream Stream { get; }Property Value
| Type | Description |
|---|---|
| System.IO.Stream | A Stream object containing the file data, or |
Remarks
This property provides access to the file data stream during the upload process. It can be used for custom processing of file content, validation, or streaming operations. The stream represents the actual file data being transferred during the upload operation.
Total
Gets or sets the total size of the file being uploaded.
Declaration
public Decimal Total { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | A decimal value representing the total file size in bytes. |
Remarks
This property represents the complete size of the file being uploaded. Combined with the Loaded property, it enables calculation of upload progress percentages and estimated completion times. This value remains constant throughout the upload process.