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.

Gives focus to an element given its .

A reference to the element to focus. A value indicating whether or not the browser should scroll the document to bring the newly-focused element into view. A value of false for preventScroll (the default) means that the browser will scroll the element into view after focusing it. If preventScroll is set to true, no scrolling will occur. The representing the asynchronous focus operation.

The antiforgery token included in the request form data.

Initializes a new instance of .

The antiforgery token value. The form field name for the antiforgery token.

Gets the antiforgery token value.

Gets the form field name for the antiforgery token.

Provides access to the antiforgery token associated with the current session.

Gets the current if available.

The current if available.

Component that renders an antiforgery token as a hidden field.

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.

If enabled, form submission is performed without fully reloading the page. This is equivalent to adding data-enhance to the form. This flag is only relevant in server-side rendering (SSR) scenarios. For interactive rendering, the flag has no effect since there is no full-page reload on submit anyway.

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.

Gets or sets the form handler name. This is required for posting it to a server-side endpoint. It is not used during interactive rendering.

A component used for editing a value of type .

The value for the component.

An expression that represents the value for the component.

A callback that gets invoked when the value changes.

Returns the name for the specified in the current context.

The expression to use to compute the name. The name for the specified in the current context. The provided must be a member expression with as it source.

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 . This property is uninitialized if the input does not have a parent .

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 formatting 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 CSS class string that combines the class attribute and and a string indicating the status of the field being edited (a combination of "modified", "valid", and "invalid"). Derived components should typically use this value for the primary HTML element's 'class' attribute.

Gets the value to be used for the input's "name" attribute.

Returns a dictionary with the same values as the specified .

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

An input component for editing values.

Gets or sets the associated . May be if accessed before the component is rendered.

An input component for editing date values. The supported types for the date value are:

Gets or sets the type of HTML input to be rendered.

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

Gets or sets the associated . May be if accessed before the component is rendered.

Constructs an instance of

Represents the type of HTML input to be rendered by a component.

Lets the user enter a date.

Lets the user enter both a date and a time.

Lets the user enter a month and a year.

Lets the user enter a time.

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.

Gets or sets the associated . May be if accessed before the component is rendered.

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 with Blazor Server.

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.

Gets or sets the associated . May be if accessed before the component is rendered.

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.

Gets or sets the associated . May be if accessed before the component is rendered.

Describes context for an component.

Instantiates a new .

The parent context, if any. 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.

Constructs an instance of .

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

Gets or sets the select . May be if accessed before the component is rendered.

An input component for editing values.

Gets or sets the associated . May be if accessed before the component is rendered.

A multiline input component for editing values.

Gets or sets the associated . May be if accessed before the component is rendered.

An error that occurred during the form mapping process.

Initializes a new instance of .

The path from the root of the mapping operation to the property or element that failed to map. The error messages associated with the mapping error. The attempted value that failed to map.

Gets or sets the instance that contains the property or element that failed to map.

For object models, this is the instance of the object that contains the property that failed to map. For collection models, this is the collection instance that contains the element that failed to map. For dictionaries, this is the dictionary instance that contains the element that failed to map.

Gets or sets the name of the property or element that failed to map.

Gets or sets the full path from the model root to the property or element that failed to map.

Gets the list of error messages associated with the mapping errors for this field.

Gets the attempted value that failed to map (if any).

Exposes validation messages for a given .

A context that tracks information about mapping a single value from form data.

Gets the name of that is allowed to supply data in this context.

If set, indicates that the mapping should only receive values if the incoming form matches this name. If null, the mapping should receive data from any form in the mapping scope.

Gets the name of the parameter to map data to.

Gets the of the value to map.

Gets the callback to invoke when an error occurs.

Maps a set of errors to a concrete containing instance.

For example, maps errors for a given property in a class to the class instance. This is required so that validation can work without the need of the full identifier.

Gets the result of the mapping operation.

Sets the result of the mapping operation.

The result of the mapping operation. Thrown if the result has already been set.

Maps form data values to a model.

Determines whether the specified value type can be mapped.

The for the value to map. The name of the current . The form name, if values should only be provided for that form, or null to allow values from any form within the scope. true if the value type can be mapped; otherwise, false.

Maps the form value with the specified name to a value of the specified type. The .

Extension methods for configuring within an .

Adds support for within the .

The . The .

The context associated with a given form mapping operation.

The mapping scope name.

Retrieves the list of errors for a given model key.

The key used to identify the specific part of the model. The list of errors associated with that part of the model if any.

Retrieves the list of errors for a given model key.

The key used to identify the specific part of the model. Form name for a form under this context. The list of errors associated with that part of the model if any.

Retrieves all the errors for the model.

The list of errors associated with the model if any.

Retrieves all the errors for the model.

Form name for a form under this context. The list of errors associated with the model if any.

Retrieves the attempted value that failed to map for a given model key.

The key used to identify the specific part of the model. The attempted value associated with that part of the model if any.

Retrieves the attempted value that failed to map for a given model key.

Form name for a form under this context. The key used to identify the specific part of the model. The attempted value associated with that part of the model if any.

Defines the mapping scope for data received from form posts.

The mapping scope name.

Specifies the content to be rendered inside this .

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 .

Provides content to components.

Gets or sets the content to be rendered in instances.

Renders content provided by components.

Enables rendering an HTML <title> to a component.

Gets or sets the content to be rendered as the document title.

Provides a mechanism for rendering components non-interactively as HTML markup.

Constructs an instance of .

The services to use when rendering components. The logger factory to use.

Gets the associated with this instance. Any calls to or must be performed using this .

Adds an instance of the specified component and instructs it to render. The resulting content represents the initial synchronous rendering output, which may later change. To wait for the component hierarchy to complete any asynchronous operations such as loading, await before reading content from the .

The component type. An instance representing the render output.

The component type. Parameters for the component. An instance representing the render output.

The component type. This must implement . An instance representing the render output.

The component type. This must implement . Parameters for the component. An instance representing the render output.

Adds an instance of the specified component and instructs it to render, waiting for the component hierarchy to complete asynchronous tasks such as loading.

The component type. A task that completes with once the component hierarchy has completed any asynchronous tasks such as loading.

Adds an instance of the specified component and instructs it to render, waiting for the component hierarchy to complete asynchronous tasks such as loading.

The component type. This must implement . A task that completes with once the component hierarchy has completed any asynchronous tasks such as loading.

Adds an instance of the specified component and instructs it to render, waiting for the component hierarchy to complete asynchronous tasks such as loading.

The component type. Parameters for the component. A task that completes with once the component hierarchy has completed any asynchronous tasks such as loading.

Adds an instance of the specified component and instructs it to render, waiting for the component hierarchy to complete asynchronous tasks such as loading.

The component type. This must implement . Parameters for the component. A task that completes with once the component hierarchy has completed any asynchronous tasks such as loading.

Represents the output of rendering a root component as HTML. The content can change if the component instance re-renders.

Gets a that completes when the component hierarchy has completed asynchronous tasks such as loading.

Returns an HTML string representation of the component's latest output.

An HTML string representation of the component's latest output.

Writes the component's latest output as HTML to the specified writer.

The output destination.

Configures options for allowing JavaScript to add root components dynamically.

Gets the store of configuration options that allow JavaScript to add root components dynamically.

Extension methods for working on an .

Marks the specified component type as allowed for instantiation from JavaScript.

The component type. The . A unique identifier for the component type that will be used by JavaScript code.

Marks the specified component type as allowed for instantiation from JavaScript.

The component type. The . A unique identifier for the component type that will be used by JavaScript code. Specifies an optional identifier for a JavaScript function that will be called to register the custom element.

Marks the specified component type as allowed for instantiation from JavaScript.

The . The component type. A unique identifier for the component type that will be used by JavaScript code.

Marks the specified component type as allowed for instantiation from JavaScript.

The . The component type. A unique identifier for the component type that will be used by JavaScript code. Specifies an optional identifier for a JavaScript function that will be called to register the custom element.

Specifies options for use when enabling JS component support. This type is not normally used directly from application code. In most cases, applications should call methods on the on their application host builder.

Provides JavaScript-callable interop methods that can add, update, or remove dynamic root components. This is intended for framework use only and should not be called directly from application code.

Constructs an instance of . This is only intended for use from framework code and should not be used directly from application code.

The

For framework use only.

A indicating that the component should be interactive, with its hosting platform determined automatically based on a policy.

Constructs an instance of .

Constructs an instance of

A flag indicating whether the component should first prerender on the server. The default value is true.

A indicating that the component should be rendered interactively on the server using Blazor Server hosting.

Constructs an instance of .

Constructs an instance of

A flag indicating whether the component should first prerender on the server. The default value is true.

A indicating that the component should be rendered interactively on the client using WebAssembly.

Constructs an instance of .

Constructs an instance of

A flag indicating whether the component should first prerender on the server. The default value is true.

Provides pre-constructed instances that may be used during rendering.

Gets an that represents rendering interactively on the server via Blazor Server hosting with server-side prerendering.

Gets an that represents rendering interactively on the client via Blazor WebAssembly hosting with server-side prerendering.

Gets an that means the render mode will be determined automatically based on a policy.

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 or sets the content to show when is empty or when the is zero.

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.

Gets or sets the tag name of the HTML element that will be used as the virtualization spacer. One such element will be rendered before the visible items, and one more after them, using an explicit "height" style to control the scroll range. The default value is "div". If you are placing the instance inside an element that requires a specific child tag name, consider setting that here. For example when rendering inside a "tbody", consider setting to the value "tr".

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 .

Captures errors thrown from its child content.

Invoked by the base class when an error is being handled. The default implementation logs the error.

The being handled.

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.

Logs exception information for a component.

Logs the supplied .

The to log. A representing the completion of the operation.

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 X coordinate of the mouse pointer relative to the whole document.

The Y coordinate of the mouse pointer relative to the whole document.

The X coordinate of the mouse pointer relative to the position of the last mousemove event.

The Y coordinate of the mouse pointer relative to the position of the last mousemove event.

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.

Creates an for the provided and .