Microsoft.AspNetCore.Components
Performs conversions during binding.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided for inclusion in an attribute.
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The format to use. Provided to .
The to use while formatting. Defaults to .
The formatted value.
Formats the provided as a .
The value to format.
The to use while formatting. Defaults to .
The formatted value.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a nullable .
The object to convert.
The to use for conversion.
The format string to use in conversion.
The converted value.
true if conversion is successful, otherwise false.
Attempts to convert a value to a value of type .
The object to convert.
The to use for conversion.
The converted value.
true if conversion is successful, otherwise false.
Configures options for binding specific element types.
Constructs an instance of .
The tag name of the element.
The suffix value. For example, set this to value for bind-value, or set this to for bind.
The name of the value attribute to be bound.
The name of an attribute that will register an associated change event.
Gets the tag name of the element.
Gets the suffix value.
For example, this will be value to mean bind-value, or to mean bind.
Gets the name of the value attribute to be bound.
Gets the name of an attribute that will register an associated change event.
Denotes the target member as a cascading component parameter. Its value will be
supplied by the closest ancestor component that
supplies values with a compatible type and name.
If specified, the parameter value will be supplied by the closest
ancestor that supplies a value with
this name.
If null, the parameter value will be supplied by the closest ancestor
that supplies a value with a compatible
type.
Represents a parameter whose value cascades down the component hierarchy.
Gets a flag indicating whether the cascading parameter should
be supplied only once per component.
Contains information about a cascading parameter.
Gets the property's attribute.
Gets the name of the parameter's property.
Gets the type of the parameter's property.
Denotes the generic type parameter as cascading. This allows generic type inference
to use this type parameter value automatically on descendants that also have a type
parameter with the same name.
Constructs an instance of .
The name of the type parameter.
Gets the name of the type parameter.
A component that provides a cascading value to all descendant components.
The content to which the value should be provided.
The value to be provided.
Optionally gives a name to the provided value. Descendant components
will be able to receive the value by specifying this name.
If no name is specified, then descendant components will receive the
value based the type of value they are requesting.
If true, indicates that will not change. This is a
performance optimization that allows the framework to skip setting up
change notifications. Set this flag only if you will not change
during the component's lifetime.
Supplies a cascading value that can be received by components using
.
Constructs an instance of .
The initial value.
A flag to indicate whether the value is fixed. If false, all receipients will subscribe for update notifications, which you can issue by calling . These subscriptions come at a performance cost, so if the value will not change, set to true.
Constructs an instance of .
A name for the cascading value. If set, can be configured to match based on this name.
The initial value.
A flag to indicate whether the value is fixed. If false, all receipients will subscribe for update notifications, which you can issue by calling . These subscriptions come at a performance cost, so if the value will not change, set to true.
Constructs an instance of .
A callback that produces the initial value when first required.
A flag to indicate whether the value is fixed. If false, all receipients will subscribe for update notifications, which you can issue by calling . These subscriptions come at a performance cost, so if the value will not change, set to true.
Constructs an instance of .
A name for the cascading value. If set, can be configured to match based on this name.
A callback that produces the initial value when first required.
A flag to indicate whether the value is fixed. If false, all receipients will subscribe for update notifications, which you can issue by calling . These subscriptions come at a performance cost, so if the value will not change, set to true.
Notifies subscribers that the value has changed (for example, if it has been mutated).
A that completes when the notifications have been issued.
Notifies subscribers that the value has changed, supplying a new value.
A that completes when the notifications have been issued.
Supplies information about an change event that is being raised.
Gets or sets the new value.
Used by generated code produced by the Components code generator. Not intended or supported
for use in application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Not intended for use by application code.
Optional base class for components. Alternatively, components may
implement directly.
Constructs an instance of .
Renders the component to the supplied .
A that will receive the render output.
Method invoked when the component is ready to start, having received its
initial parameters from its parent in the render tree.
Method invoked when the component is ready to start, having received its
initial parameters from its parent in the render tree.
Override this method if you will perform an asynchronous operation and
want the component to refresh when that operation is completed.
A representing any asynchronous operation.
Method invoked when the component has received parameters from its parent in
the render tree, and the incoming values have been assigned to properties.
Method invoked when the component has received parameters from its parent in
the render tree, and the incoming values have been assigned to properties.
A representing any asynchronous operation.
Notifies the component that its state has changed. When applicable, this will
cause the component to be re-rendered.
Returns a flag to indicate whether the component should render.
Method invoked after each time the component has rendered interactively and the UI has finished
updating (for example, after elements have been added to the browser DOM). Any
fields will be populated by the time this runs.
This method is not invoked during prerendering or server-side rendering, because those processes
are not attached to any live browser DOM and are already complete before the DOM is updated.
Set to true if this is the first time has been invoked
on this component instance; otherwise false.
The and lifecycle methods
are useful for performing interop, or interacting with values received from @ref.
Use the parameter to ensure that initialization work is only performed
once.
Method invoked after each time the component has been rendered interactively and the UI has finished
updating (for example, after elements have been added to the browser DOM). Any
fields will be populated by the time this runs.
This method is not invoked during prerendering or server-side rendering, because those processes
are not attached to any live browser DOM and are already complete before the DOM is updated.
Note that the component does not automatically re-render after the completion of any returned ,
because that would cause an infinite render loop.
Set to true if this is the first time has been invoked
on this component instance; otherwise false.
A representing any asynchronous operation.
The and lifecycle methods
are useful for performing interop, or interacting with values received from @ref.
Use the parameter to ensure that initialization work is only performed
once.
Executes the supplied work item on the associated renderer's
synchronization context.
The work item to execute.
Executes the supplied work item on the associated renderer's
synchronization context.
The work item to execute.
Treats the supplied as being thrown by this component. This will cause the
enclosing ErrorBoundary to transition into a failed state. If there is no enclosing ErrorBoundary,
it will be regarded as an exception from the enclosing renderer.
This is useful if an exception occurs outside the component lifecycle methods, but you wish to treat it
the same as an exception from a component lifecycle method.
The that will be dispatched to the renderer.
A that will be completed when the exception has finished dispatching.
Sets parameters supplied by the component's parent in the render tree.
The parameters.
A that completes when the component has finished updating and rendering itself.
Parameters are passed when is called. It is not required that
the caller supply a parameter value for all of the parameters that are logically understood by the component.
The default implementation of will set the value of each property
decorated with or that has
a corresponding value in the . Parameters that do not have a corresponding value
will be unchanged.
Dispatches external actions to be executed on the context of a .
Creates a default instance of .
A instance.
Provides notifications of unhandled exceptions that occur within the dispatcher.
Gets the associated with the dispatcher.
Validates that the currently executing code is running inside the dispatcher.
Returns a value that determines whether using the dispatcher to invoke a work item is required
from the current context.
true if invoking is required, otherwise false.
Invokes the given in the context of the associated .
The action to execute.
A that will be completed when the action has finished executing.
Invokes the given in the context of the associated .
The asynchronous action to execute.
A that will be completed when the action has finished executing.
Invokes the given in the context of the associated .
The function to execute.
A that will be completed when the function has finished executing.
Invokes the given in the context of the associated .
The asynchronous function to execute.
A that will be completed when the function has finished executing.
Called to notify listeners of an unhandled exception.
The .
A component that renders another component dynamically according to its
parameter.
Constructs an instance of .
Gets or sets the type of the component to be rendered. The supplied type must
implement .
Gets or sets a dictionary of parameters to be passed to the component.
Gets rendered component instance.
Specifies that the component parameter is required to be provided by the user when authoring it in the editor.
If a value for this parameter is not provided, editors or build tools may provide warnings indicating the user to
specify a value. This attribute is only valid on properties marked with .
Represents a reference to a rendered element.
Gets a unique identifier for .
The Id is unique at least within the scope of a given user/circuit.
This property is public to support Json serialization and should not be used by user code.
Gets the instance.
Instantiates a new .
A unique identifier for this .
The nullable instance.
Instantiates a new .
A unique identifier for this .
Context for an .
A base class for error boundary components.
The content to be displayed when there is no error.
The content to be displayed when there is an error.
The maximum number of errors that can be handled. If more errors are received,
they will be treated as fatal. Calling resets the count.
Gets the current exception, or null if there is no exception.
Resets the error boundary to a non-errored state. If the error boundary is not
already in an errored state, the call has no effect.
Invoked by the base class when an error is being handled. Typically, derived classes
should log the exception from this method.
The being handled.
A bound event handler delegate.
Gets a reference to the .
Gets an empty .
Creates the new .
The event receiver.
The delegate to bind.
Gets a value that indicates whether the delegate associated with this event dispatcher is non-null.
Invokes the delegate associated with this binding and dispatches an event notification to the
appropriate component.
The argument.
A which completes asynchronously once event processing has completed.
Invokes the delegate associated with this binding and dispatches an event notification to the
appropriate component.
A which completes asynchronously once event processing has completed.
A factory for creating and
instances.
Returns the provided . For internal framework use only.
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Returns the provided . For internal framework use only.
Returns the provided . For internal framework use only.
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The event receiver.
The event callback.
The .
Creates an for the provided and
. For internal framework use only.
Creates an for the provided and
. For internal framework use only.
Contains extension methods for two-way binding using . For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Provides extension methods for and types.
Creates an for the provided and
.
The .
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The .
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The .
The event receiver.
The event callback.
The .
Creates an for the provided and
.
The .
The event receiver.
The event callback.
The .
A bound event handler delegate.
Gets an empty .
Creates the new .
The event receiver.
The delegate to bind.
Gets a value that indicates whether the delegate associated with this event dispatcher is non-null.
Invokes the delegate associated with this binding and dispatches an event notification to the
appropriate component.
The argument.
A which completes asynchronously once event processing has completed.
Invokes the delegate associated with this binding and dispatches an event notification to the
appropriate component.
A which completes asynchronously once event processing has completed.
Wraps a callback delegate associated with an event.
An empty .
Creates a new with the provided .
The callback delegate.
Invokes the delegate associated with this .
The argument to provide to the delegate. May be null.
A then will complete asynchronously once the delegate has completed.
Associates an event argument type with an event attribute name.
Constructs an instance of .
Constructs an instance of .
Gets the attribute name.
Gets the event argument type.
Gets the event's ability to stop propagation.
Gets the event's ability to prevent default event flow.
Represents a UI component.
Attaches the component to a .
A that allows the component to be rendered.
Sets parameters supplied by the component's parent in the render tree.
The parameters.
A that completes when the component has finished updating and rendering itself.
The method should be passed the entire set of parameter values each
time is called. It not required that the caller supply a parameter
value for all parameters that are logically understood by the component.
Represents an activator that can be used to instantiate components.
The activator is not responsible for dependency injection, since the framework
performs dependency injection to the resulting instances separately.
Creates a component of the specified type.
The type of component to create.
A reference to the newly created component.
Represents a render mode for a component.
Interface implemented by components that receive notification that they have been rendered.
Notifies the component that it has been rendered.
A that represents the asynchronous event handling operation.
Interface implemented by components that receive notification of state changes.
Notifies the a state change has been triggered.
The associated with this event.
The argument associated with this event.
A that completes once the component has processed the state change.
Manages the persistent state of components in an application.
Initializes a new instance of .
Gets the associated with the .
Restores the component application state from the given .
The to restore the application state from.
A that will complete when the state has been restored.
Persists the component application state into the given .
The to restore the application state from.
The that components are being rendered.
A that will complete when the state has been restored.
Indicates that the associated property should have a value injected from the
service provider during initialization.
Gets or sets the object that specifies the key of the service to inject.
Manages the storage for components and services that are part of a Blazor application.
Gets the persisted state from the store.
The persisted state.
Persists the serialized state into the storage.
The serialized state to persist.
A that completes when the state is persisted to disk.
Returns a value that indicates whether the store supports the given .
The in question.
true if the render mode is supported by the store, otherwise false.
Indicates that the associated component type uses a specified layout.
Constructs an instance of .
The type of the layout.
The type of the layout. The type must implement
and must accept a parameter with the name 'Body'.
Optional base class for components that represent a layout.
Alternatively, components may implement directly
and declare their own parameter named .
Gets the content to be rendered inside the layout.
Displays the specified content inside the specified layout and any further
nested layouts.
Gets or sets the content to display.
Gets or sets the type of the layout in which to display the content.
The type must implement and accept a parameter named .
An exception thrown when throws an exception.
Creates a new instance of .
The exception message.
The inner exception.
A string value that can be rendered as markup such as HTML.
Constructs an instance of .
The value for the new instance.
Gets the value of the .
Casts a to a .
The value.
Exception thrown when an is not able to navigate to a different url.
Initializes a new instance.
Gets the uri to which navigation was attempted.
Provides an abstraction for querying and managing URI navigation.
An event that fires when the navigation location has changed.
Gets or sets the current base URI. The is always represented as an absolute URI in string form with trailing slash.
Typically this corresponds to the 'href' attribute on the document's <base> element.
Setting will not trigger the event.
Gets or sets the current URI. The is always represented as an absolute URI in string form.
Setting will not trigger the event.
Gets or sets the state associated with the current navigation.
Setting will not trigger the event.
Navigates to the specified URI.
The destination URI. This can be absolute, or relative to the base URI
(as returned by ).
If true, bypasses client-side routing and forces the browser to load the new page from the server, whether or not the URI would normally be handled by the client-side router.
Navigates to the specified URI.
The destination URI. This can be absolute, or relative to the base URI
(as returned by ).
If true, bypasses client-side routing and forces the browser to load the new page from the server, whether or not the URI would normally be handled by the client-side router.
If true, replaces the current entry in the history stack. If false, appends the new entry to the history stack.
Navigates to the specified URI.
The destination URI. This can be absolute, or relative to the base URI
(as returned by ).
Provides additional .
Navigates to the specified URI.
The destination URI. This can be absolute, or relative to the base URI
(as returned by ).
If true, bypasses client-side routing and forces the browser to load the new page from the server, whether or not the URI would normally be handled by the client-side router.
Navigates to the specified URI.
The destination URI. This can be absolute, or relative to the base URI
(as returned by ).
Provides additional .
Refreshes the current page via request to the server.
If is true, a full page reload will always be performed.
Otherwise, the response HTML may be merged with the document's existing HTML to preserve client-side state,
falling back on a full page reload if necessary.
Called to initialize BaseURI and current URI before these values are used for the first time.
Override and call this method to dynamically calculate these values.
Allows derived classes to lazily self-initialize. Implementations that support lazy-initialization should override
this method and call .
Converts a relative URI into an absolute one (by resolving it
relative to the current absolute URI).
The relative URI.
The absolute URI.
Given a base URI (e.g., one previously returned by ),
converts an absolute URI into one relative to the base URI prefix.
An absolute URI that is within the space of the base URI.
A relative URI path.
Triggers the event with the current URI value.
Notifies the registered handlers of the current location change.
The destination URI. This can be absolute, or relative to the base URI.
The state associated with the target history entry.
Whether this navigation was intercepted from a link.
A representing the completion of the operation. If the result is , the navigation should continue.
Handles exceptions thrown in location changing handlers.
The exception to handle.
The context passed to the handler.
Sets whether navigation is currently locked. If it is, then implementations should not update and call
until they have first confirmed the navigation by calling
.
Whether navigation is currently locked.
Registers a handler to process incoming navigation events.
The handler to process incoming navigation events.
An that can be disposed to unregister the location changing handler.
Provides extension methods for the type.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added or updated.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI that is constructed by updating with a single parameter
added, updated, or removed.
The .
The name of the parameter to add or update.
The value of the parameter to add or update.
If is null, the parameter will be removed if it exists in the URI.
Otherwise, it will be added or updated.
Returns a URI constructed from with multiple parameters
added, updated, or removed.
The .
The values to add, update, or remove.
Returns a URI constructed from except with multiple parameters
added, updated, or removed.
The .
The URI with the query to modify.
The values to add, update, or remove.
Additional options for navigating to another URI.
If true, bypasses client-side routing and forces the browser to load the new page from the server, whether or not the URI would normally be handled by the client-side router.
If true, replaces the currently entry in the history stack.
If false, appends the new entry to the history stack.
Gets or sets the state to append to the history entry.
A base class that creates a service provider scope.
Use the class as a base class to author components that control
the lifetime of a service provider scope. This is useful when using a transient or scoped service that
requires disposal such as a repository or database abstraction. Using
as a base class ensures that the service provider scope is disposed with the component.
Gets a value determining if the component and associated services have been disposed.
Gets the scoped that is associated with this component.
A base class that creates a service provider scope, and resolves a service of type .
The service type.
Use the class as a base class to author components that control
the lifetime of a service or multiple services. This is useful when using a transient or scoped service that
requires disposal such as a repository or database abstraction. Using
as a base class ensures that the service and relates services that share its scope are disposed with the component.
Gets the that is associated with this component.
Denotes the target member as a component parameter.
Gets or sets a value that determines whether the parameter will capture values that
don't match any other parameter.
allows a component to accept arbitrary additional
attributes, and pass them to another component, or some element of the underlying markup.
can be used on at most one parameter per component.
should only be applied to parameters of a type that
can be used with
such as .
Represents a single parameter supplied to an
by its parent in the render tree.
Gets the name of the parameter.
Gets the value being supplied for the parameter.
Gets a value to indicate whether the parameter is cascading, meaning that it
was supplied by a .
Represents a collection of parameters supplied to an
by its parent in the render tree.
Gets an empty .
Returns an enumerator that iterates through the .
The enumerator.
Gets the value of the parameter with the specified name.
The type of the value.
The name of the parameter.
Receives the result, if any.
True if a matching parameter was found; false otherwise.
Gets the value of the parameter with the specified name, or a default value
if no such parameter exists in the collection.
The type of the value.
The name of the parameter.
The parameter value if found; otherwise the default value for the specified type.
Gets the value of the parameter with the specified name, or a specified default value
if no such parameter exists in the collection.
The type of the value.
The name of the parameter.
The default value to return if no such parameter exists in the collection.
The parameter value if found; otherwise .
Returns a dictionary populated with the contents of the .
A dictionary populated with the contents of the .
Creates a new from the given .
The with the parameters.
A .
For each parameter property on , updates its value to
match the corresponding entry in the .
An object that has a public writable property matching each parameter's name and type.
An enumerator that iterates through a .
Gets the current value of the enumerator.
Instructs the enumerator to move to the next value in the sequence.
A flag to indicate whether or not there is a next value.
Provides a mechanism to build a with an unbound lifetime.
Constructs an instance of .
The maximum number of parameters that can be held.
Adds a parameter.
The name of the parameter.
The value of the parameter.
Supplies a completed .
The .
The state for the components and services of a components application.
Register a callback to persist the component state when the application is about to be paused.
Registered callbacks can use this opportunity to persist their state so that it can be retrieved when the application resumes.
The callback to invoke when the application is being paused.
A subscription that can be used to unregister the callback when disposed.
Register a callback to persist the component state when the application is about to be paused.
Registered callbacks can use this opportunity to persist their state so that it can be retrieved when the application resumes.
The callback to invoke when the application is being paused.
A subscription that can be used to unregister the callback when disposed.
Serializes as JSON and persists it under the given .
The type.
The key to use to persist the state.
The instance to persist.
Tries to retrieve the persisted state as JSON with the given and deserializes it into an
instance of type .
When the key is present, the state is successfully returned via
and removed from the .
The key used to persist the instance.
The persisted instance.
true if the state was found; false otherwise.
Represents a subscription to the OnPersisting callback that callback will trigger
when the application is being persisted.
Represents a segment of UI content, implemented as a delegate that
writes the content to a .
The to which the content should be written.
Represents a segment of UI content for an object of type , implemented as
a function that returns a .
The type of object.
The value used to build the content.
Allows a component to interact with its renderer.
Gets the associated with the component.
Gets a value that indicates whether the has been
initialized and is ready to use.
Gets a value that determines if the is triggering a render in response to a metadata update (hot-reload) change.
Notifies the renderer that the component should be rendered.
The content that should be rendered.
Dispatches an to the .
The that will be dispatched to the renderer.
A that will be completed when the exception has finished dispatching.
Tracks the rendering state associated with an instance
within the context of a . This is an internal implementation
detail of .
Constructs an instance of .
The with which the new instance should be associated.
The externally visible identifier for the . The identifier must be unique in the context of the .
The whose state is being tracked.
The for the parent component, or null if this is a root component.
Gets the component ID.
Gets the component instance.
Gets the of the parent component, or null if this is a root component.
Gets the of the logical parent component, or null if this is a root component.
Disposes this instance and its associated component.
Collects the data produced by the rendering system during the course
of rendering a single batch. This tracks both the final output data
and the intermediate states (such as the queue of components still to
be rendered).
Queues a work item that invokes the with this instance as the current synchronization context.
The work item will only run once has completed.
Workhorse for the InvokeAsync methods.
Similar to Post, but it can run the work item synchronously if the context is not busy.
This is the main code path used by components, we want to be able to run async work but only dispatch
if necessary.
Sets the current synchronization context to this instance, invokes the ,
resets the synchronization context, and sets marks the builder as completed.
Invokes with the supplied exception instance.
Provides methods for building a collection of entries.
The reserved parameter name used for supplying child content.
Appends a frame representing an element, i.e., a container for other frames.
In order for the state to be valid, you must
also call immediately after appending the
new element's child frames.
An integer that represents the position of the instruction in the source code.
A value representing the type of the element.
Marks a previously appended element frame as closed. Calls to this method
must be balanced with calls to .
Appends a frame representing markup content.
An integer that represents the position of the instruction in the source code.
Content for the new markup frame.
Appends a frame representing text content.
An integer that represents the position of the instruction in the source code.
Content for the new text frame.
Appends frames representing an arbitrary fragment of content.
An integer that represents the position of the instruction in the source code.
Content to append.
Appends frames representing an arbitrary fragment of content.
An integer that represents the position of the instruction in the source code.
Content to append.
The value used by .
Appends a frame representing markup content.
An integer that represents the position of the instruction in the source code.
Content for the new text frame, or null.
Appends a frame representing markup content.
An integer that represents the position of the instruction in the source code.
Content for the new markup frame.
Appends a frame representing text content.
An integer that represents the position of the instruction in the source code.
Content for the new text frame.
Appends a frame representing a bool-valued attribute with value 'true'.
The attribute is associated with the most recently added element.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
Appends a frame representing a bool-valued attribute.
The attribute is associated with the most recently added element. If the value is false and the
current element is not a component, the frame will be omitted.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
Appends a frame representing a string-valued attribute.
The attribute is associated with the most recently added element. If the value is null and the
current element is not a component, the frame will be omitted.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
Appends a frame representing a delegate-valued attribute.
The attribute is associated with the most recently added element. If the value is null and the
current element is not a component, the frame will be omitted.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
Appends a frame representing an attribute.
The attribute is associated with the most recently added element. If the value is null and the
current element is not a component, the frame will be omitted.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
This method is provided for infrastructure purposes, and is used to support generated code
that uses .
Appends a frame representing an attribute.
The attribute is associated with the most recently added element. If the value is null and the
current element is not a component, the frame will be omitted.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
This method is provided for infrastructure purposes, and is used to support generated code
that uses .
Appends a frame representing a string-valued attribute.
The attribute is associated with the most recently added element. If the value is null, or
the value false and the current element is not a component, the
frame will be omitted.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
Appends a frame representing an attribute.
The attribute is associated with the most recently added element.
An integer that represents the position of the instruction in the source code.
A holding the name and value of the attribute.
Adds frames representing multiple attributes with the same sequence number.
An integer that represents the position of the instruction in the source code.
A collection of key-value pairs representing attributes.
Indicates that the preceding attribute represents an event handler
whose execution updates the attribute with name .
This information is used by the rendering system to determine whether
to accept a value update for the other attribute when receiving a
call to the event handler.
The name of another attribute whose value can be updated when the event handler is executed.
Appends a frame representing a child component.
The type of the child component.
An integer that represents the position of the instruction in the source code.
Appends a frame representing a child component.
An integer that represents the position of the instruction in the source code.
The type of the child component.
Appends a frame representing a component parameter.
An integer that represents the position of the instruction in the source code.
The name of the attribute.
The value of the attribute.
Assigns the specified key value to the current element or component.
The value for the key.
Marks a previously appended component frame as closed. Calls to this method
must be balanced with calls to .
Appends a frame representing an instruction to capture a reference to the parent element.
An integer that represents the position of the instruction in the source code.
An action to be invoked whenever the reference value changes.
Appends a frame representing an instruction to capture a reference to the parent component.
An integer that represents the position of the instruction in the source code.
An action to be invoked whenever the reference value changes.
Adds a frame indicating the render mode on the enclosing component frame.
The .
Assigns a name to an event in the enclosing element.
The event type, e.g., 'onsubmit'.
The application-assigned name.
Appends a frame representing a region of frames.
An integer that represents the position of the instruction in the source code.
Marks a previously appended region frame as closed. Calls to this method
must be balanced with calls to .
Clears the builder.
Returns the values that have been appended.
An array range of values.
This comparer is optimized for use with dictionaries where the great majority of insertions/lookups
don't match existing entries. For example, when building a dictionary of almost entirely unique keys.
It's faster than the normal string comparer in this case because it doesn't use string.GetHashCode,
and hence doesn't have to consider every character in the string.
This primary scenario is , which needs
to detect when one attribute is overriding another, but in the vast majority of cases attributes don't
actually override each other.
Specifies a fixed rendering mode for a component type.
Where possible, components should not specify any render mode this way, and should
be implemented to work across all render modes. Component authors should only specify
a fixed rendering mode when the component is incapable of running in other modes.
Gets the fixed rendering mode for a component type.
Produces an structure describing the current contents.
The .
Produces an structure describing the selected contents.
The
The index of the first item in the segment.
One plus the index of the last item in the segment.
The .
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
The type of the elements in the array
Gets the current underlying array holding the segment's elements.
Gets the offset into the underlying array holding the segment's elements.
Gets the number of items in the segment.
Gets the specified item from the segment.
The index into the segment.
The array entry at the specified index within the segment.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
Gets the underlying array instance.
Gets the number of items in the array that are considered to be in use.
Constructs an instance of .
The array.
The number of items in the array that are in use.
Creates a shallow clone of the instance.
Types in the Microsoft.AspNetCore.Components.RenderTree namespace are not recommended for use outside
of the Blazor framework. These types will change in future release.
Indicates that the caller has specified a render mode.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in a future release.
Identifies the component whose render tree contains the affected form field.
Specifies the form field's new value.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in a future release.
Constructs an instance of .
The type of the change.
The ID of the component holding the named value.
The index of the frame within the component's current render output.
The event type.
The application-assigned name.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in a future release.
Constructs an instance of .
The type of the change.
The ID of the component holding the named value.
The index of the frame within the component's current render output.
The event type.
The application-assigned name.
Describes the type of the change.
The ID of the component holding the named event.
The index of the frame within the component's current render output.
The event type.
The application-assigned name.
Describes a change to a named event.
Indicates that the item was added.
Indicates that the item was removed.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in a future release.
Gets the changes to components that were added or updated.
Gets render frames that may be referenced by entries in .
For example, edit entries of type
will point to an entry in this array to specify the subtree to be prepended.
Gets the IDs of the components that were disposed.
Gets the IDs of the event handlers that were disposed.
Gets the named events that were changed, or null.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in a future release.
Allows the caller to handle exceptions from the SynchronizationContext when one is available.
Constructs an instance of .
The to be used when initializing components.
The .
Constructs an instance of .
The to be used when initializing components.
The .
The .
Gets the associated with this .
Gets or sets the associated with this ,
if it exists.
Gets a value that determines if the is triggering a render in response to a (metadata update) hot-reload change.
Gets whether the renderer has been disposed.
Gets the associated with the specified component.
The component ID
The corresponding .
Gets the for a given component if available.
The component type
Resolves the component state for a given instance.
The instance
Constructs a new component of the specified type.
The type of the component to instantiate.
The component instance.
Associates the with the , assigning
an identifier that is unique within the scope of the .
The component.
The component's assigned identifier.
Gets the current render tree for a given component.
The id for the component.
The representing the current render tree.
Performs the first render for a root component, waiting for this component and all
children components to finish rendering in case there is any asynchronous work being
done by any of the components. After this, the root component
makes its own decisions about when to re-render, so there is no need to call
this more than once.
The ID returned by .
Rendering a root component is an asynchronous operation. Clients may choose to not await the returned task to
start, but not wait for the entire render to complete.
Supplies parameters for a root component, normally causing it to render. This can be
used to trigger the first render of a root component, or to update its parameters and
trigger a subsequent render. Note that components may also make their own decisions about
when to re-render, and may re-render at any time.
The returned waits for this component and all descendant components to
finish rendering in case there is any asynchronous work being done by any of them.
The ID returned by .
The with the initial or updated parameters to use for rendering.
Rendering a root component is an asynchronous operation. Clients may choose to not await the returned task to
start, but not wait for the entire render to complete.
Removes the specified component from the renderer, causing the component and its
descendants to be disposed.
The ID of the root component.
Gets the type of the specified root component.
The root component ID.
The type of the component.
Allows derived types to handle exceptions during rendering. Defaults to rethrowing the original exception.
The .
Creates a instance to track state associated with a newly-instantiated component.
This is called before the component is initialized and tracked within the . Subclasses
may override this method to use their own subclasses of .
The ID of the newly-created component.
The component instance.
The associated with the parent component, or null if this is a root component.
A for the new component.
Updates the visible UI.
The changes to the UI since the previous call.
A to represent the UI update process.
Notifies the renderer that an event has occurred.
The value from the original event attribute.
Arguments to be passed to the event handler.
Information that the renderer can use to update the state of the existing render tree to match the UI.
A which will complete once all asynchronous processing related to the event
has completed.
Notifies the renderer that an event has occurred.
The value from the original event attribute.
Arguments to be passed to the event handler.
Information that the renderer can use to update the state of the existing render tree to match the UI.
A flag indicating whether to wait for quiescence.
A which will complete once all asynchronous processing related to the event
has completed.
Gets the event arguments type for the specified event handler.
The value from the original event attribute.
The parameter type expected by the event handler. Normally this is a subclass of .
Notifies the renderer that there is a pending task associated with a component. The
renderer is regarded as quiescent when all such tasks have completed.
The for the component associated with this pending task, if any.
The .
Schedules a render for the specified . Its display
will be populated using the specified .
The ID of the component to render.
A that will supply the updated UI contents.
Processes pending renders requests from components if there are any.
If the exception can be routed to an error boundary around , do so.
Otherwise handle it as fatal.
Releases all resources currently used by this instance.
if this method is being invoked by , otherwise .
Determines how to handle an when obtaining a component instance.
This is only called when a render mode is specified either at the call site or on the component type.
Subclasses may override this method to return a component of a different type, or throw, depending on whether the renderer
supports the render mode and how it implements that support.
The type of component that was requested.
The parent component ID, or null if it is a root component.
An that should be used when instantiating component objects.
The declared on or at the call site (for example, by the parent component).
An instance.
Releases all resources currently used by this instance.
This API supports the logging infrastructure and is not intended to be used directly from your code. It is subject to change in the future.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
Gets the ID of the component.
Gets the changes to the render tree since a previous state.
Exists only so that the various methods in this class can call each other without
constantly building up long lists of parameters. Is private to this class, so the
fact that it's a mutable struct is manageable.
Always pass by ref to avoid copying, and because the 'SiblingIndex' is mutable.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
Gets the type of the edit operation.
Gets the index of the sibling frame that the edit relates to.
Gets the index of related data in an associated render frames array. For example, if the
value is , gets the
index of the new frame data in an associated render tree.
If the value is ,
gets the sibling index to which the frame should be moved.
If the value is ,
gets the name of the attribute that is being removed.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
Indicates that a new frame should be inserted before the specified tree frame.
Indicates that the specified tree frame should be removed.
Indicates that an attribute value should be applied to the specified frame.
This may be a change to an existing attribute, or the addition of a new attribute.
Indicates that a named attribute should be removed from the specified frame.
Indicates that the text content of the specified frame (which must be a text frame)
should be updated.
Indicates that the edit position should move inside the specified frame.
Indicates that there are no further edit operations on the current frame, and the
edit position should move back to the parent frame.
Indicates that the markup content of the specified frame (which must be a markup frame)
should be updated.
An entry in a sparse permutation list. That is, a list of old indices with
corresponding new indices, which altogether describe a valid permutation of
the children at the current edit position.
Indicates that the preceding series of entries
is now complete.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
Gets the sequence number of the frame. Sequence numbers indicate the relative source
positions of the instructions that inserted the frames. Sequence numbers are only
comparable within the same sequence (typically, the same source method).
Describes the type of this frame.
If the property equals
gets the number of frames in the subtree for which this frame is the root.
The value is zero if the frame has not yet been closed.
If the property equals ,
gets a name representing the type of the element. Otherwise, the value is undefined.
If the property equals ,
gets the element's diffing key, or null if none was specified.
If the property equals ,
gets the content of the text frame. Otherwise, the value is undefined.
If the property equals
gets the ID of the corresponding event handler, if any.
If the property equals ,
gets the attribute name. Otherwise, the value is undefined.
If the property equals ,
gets the attribute value. Otherwise, the value is undefined.
If the property equals ,
and the attribute represents an event handler, gets the name of another attribute whose value
can be updated to represent the UI state prior to executing the event handler. This is
primarily used in two-way bindings.
If the property equals
gets the for the component frame.
If the property equals
gets the number of frames in the subtree for which this frame is the root.
The value is zero if the frame has not yet been closed.
If the property equals ,
gets the child component instance identifier.
If the property equals ,
gets the type of the child component.
If the property equals ,
gets the child component state object. Otherwise, the value is undefined.
If the property equals ,
gets the component's diffing key, or null if none was specified.
If the property equals ,
gets the child component instance. Otherwise, the value is undefined.
If the property equals
gets the number of frames in the subtree for which this frame is the root.
The value is zero if the frame has not yet been closed.
If the property equals ,
gets the ID of the reference capture. Otherwise, the value is undefined.
If the property equals ,
gets the action that writes the reference to its target. Otherwise, the value is undefined.
If the property equals ,
gets the index of the parent frame representing the component being captured. Otherwise, the value is undefined.
WARNING: This index can only be used in the context of the frame's original render tree. If the frame is
copied elsewhere, such as to the ReferenceFrames buffer of a RenderTreeDiff, then the index will
not relate to entries in that other buffer.
Currently there's no scenario where this matters, but if there was, we could change all of the subtree
initialization logic in RenderTreeDiffBuilder to walk the frames hierarchically, then it would know
the parent index at the point where it wants to initialize the ComponentReferenceCapture frame.
If the property equals ,
gets the action that writes the reference to its target. Otherwise, the value is undefined.
If the property equals ,
gets the content of the markup frame. Otherwise, the value is undefined.
If the property equals ,
gets the specified . Otherwise, the value is undefined.
If the property equals ,
gets the event type. Otherwise, the value is undefined.
If the property equals ,
gets the assigned name. Otherwise, the value is undefined.
A special subclass of that contains methods optimized for appending entries.
Types in the Microsoft.AspNetCore.Components.RenderTree are not recommended for use outside
of the Blazor framework. These types will change in future release.
Used only for uninitialized frames.
Represents a container for other frames.
Represents text content.
Represents a key-value pair associated with another .
Represents a child component.
Defines the boundary around range of sibling frames that should be treated as an
unsplittable group for the purposes of diffing. This is typically used when appending
a tree fragment generated by external code, because the sequence numbers in that tree
fragment are not comparable to sequence numbers outside it.
Represents an instruction to capture or update a reference to the parent element.
Represents an instruction to capture or update a reference to the parent component.
Represents a block of markup content.
Represents an instruction to use a specified render mode for the component.
Represents an application-assigned name for an event.
Implements a list that uses an array of objects to store the elements.
This differs from a in that
it not only grows as required but also shrinks if cleared with significant
excess capacity. This makes it useful for component rendering, because
components can be long-lived and re-render frequently, with the rendered size
varying dramatically depending on the user's navigation in the app.
Constructs a new instance of .
Gets the number of items.
Gets the underlying buffer.
Appends a new item, automatically resizing the underlying array if necessary.
The item to append.
The index of the appended item.
Sets the supplied value at the specified index. The index must be within
range for the array.
The index.
The value.
Removes the last item.
Inserts the item at the specified index, moving the contents of the subsequent entries along by one.
The index at which the value is to be inserted.
The value to insert.
Marks the array as empty, also shrinking the underlying storage if it was
not being used to near its full capacity.
Indicates that the associated component should match the specified route template pattern.
Constructs an instance of .
The route template.
Gets the route template.
Displays the specified page component, rendering it inside its layout
and any further nested layouts.
Gets or sets the route data. This determines the page that will be
displayed and the parameter values that will be supplied to the page.
Gets or sets the type of a layout to be used if the page does not
declare any layout. If specified, the type must implement
and accept a parameter named .
Renders the component.
The .
An optional interface for implementations that must be initialized
by the host.
Initializes the .
The base URI.
The absolute URI.
Contract to setup navigation interception on the client.
Enables navigation interception on the client.
A that represents the asynchronous operation.
Provides RouteData
Gets RouteData
Contract to setup scroll to location hash.
Refreshes scroll position for hash on the client.
Absolute URL of location
A that represents the asynchronous operation.
for .
Initializes a new instance of .
The location.
A value that determines if navigation for the link was intercepted.
Gets the changed location.
Gets a value that determines if navigation for the link was intercepted.
Gets the state associated with the current history entry.
Contains context for a change to the browser's current location.
Gets the target location.
Gets the state associated with the target history entry.
Gets whether this navigation was intercepted from a link.
Gets a that can be used to determine if this navigation was canceled
(for example, because the user has triggered a different navigation).
Prevents this navigation from continuing.
Provides information about the current asynchronous navigation event
including the target path and the cancellation token.
The target path for the navigation.
The to use to cancel navigation.
A component that supplies route data corresponding to the current navigation state.
Gets or sets the assembly that should be searched for components matching the URI.
Gets or sets a collection of additional assemblies that should be searched for components
that can match URIs.
Gets or sets the content to display when no match is found for the requested route.
Gets or sets the content to display when a match is found for the requested route.
Get or sets the content to display when asynchronous navigation is in progress.
Gets or sets a handler that should be called before navigating to a new page.
Gets or sets a flag to indicate whether route matching should prefer exact matches
over wildcards.
This property is obsolete and configuring it does nothing.
Shared logic for parsing tokens from route values and querystring values.
Creates an empty .
Creates a initialized with the specified .
A sequence of values to add to the dictionary..
Attempts to remove and return the value that has the specified key from the .
The key of the element to remove and return.
When this method returns, contains the object removed from the , or null if key does not exist.
true if the object was removed successfully; otherwise, false.
Attempts to the add the provided and to the dictionary.
The key.
The value.
Returns true if the value was added. Returns false if the key was already present.
Instantiates a new enumerator with the values provided in .
A .
Releases resources used by the .
Creates a new instance of from a collection of segments.
The raw text to associate with the route pattern. May be null.
The collection of segments.
The .
Creates a from the provided text
content.
The text content.
The .
Creates a from the provided text
content.
The text content.
The .
Creates a from the provided contraint.
The constraint object, which must be of type
or . If the constraint object is a
then it will be transformed into an instance of .
The .
Creates a from the provided constraint.
The constraint object.
The .
Creates a from the provided object.
The parameter policy object.
The .
The value for argument '{0}' should be less than or equal to the value for the argument '{1}'.
The value for argument '{0}' should be less than or equal to the value for the argument '{1}'.
The constructor to use for activating the constraint type '{0}' is ambiguous. Multiple constructors were found with the following number of parameters: {1}.
The constructor to use for activating the constraint type '{0}' is ambiguous. Multiple constructors were found with the following number of parameters: {1}.
Could not find a constructor for constraint type '{0}' with the following number of parameters: {1}.
Could not find a constructor for constraint type '{0}' with the following number of parameters: {1}.
The constraint type '{0}' which is mapped to constraint key '{1}' must implement the '{2}' interface.
The constraint type '{0}' which is mapped to constraint key '{1}' must implement the '{2}' interface.
The constraint entry '{0}' - '{1}' on the route '{2}' must have a string value or be of a type which implements '{3}'.
The constraint entry '{0}' - '{1}' on the route '{2}' must have a string value or be of a type which implements '{3}'.
The constraint entry '{0}' - '{1}' on the route '{2}' could not be resolved by the constraint resolver of type '{3}'.
The constraint entry '{0}' - '{1}' on the route '{2}' could not be resolved by the constraint resolver of type '{3}'.
The collection cannot be empty.
The constraint entry '{0}' - '{1}' must have a string value or be of a type which implements '{2}'.
The constraint entry '{0}' - '{1}' must have a string value or be of a type which implements '{2}'.
Invalid constraint '{0}'. A constraint must be of type 'string' or '{1}'.
Invalid constraint '{0}'. A constraint must be of type 'string' or '{1}'.
Invalid constraint '{0}' for parameter '{1}'. A constraint must be of type 'string', '{2}', or '{3}'.
Invalid constraint '{0}' for parameter '{1}'. A constraint must be of type 'string', '{2}', or '{3}'.
The constraint reference '{0}' could not be resolved to a type. Register the constraint type with '{1}.{2}'.
The constraint reference '{0}' could not be resolved to a type. Register the constraint type with '{1}.{2}'.
Invalid constraint type '{0}' registered as '{1}'. A constraint type must either implement '{2}', or inherit from '{3}'.
Invalid constraint type '{0}' registered as '{1}'. A constraint type must either implement '{2}', or inherit from '{3}'.
A route parameter uses the regex constraint, which isn't registered. If this application was configured using CreateSlimBuilder(...) or AddRoutingCore(...) then this constraint is not registered by default. To use the regex constraint, configure route opti ...
Value must be greater than or equal to {0}.
Value must be greater than or equal to {0}.
Value cannot be null or empty.
A path segment that contains more than one section, such as a literal section or a parameter, cannot contain a catch-all parameter.
A path segment cannot contain two consecutive parameters. They must be separated by a '/' or by a literal string.
The route template separator character '/' cannot appear consecutively. It must be separated by either a parameter or a literal value.
The route parameter '{0}' has both an inline default value and an explicit default value specified. A route parameter cannot contain an inline default value when a default value is specified explicitly. Consider removing one of them.
The route parameter '{0}' has both an inline default value and an explicit default value specified. A route parameter cannot contain an inline default value when a default value is specified explicitly. Consider removing one of them.
A catch-all parameter cannot be marked optional.
A catch-all parameter can only appear as the last segment of the route template.
An error occurred while creating the route with name '{0}' and template '{1}'.
An error occurred while creating the route with name '{0}' and template '{1}'.
The literal section '{0}' is invalid. Literal sections cannot contain the '?' character.
The literal section '{0}' is invalid. Literal sections cannot contain the '?' character.
The route parameter name '{0}' is invalid. Route parameter names must be non-empty and cannot contain these characters: '{{', '}}', '/'. The '?' character marks a parameter as optional, and can occur only at the end of the parameter. The '*' character mark ...
The route parameter name '{0}' is invalid. Route parameter names must be non-empty and cannot contain these characters: '{{', '}}', '/'. The '?' character marks a parameter as optional, and can occur only at the end of the parameter. The '*' character mark ...
The route template cannot start with a '~' character unless followed by a '/'.
There is an incomplete parameter in the route template. Check that each '{' character has a matching '}' character.
An optional parameter cannot have default value.
In the segment '{0}', the optional parameter '{1}' is preceded by an invalid segment '{2}'. Only a period (.) can precede an optional parameter.
In the segment '{0}', the optional parameter '{1}' is preceded by an invalid segment '{2}'. Only a period (.) can precede an optional parameter.
An optional parameter must be at the end of the segment. In the segment '{0}', optional parameter '{1}' is followed by '{2}'.
An optional parameter must be at the end of the segment. In the segment '{0}', optional parameter '{1}' is followed by '{2}'.
The route parameter name '{0}' appears more than one time in the route template.
The route parameter name '{0}' appears more than one time in the route template.
In a route parameter, '{' and '}' must be escaped with '{{' and '}}'.
Describes information determined during routing that specifies
the page to be displayed.
Constructs an instance of .
The type of the page matching the route, which must implement .
The route parameter values extracted from the matched route.
Gets the type of the page matching the route.
Gets route parameter values extracted from the matched route.
Gets the route template that was used to match the route if any.
Resolves components for an application.
Route precedence algorithm.
We collect all the routes and sort them from most specific to
less specific. The specificity of a route is given by the specificity
of its segments and the position of those segments in the route.
* A literal segment is more specific than a parameter segment.
* A parameter segment with more constraints is more specific than one with fewer constraints
* Segment earlier in the route are evaluated before segments later in the route.
For example:
/Literal is more specific than /Parameter
/Route/With/{parameter} is more specific than /{multiple}/With/{parameters}
/Product/{id:int} is more specific than /Product/{id}
Routes can be ambiguous if:
They are composed of literals and those literals have the same values (case insensitive)
They are composed of a mix of literals and parameters, in the same relative order and the
literals have the same values.
For example:
* /literal and /Literal
/{parameter}/literal and /{something}/literal
/{parameter:constraint}/literal and /{something:constraint}/literal
To calculate the precedence we sort the list of routes as follows:
* Shorter routes go first.
* A literal wins over a parameter in precedence.
* For literals with different values (case insensitive) we choose the lexical order
* For parameters with different numbers of constraints, the one with more wins
If we get to the end of the comparison routing we've detected an ambiguous pair of routes.
Provides content to components with matching s.
Gets or sets the ID that determines which instance will render
the content of this instance.
Gets or sets the ID that determines which instance will render
the content of this instance.
Gets or sets whether this component should provide the default content for the target
.
Gets or sets the content to be rendered in corresponding instances.
Renders content provided by components with matching s.
Gets or sets the ID that determines which instances will provide
content to this instance.
Gets or sets the ID that determines which instances will provide
content to this instance.
An attribute to indicate whether to stream the rendering of a component and its descendants.
This attribute only takes effect within renderers that support streaming rendering (for example,
server-side HTML rendering from a Razor Component endpoint). In other hosting models it has no effect.
If a component type does not declare this attribute, then instances of that component type will share
the same streaming rendering mode as their parent component.
Constructs an instance of
A flag to indicate whether this component and its descendants should stream their rendering. The default value is true.
Gets a flag indicating whether this component and its descendants should stream their rendering.
Indicates that routing components may supply a value for the parameter from the
current URL querystring. They may also supply further values if the URL querystring changes.
Gets or sets the name of the querystring parameter. If null, the querystring
parameter is assumed to have the same name as the associated property.
Enables component parameters to be supplied from the query string with .
Enables component parameters to be supplied from the query string with .
The .
The .
Gets a value that determines if OnDeltaApplied is subscribed to.
MetadataUpdateHandler event. This is invoked by the hot reload host via reflection.
Flags for a member that is JSON (de)serialized.
Flags for a component
Flags for a JSInvokable type.
An enumerable that can supply the name/value pairs from a URI query string.
Constructs an instance of .
The query string.
Constructs an instance of .
The query string.
Retrieves an object that can iterate through the name/value pairs in the query string.
An object that can iterate through the name/value pairs in the query string.
Represents a single name/value pair extracted from a query string during enumeration.
Gets the name from this name/value pair in its original encoded form.
To get the decoded string, call .
Gets the value from this name/value pair in its original encoded form.
To get the decoded string, call .
Decodes the name from this name/value pair.
Characters representing the decoded name.
Decodes the value from this name/value pair.
Characters representing the decoded value.
An enumerator that supplies the name/value pairs from a URI query string.
Gets the currently referenced key/value pair in the query string being enumerated.
Moves to the next key/value pair in the query string being enumerated.
True if there is another key/value pair, otherwise false.
An implementation that compares objects as-if
they were route value strings.
Values that are are not strings are converted to strings using
Convert.ToString(x, CultureInfo.InvariantCulture). null values are converted
to the empty string.
strings are compared using .
A default instance of the .
Initializes a new instance of the class with a specified error message.
The message that describes the error.
Initializes a new instance of the class with a specified error message
and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception.
A candidate route to match incoming URLs in a .
Gets or sets the .
Gets or sets the route constraints.
Gets or sets the route defaults.
Gets or sets the order of the entry.
Entries are ordered first by (ascending) then by (descending).
Gets or sets the precedence of the entry.
Entries are ordered first by (ascending) then by (descending).
Gets or sets the name of the route.
Gets the version of this route.
A node in a .
Initializes a new instance of .
The length of the path to this node in the .
Gets the length of the path to this node in the .
Gets or sets a value indicating whether this node represents a catch all segment.
Gets the list of matching route entries associated with this node.
These entries are sorted by precedence then template.
Gets the literal segments following this segment.
Gets or sets the representing
parameter segments with constraints following this segment in the .
Gets or sets the representing
parameter segments following this segment in the .
Gets or sets the representing
catch all parameter segments with constraints following this segment in the .
Gets or sets the representing
catch all parameter segments following this segment in the .
Initializes a new instance of .
The order associated with routes in this .
Gets the order of the routes associated with this .
Gets the root of the .
A marker object that can be used in to designate that
any non-null or non-empty value is required.
is only use in routing is in .
is not valid as a route value, and will convert to the null/empty string.
Gets the set of default values for the route pattern.
The keys of are the route parameter names.
Gets the set of parameter policy references for the route pattern.
The keys of are the route parameter names.
Gets a collection of route values that must be provided for this route pattern to be considered
applicable.
allows a framework to substitute route values into a parameterized template
so that the same route template specification can be used to create multiple route patterns.
This example shows how a route template can be used with required values to substitute known
route values for parameters.
Route Template: "{controller=Home}/{action=Index}/{id?}"
Route Values: { controller = "Store", action = "Index" }
A route pattern produced in this way will match and generate URL paths like: /Store,
/Store/Index, and /Store/Index/17.
Gets the precedence value of the route pattern for URL matching.
Precedence is a computed value based on the structure of the route pattern
used for building URL matching data structures.
Gets the precedence value of the route pattern for URL generation.
Precedence is a computed value based on the structure of the route pattern
used for building URL generation data structures.
Gets the raw text supplied when parsing the route pattern. May be null.
Gets the list of route parameters.
Gets the list of path segments.
Gets the parameter matching the given name.
The name of the parameter to match.
The matching parameter or null if no parameter matches the given name.
Creates a new instance of .
The route pattern as raw text.
The exception message.
Gets the route pattern associated with this exception.
Populates a with the data needed to serialize the target object.
The to populate with data.
The destination () for this serialization.
Represents a literal text part of a route pattern. Instances of
are immutable.
Gets the text content.
The of a standard parameter
without optional or catch all behavior.
The of an optional parameter.
The of a catch-all parameter.
Represents a parameter part in a route pattern. Instances of
are immutable.
Gets the list of parameter policies associated with this parameter.
Gets the value indicating if slashes in current parameter's value should be encoded.
Gets the default value of this route parameter. May be null.
Returns true if this part is a catch-all parameter.
Otherwise returns false.
Returns true if this part is an optional parameter.
Otherwise returns false.
Gets the of this parameter.
Gets the parameter name.
The parsed representation of a policy in a parameter. Instances
of are immutable.
Gets the constraint text.
Gets a pre-existing that was used to construct this reference.
Represents a part of a route pattern.
Gets the of this part.
Returns true if this part is literal text. Otherwise returns false.
Returns true if this part is a route parameter. Otherwise returns false.
Returns true if this part is an optional separator. Otherwise returns false.
Defines the kinds of instances.
The of a .
The of a .
The of a .
Represents a path segment in a route pattern. Instances of are
immutable.
Route patterns are made up of URL path segments, delimited by /. A
contains a group of
that represent the structure of a segment
in a route pattern.
Returns true if the segment contains a single part;
otherwise returns false.
Gets the list of parts in this segment.
Represents an optional separator part of a route pattern. Instances of
are immutable.
An optional separator is a literal text delimiter that appears between
two parameter parts in the last segment of a route pattern. The only separator
that is recognized is ..
In the route pattern /{controller}/{action}/{id?}.{extension?}
the . character is an optional separator.
An optional separator character does not need to present in the URL path
of a request for the route pattern to match.
Gets the text content of the part.
A typical constraint looks like the following
"exampleConstraint(arg1, arg2, 12)".
Here if the type registered for exampleConstraint has a single constructor with one argument,
The entire string "arg1, arg2, 12" will be treated as a single argument.
In all other cases arguments are split at comma.
Creates a new instance of instance.
The .
The display name (for use in error messages).
Builds a mapping of constraints.
An of the constraints.
Adds a constraint for the given key, resolved by the .
The key.
The text to be resolved by .
The can create instances
based on . See to register
custom constraint types.
Sets the given key as optional.
The key.
Gets or sets a collection of constraints on the current route.
ensures that types are added to the constraint map in a trimmer safe way.
This API allows reading the map without encountering a trimmer warning within the framework.
Adds or overwrites the parameter policy with the associated route pattern token.
The parameter policy type.
The route token used to apply the parameter policy.
Adds or overwrites the parameter policy with the associated route pattern token.
The route token used to apply the parameter policy.
The parameter policy type.
Throws an exception if the type is not an .
Resolves the inline constraint.
The inline constraint to resolve.
The the inline constraint was resolved to.
Initializes a new instance of the class.
Pattern:
^[A-Za-z]*$
Explanation:
○ Match if at the beginning of the string.
○ Match a character in the set [A-Za-z] atomically any number of times.
○ Match if at the end of the string or if before an ending newline.
Initializes a new instance of the class.
The child constraints that must match for this constraint to match.
Gets the child constraints that must match for this constraint to match.
Initializes a new instance of the class that constrains
a route parameter to be a string of a given length.
The length of the route parameter.
Initializes a new instance of the class that constrains
a route parameter to be a string of a given length.
The minimum length allowed for the route parameter.
The maximum length allowed for the route parameter.
Gets the minimum length allowed for the route parameter.
Gets the maximum length allowed for the route parameter.
Initializes a new instance of the class.
The maximum length allowed for the route parameter.
Gets the maximum length allowed for the route parameter.
Initializes a new instance of the class.
The maximum value allowed for the route parameter.
Gets the maximum allowed value of the route parameter.
Initializes a new instance of the class.
The minimum length allowed for the route parameter.
Gets the minimum length allowed for the route parameter.
Initializes a new instance of the class.
The minimum value allowed for the route parameter.
Gets the minimum allowed value of the route parameter.
Creates a new instance given the .
Gets the associated with the optional parameter.
Initializes a new instance of the class.
The minimum value.
The maximum value.
The minimum value should be less than or equal to the maximum value.
Gets the minimum allowed value of the route parameter.
Gets the maximum allowed value of the route parameter.
Initializes a new instance of the class.
The regular expression pattern to match.
Constructor for a given a .
A instance to use as a constraint.
Constructor for a given a .
A string containing the regex pattern.
Gets the regular expression used in the route constraint.
Extension methods for configuring cascading values on an .
Adds a cascading value to the . This is equivalent to having
a fixed at the root of the component hierarchy.
The value type.
The .
A callback that supplies a fixed value within each service provider scope.
The .
Adds a cascading value to the . This is equivalent to having
a fixed at the root of the component hierarchy.
The value type.
The .
A name for the cascading value. If set, can be configured to match based on this name.
A callback that supplies a fixed value within each service provider scope.
The .
Adds a cascading value to the . This is equivalent to having
a at the root of the component hierarchy.
With this overload, you can supply a which allows you
to notify about updates to the value later, causing recipients to re-render. This overload should
only be used if you plan to update the value dynamically.
The value type.
The .
A callback that supplies a within each service provider scope.
The .
Adds a cascading value to the , if none is already registered
with the value type. This is equivalent to having a fixed at
the root of the component hierarchy.
The value type.
The .
A callback that supplies a fixed value within each service provider scope.
The .
Adds a cascading value to the , if none is already registered
with the value type, regardless of the . This is equivalent to having a fixed
at the root of the component hierarchy.
The value type.
The .
A name for the cascading value. If set, can be configured to match based on this name.
A callback that supplies a fixed value within each service provider scope.
The .
Adds a cascading value to the , if none is already registered
with the value type. This is equivalent to having a fixed at
the root of the component hierarchy.
With this overload, you can supply a which allows you
to notify about updates to the value later, causing recipients to re-render. This overload should
only be used if you plan to update the value dynamically.
The value type.
The .
A callback that supplies a within each service provider scope.
The .
Custom -derived type for the GetAlphaRouteRegex method.
Cached, thread-safe singleton instance.
Initializes the instance.
Provides a factory for creating instances to be used by methods on .
Creates an instance of a used by methods on .
Provides the runner that contains the custom logic implementing the specified regular expression.
Scan the starting from base.runtextstart for the next match.
The text being scanned by the regular expression.
Search starting from base.runtextpos for the next location a match could possibly start.
The text being scanned by the regular expression.
true if a possible match was found; false if no more matches are possible.
Determine whether at base.runtextpos is a match for the regular expression.
The text being scanned by the regular expression.
true if the regular expression matches at the current position; otherwise, false.
Helper methods used by generated -derived implementations.
Default timeout value set in , or if none was set.
Whether is non-infinite.
Supports searching for characters in or not in "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".