Properties
Name | Type | Default | Description |
---|---|---|---|
Validation | |||
Error |
bool |
False | If true, the label will be displayed in an error state. |
ErrorId |
string |
null | The ErrorId that will be used by aria-describedby if Error true |
ErrorText |
string |
null | The ErrorText that will be displayed if Error true. |
For |
Expression<Func<T>> |
null | Specify an expression which returns the model's field for which validation messages should be displayed. |
Required |
bool |
False | If true, this form input is required to be filled out. |
RequiredError |
string |
"Required" | The error text that will be displayed if the input is not filled out but required. |
Validation |
object |
null | A validation func or a validation attribute. Supported types are: Func<T, bool> ... will output the standard error message "Invalid" if false Func<T, string> ... outputs the result as error message, no error if null Func<T, IEnumerable< string >> ... outputs all the returned error messages, no error if empty Func<object, string, IEnumerable< string >> input Form.Model, Full Path of Member ... outputs all the returned error messages, no error if empty Func<T, Task< bool >> ... will output the standard error message "Invalid" if false Func<T, Task< string >> ... outputs the result as error message, no error if null Func<T, Task<IEnumerable< string >>> ... outputs all the returned error messages, no error if empty Func<object, string, Task<IEnumerable< string >>> input Form.Model, Full Path of Member ... outputs all the returned error messages, no error if empty System.ComponentModel.DataAnnotations.ValidationAttribute instances |
Behavior | |||
Accept |
string |
null | Sets the file types this input will accept |
AppendMultipleFiles |
bool |
False | If true, when T is of type IReadOnlyList, additional files will be appended to the existing list |
Converter |
Converter<T, string> |
The generic converter of the component. | |
Culture |
CultureInfo |
The culture of the component. | |
Disabled |
bool |
False | Disables the FileUpload |
Files |
T |
null | The value of the MudFileUpload component. If T is IBrowserFile, it represents a single file. If T is IReadOnlyList<IBrowserFile>, it represents multiple files |
MaximumFileCount |
int |
10 | Represents the maximum number of files that can retrieved from the internal call to InputFileChangeEventArgs.GetMultipleFiles(). It does not limit the total number of uploaded files when AppendMultipleFiles="true". A limit should be validated manually, for example in the FilesChanged event callback. |
SuppressOnChangeWhenInvalid |
bool |
False | If true, OnFilesChanged will not trigger if validation fails |
Appearance | |||
ButtonTemplate |
RenderFragment<FileUploadButtonTemplateContext<T>> |
null | Renders the button that triggers the input. Required for functioning. |
Hidden |
bool |
True | If false, the inner FileInput will be visible |
InputClass |
string |
null | Css classes to apply to the internal InputFile |
InputStyle |
string |
null | Style to apply to the internal InputFile |
SelectedTemplate |
RenderFragment<T> |
null | Renders the selected files, if desired. |
Common | |||
Class |
string |
null | User class names, separated by space. |
Style |
string |
null | User styles, applied on top of the component's own classes and styles. |
Tag |
object |
null | Use Tag to attach any user data object to the component for your convenience. |
UserAttributes |
Dictionary<string, object> |
UserAttributes carries all attributes you add to the component that don't match any of its parameters. They will be splatted onto the underlying HTML tag. | |
EventCallbacks
Name | Type | Description |
---|---|---|
FilesChanged |
EventCallback<T> | Triggered when the internal OnChange event fires |
OnFilesChanged |
EventCallback<InputFileChangeEventArgs> | Called when the internal files are changed |
Methods
Name | Parameters | Return | Description |
---|---|---|---|
Task ClearAsync() |
Task |
||
string GetErrorText() |
string : Error text/message |
Return the validation error text or the conversion error message. | |
Task ResetAsync() |
Task |
Reset the value and the validation. | |
ResetValidation() |
Reset the validation. | ||
Task Validate() |
Task |
Cause this component to validate its value. |