Microsoft.AspNetCore.Components.Web

Configures options for binding subtypes of an HTML input element.

Constructs an instance of .

The value of the element's type attribute. The suffix value. The name of the value attribute to be bound. The name of an attribute that will register an associated change event. Determines whether binding will use or . An optional format to use when converting values.

Gets the value of the element's type attribute.

Gets the suffix value.

Gets the name of the value attribute to be bound.

Gets the name of an attribute that will register an associated change event.

Gets a value that determines whether binding will use or .

Gets an optional format to use when converting values.

Static class that adds extension methods to .

Gives focus to an element given its .

A reference to the element to focus. The representing the asynchronous focus operation.

Provides extension methods to describe the state of fields as CSS class names.

Gets a string that indicates the status of the specified field as a CSS class. This will include some combination of "modified", "valid", or "invalid", depending on the status of the field.

The . An identifier for the field. A string that indicates the status of the field.

Gets a string that indicates the status of the specified field as a CSS class.

The . An identifier for the field. A string that indicates the status of the field.

Associates the supplied with the supplied . This customizes the field CSS class names used within the .

The . The .

Renders a form element that cascades an to descendants.

Constructs an instance of .

Gets or sets a collection of additional attributes that will be applied to the created form element.

Supplies the edit context explicitly. If using this parameter, do not also supply , since the model value will be taken from the property.

Specifies the top-level model object for the form. An edit context will be constructed for this model. If using this parameter, do not also supply a value for .

Specifies the content to be rendered inside this .

A callback that will be invoked when the form is submitted. If using this parameter, you are responsible for triggering any validation manually, e.g., by calling .

A callback that will be invoked when the form is submitted and the is determined to be valid.

A callback that will be invoked when the form is submitted and the is determined to be invalid.

Supplies CSS class names for form fields to represent their validation state or other state information from an .

Gets a string that indicates the status of the specified field as a CSS class.

The . The . A CSS class name string.

A base class for form input components. This base class automatically integrates with an , which must be supplied as a cascading parameter.

Gets or sets a collection of additional attributes that will be applied to the created element.

Gets or sets the value of the input. This should be used with two-way binding.

@bind-Value="model.PropertyName"

Gets or sets a callback that updates the bound value.

Gets or sets an expression that identifies the bound value.

Gets or sets the display name for this field. This value is used when generating error messages when the input value fails to parse correctly.

Gets the associated .

Gets the for the bound value.

Gets or sets the current value of the input.

Gets or sets the current value of the input, represented as a string.

Constructs an instance of .

Formats the value as a string. Derived classes can override this to determine the formating used for .

The value to format. A string representation of the value.

Parses a string to create an instance of . Derived classes can override this to change how interprets incoming values.

The string value to be parsed. An instance of . If the value could not be parsed, provides a validation error message. True if the value could be parsed; otherwise false.

Gets a string that indicates the status of the field being edited. This will include some combination of "modified", "valid", or "invalid", depending on the status of the field.

Gets a CSS class string that combines the class attribute and properties. Derived components should typically use this value for the primary HTML element's 'class' attribute.

Returns a dictionary with the same values as the specified .

true, if a new dictrionary with copied values was created. false - otherwise.

An input component for editing values.

An input component for editing date values. Supported types are and .

Gets or sets the error message used when displaying an a parsing error.

A component that wraps the HTML file input element and supplies a for each file's contents.

Gets or sets the event callback that will be invoked when the collection of selected files changes.

Gets or sets a collection of additional attributes that will be applied to the input element.

Contains helper methods for .

Attempts to convert the current image file to a new one of the specified file type and maximum file dimensions. Caution: there is no guarantee that the file will be converted, or will even be a valid image file at all, either before or after conversion. The conversion is requested within the browser before it is transferred to .NET code, so the resulting data should be treated as untrusted.

The image will be scaled to fit the specified dimensions while preserving the original aspect ratio. The to convert to a new image file. The new image format. The maximum image width. The maximum image height A representing the completion of the operation.

Represents the data of a file selected from an component. Note: Metadata is provided by the client and is untrusted.

Gets the name of the file as specified by the browser.

Gets the last modified date as specified by the browser.

Gets the size of the file in bytes as specified by the browser.

Gets the MIME type of the file as specified by the browser.

Opens the stream for reading the uploaded file.

The maximum number of bytes that can be supplied by the Stream. Defaults to 500 KB. Calling will throw if the file's size, as specified by is larger than . By default, if the user supplies a file larger than 500 KB, this method will throw an exception. It is valuable to choose a size limit that corresponds to your use case. If you allow excessively large files, this may result in excessive consumption of memory or disk/database space, depending on what your code does with the supplied . For Blazor Server in particular, beware of reading the entire stream into a memory buffer unless you have passed a suitably low size limit, since you will be consuming that memory on the server. A cancellation token to signal the cancellation of streaming file data. Thrown if the file's length exceeds the value.

Supplies information about an event being raised.

Constructs a new instance.

The list of .

Gets the number of supplied files.

Gets the supplied file. Note that if the input accepts multiple files, then instead of reading this property, you should call .

Gets the file entries list. This method should be used for inputs that accept multiple files. If the input accepts only a single file, then use the property instead.

The maximum number of files to accept. If the number of files exceeds this value, this method will throw an exception.

Repesents configurable options for .

Gets or sets the maximum segment size for file data sent over a SignalR circuit. The default value is 20K. This only has an effect when using Blazor Server.

Gets or sets the maximum internal buffer size for unread data sent over a SignalR circuit. This only has an effect when using Blazor Server.

Gets or sets the time limit for fetching a segment of file data. This only has an effect when using Blazor Server.

An input component for editing numeric values. Supported numeric types are , , , , , .

Gets or sets the error message used when displaying an a parsing error.

Formats the value as a string. Derived classes can override this to determine the formatting used for CurrentValueAsString.

The value to format. A string representation of the value.

An input component used for selecting a value from a group of choices.

Gets context for this .

Gets or sets a collection of additional attributes that will be applied to the input element.

Gets or sets the value of this input.

Gets or sets the name of the parent input radio group.

Describes context for an component.

Gets the name of the input radio group.

Gets the current selected value in the input radio group.

Gets a css class indicating the validation state of input radio elements.

Gets the event callback to be invoked when the selected value is changed.

Instantiates a new .

The parent . The name of the input radio group. The current selected value in the input radio group. The css class indicating the validation state of input radio elements. The event callback to be invoked when the selected value is changed.

Finds an in the context's ancestors with the matching .

The group name of the ancestor . The , or null if none was found.

Groups child components.

Gets or sets the child content to be rendering inside the .

Gets or sets the name of the group.

A dropdown selection component.

Gets or sets the child content to be rendering inside the select element.

An input component for editing values.

A multiline input component for editing values.

Displays a list of validation messages for a specified field within a cascaded .

Gets or sets a collection of additional attributes that will be applied to the created div element.

Specifies the field for which validation messages should be displayed.

` Constructs an instance of .

Called to dispose this instance.

if called within .

Displays a list of validation messages from a cascaded .

Gets or sets the model to produce the list of validation messages for. When specified, this lists all errors that are associated with the model instance.

Gets or sets a collection of additional attributes that will be applied to the created ul element.

` Constructs an instance of .

A component that renders an anchor tag, automatically toggling its 'active' class based on whether its 'href' matches the current URI.

Gets or sets the CSS class name applied to the NavLink when the current route matches the NavLink href.

Gets or sets a collection of additional attributes that will be added to the generated a element.

Gets or sets the computed CSS class based on whether or not the link is active.

Gets or sets the child content of the component.

Gets or sets a value representing the URL matching behavior.

Modifies the URL matching behavior for a .

Specifies that the should be active when it matches any prefix of the current URL.

Specifies that the should be active when it matches the entire current URL.

A function that provides items to a virtualized source.

The type of the context for each item in the list. The defining the request details. A whose result is a upon successful completion.

Represents a request to an .

The start index of the data segment requested.

The requested number of items to be provided. The actual number of provided items does not need to match this value.

The used to relay cancellation of the request.

Constructs a new instance.

The start index of the data segment requested. The requested number of items to be provided. The used to relay cancellation of the request.

Represents the result of a .

The type of the context for each item in the list.

The items to provide.

The total item count in the source generating the items provided.

Instantiates a new instance.

The items to provide. The total item count in the source generating the items provided.

Contains context for a placeholder in a virtualized list.

The item index of the placeholder.

The size of the placeholder in pixels. For virtualized components with vertical scrolling, this would be the height of the placeholder in pixels. For virtualized components with horizontal scrolling, this would be the width of the placeholder in pixels.

Constructs a new instance.

The item index of the placeholder. The size of the placeholder in pixels.

Provides functionality for rendering a virtualized list of items.

The context type for the items being rendered.

Gets or sets the item template for the list.

Gets or sets the template for items that have not yet been loaded in memory.

Gets the size of each item in pixels. Defaults to 50px.

Gets or sets the function providing items to the list.

Gets or sets the fixed item source.

Gets or sets a value that determines how many additional items will be rendered before and after the visible region. This help to reduce the frequency of rendering during scrolling. However, higher values mean that more elements will be present in the page.

Instructs the component to re-request data from its . This is useful if external data may have changed. There is no need to call this when using .

A representing the completion of the operation.

Infrastructure for the discovery of bind attributes for markup elements.

To extend the set of bind attributes, define a public class named BindAttributes and annotate it with the appropriate attributes.

Supplies information about an clipboard event that is being raised.

Gets or sets the type of the event.

The object is used to hold the data that is being dragged during a drag and drop operation. It may hold one or more , each of one or more data types. For more information about drag and drop, see HTML Drag and Drop API.

Gets the type of drag-and-drop operation currently selected or sets the operation to a new type. The value must be none, copy, link or move.

Provides all of the types of operations that are possible. Must be one of none, copy, copyLink, copyMove, link, linkMove, move, all or uninitialized.

Contains a list of all the local files available on the data transfer. If the drag operation doesn't involve dragging files, this property is an empty list.

Gives a array which is a list of all of the drag data.

An array of giving the formats that were set in the dragstart event.

The object represents one drag data item. During a drag operation, each drag event has a dataTransfer property which contains a list of drag data items. Each item in the list is a object.

The kind of drag data item, string or file

The drag data item's type, typically a MIME type

Supplies information about an drag event that is being raised.

The data that underlies a drag-and-drop operation, known as the drag data store. See .

Supplies information about an error event that is being raised.

Gets a a human-readable error message describing the problem.

Gets the name of the script file in which the error occurred.

Gets the line number of the script file on which the error occurred.

Gets the column number of the script file on which the error occurred.

Gets or sets the type of the event.

Holds attributes to configure the mappings between event names and event argument types.

Supplies information about a focus event that is being raised.

Gets or sets the type of the event.

Supplies information about a keyboard event that is being raised.

The key value of the key represented by the event. If the value has a printed representation, this attribute's value is the same as the char attribute. Otherwise, it's one of the key value strings specified in 'Key values'. If the key can't be identified, this is the string "Unidentified"

Holds a string that identifies the physical key being pressed. The value is not affected by the current keyboard layout or modifier state, so a particular key will always return the same value.

The location of the key on the device.

true if a key has been depressed long enough to trigger key repetition, otherwise false.

true if the control key was down when the event was fired. false otherwise.

true if the shift key was down when the event was fired. false otherwise.

true if the alt key was down when the event was fired. false otherwise.

true if the meta key was down when the event was fired. false otherwise.

Gets or sets the type of the event.

Supplies information about a mouse event that is being raised.

A count of consecutive clicks that happened in a short amount of time, incremented by one.

The X coordinate of the mouse pointer in global (screen) coordinates.

The Y coordinate of the mouse pointer in global (screen) coordinates.

The X coordinate of the mouse pointer in local (DOM content) coordinates.

The Y coordinate of the mouse pointer in local (DOM content) coordinates.

The X coordinate of the mouse pointer in relative (Target Element) coordinates.

The Y coordinate of the mouse pointer in relative (Target Element) coordinates.

The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

true if the control key was down when the event was fired. false otherwise.

true if the shift key was down when the event was fired. false otherwise.

true if the alt key was down when the event was fired. false otherwise.

true if the meta key was down when the event was fired. false otherwise.

Gets or sets the type of the event.

Supplies information about a pointer event that is being raised.

A unique identifier for the pointer causing the event.

The width (magnitude on the X axis), in CSS pixels, of the contact geometry of the pointer.

The height (magnitude on the Y axis), in CSS pixels, of the contact geometry of the pointer.

The normalized pressure of the pointer input in the range of 0 to 1, where 0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively.

The plane angle (in degrees, in the range of -90 to 90) between the Y-Z plane and the plane containing both the transducer (e.g. pen stylus) axis and the Y axis.

The plane angle (in degrees, in the range of -90 to 90) between the X-Z plane and the plane containing both the transducer (e.g. pen stylus) axis and the X axis.

Indicates the device type that caused the event. Must be one of the strings mouse, pen or touch, or an empty string.

Indicates if the pointer represents the primary pointer of this pointer type.

Supplies information about a progress event that is being raised.

Whether or not the total size of the transfer is known.

The number of bytes transferred since the beginning of the operation. This doesn't include headers and other overhead, but only the content itself.

The total number of bytes of content that will be transferred during the operation. If the total size is unknown, this value is zero.

Gets or sets the type of the event.

Supplies information about a touch event that is being raised.

A count of consecutive clicks that happened in a short amount of time, incremented by one.

A list of for every point of contact currently touching the surface.

A list of for every point of contact that is touching the surface and started on the element that is the target of the current event.

A list of Touches for every point of contact which contributed to the event. For the touchstart event this must be a list of the touch points that just became active with the current event. For the touchmove event this must be a list of the touch points that have moved since the last event. For the touchend and touchcancel events this must be a list of the touch points that have just been removed from the surface.

true if the control key was down when the event was fired. false otherwise.

true if the shift key was down when the event was fired. false otherwise.

true if the alt key was down when the event was fired. false otherwise.

true if the meta key was down when the event was fired. false otherwise.

Gets or sets the type of the event.

Represents a single contact point on a touch-sensitive device. The contact point is commonly a finger or stylus and the device may be a touchscreen or trackpad.

A unique identifier for this Touch object. A given touch point (say, by a finger) will have the same identifier for the duration of its movement around the surface. This lets you ensure that you're tracking the same touch all the time.

The X coordinate of the touch point relative to the left edge of the screen.

The Y coordinate of the touch point relative to the top edge of the screen.

The X coordinate of the touch point relative to the left edge of the browser viewport, not including any scroll offset.

The Y coordinate of the touch point relative to the top edge of the browser viewport, not including any scroll offset.

The X coordinate of the touch point relative to the left edge of the document. Unlike , this value includes the horizontal scroll offset, if any.

The Y coordinate of the touch point relative to the top of the document. Unlike , this value includes the vertical scroll offset, if any.

Provides extension methods for and types.