Microsoft.AspNetCore.Mvc.Abstractions
Helper related to generic interface definitions and implementing classes.
Determine whether is or implements a closed generic
created from .
The of interest.
The open generic to match. Usually an interface.
The closed generic created from that
is or implements. null if the two s have no such
relationship.
This method will return if is
typeof(KeyValuePair{,}), and is
typeof(KeyValuePair{string, object}).
Initializes a fast .
This constructor does not cache the helper. For caching, use .
Gets the backing .
Gets (or sets in derived types) the property name.
Gets the property value getter.
Gets the property value setter.
Returns the property value for the specified .
The object whose property value will be returned.
The property value.
Sets the property value for the specified .
The object whose property value will be set.
The property value.
Creates and caches fast property helpers that expose getters for every public get property on the
underlying type.
the instance to extract property accessors for.
a cached array of all public property getters from the underlying type of target instance.
Creates and caches fast property helpers that expose getters for every public get property on the
specified type.
the type to extract property accessors for.
a cached array of all public property getters from the type of target instance.
Creates and caches fast property helpers that expose getters for every non-hidden get property
on the specified type.
excludes properties defined on base types that have been
hidden by definitions using the new keyword.
The instance to extract property accessors for.
A cached array of all public property getters from the instance's type.
Creates and caches fast property helpers that expose getters for every non-hidden get property
on the specified type.
excludes properties defined on base types that have been
hidden by definitions using the new keyword.
The type to extract property accessors for.
A cached array of all public property getters from the type.
Creates a single fast property getter. The result is not cached.
propertyInfo to extract the getter for.
a fast getter.
This method is more memory efficient than a dynamically compiled lambda, and about the
same speed.
Creates a single fast property getter which is safe for a null input object. The result is not cached.
propertyInfo to extract the getter for.
a fast getter.
This method is more memory efficient than a dynamically compiled lambda, and about the
same speed.
Creates a single fast property setter for reference types. The result is not cached.
propertyInfo to extract the setter for.
a fast getter.
This method is more memory efficient than a dynamically compiled lambda, and about the
same speed. This only works for reference types.
Given an object, adds each instance property with a public get method as a key and its
associated value to a dictionary.
If the object is already an instance, then a copy
is returned.
The implementation of PropertyHelper will cache the property accessors per-type. This is
faster when the the same type is used multiple times with ObjectToDictionary.
Context object for execution of action which has been selected as part of an HTTP request.
Creates an empty .
The default constructor is provided for unit test purposes only.
Creates a new .
The to copy.
Creates a new .
The for the current request.
The for the current request.
The for the selected action.
Creates a new .
The for the current request.
The for the current request.
The for the selected action.
The .
Gets or sets the for the selected action.
The property setter is provided for unit test purposes only.
Gets or sets the for the current request.
The property setter is provided for unit test purposes only.
Gets the .
Gets or sets the for the current request.
The property setter is provided for unit test purposes only.
Defines a contract that represents the result of an action method.
Executes the result operation of the action method asynchronously. This method is called by MVC to process
the result of an action method.
The context in which the result is executed. The context information includes
information about the action that was executed and request information.
A task that represents the asynchronous execute operation.
Defines the contract for the helper to build URLs for ASP.NET MVC within an application.
Gets the for the current request.
Generates a fully qualified or absolute URL specified by for an action
method, which contains action name, controller name, route values, protocol to use, host name, and fragment.
The context object for the generated URLs for an action method.
The fully qualified or absolute URL to an action method.
Converts a virtual (relative) path to an application absolute path.
If the specified content path does not start with the tilde (~) character,
this method returns unchanged.
The virtual path of the content.
The application absolute path.
Returns a value that indicates whether the URL is local. A URL with an absolute path is considered local
if it does not have a host/authority part. URLs using virtual paths ('~/') are also local.
The URL.
true if the URL is local; otherwise, false.
For example, the following URLs are considered local:
/Views/Default/Index.html
~/Index.html
The following URLs are non-local:
../Index.html
http://www.contoso.com/
http://localhost/Index.html
Generates a fully qualified or absolute URL specified by , which
contains the route name, the route values, protocol to use, host name and fragment.
The context object for the generated URLs for a route.
The fully qualified or absolute URL.
Generates an absolute URL using the specified route name and values.
The name of the route that is used to generate the URL.
An object that contains the route values.
The generated absolute URL.
The protocol and host is obtained from the current request.
Gets an id which uniquely identifies the action.
Gets or sets the collection of route values that must be provided by routing
for the action to be selected.
The set of constraints for this action. Must all be satisfied for the action to be selected.
The set of properties which are model bound.
A friendly name for this action.
Stores arbitrary metadata properties associated with the .
Extension methods for .
Gets the value of a property from the collection
using the provided value of as the key.
The type of the property.
The action descriptor.
The property or the default value of .
Sets the value of an property in the collection using
the provided value of as the key.
The type of the property.
The action descriptor.
The value of the property.
Gets the order value for determining the order of execution of providers. Providers execute in
ascending numeric value of the property.
Providers are executed in an ordering determined by an ascending sort of the property.
A provider with a lower numeric value of will have its
called before that of a provider with a higher numeric value of
. The method is called in the reverse ordering after
all calls to . A provider with a lower numeric value of
will have its method called after that of a provider
with a higher numeric value of .
If two providers have the same numeric value of , then their relative execution order
is undefined.
Gets the order value for determining the order of execution of providers. Providers execute in
ascending numeric value of the property.
Providers are executed in an ordering determined by an ascending sort of the property.
A provider with a lower numeric value of will have its
called before that of a provider with a higher numeric value of
. The method is called in the reverse ordering after
all calls to . A provider with a lower numeric value of
will have its method called after that of a provider
with a higher numeric value of .
If two providers have the same numeric value of , then their relative execution order
is undefined.
Value cannot be null or empty.
Value cannot be null or empty.
The ModelMetadata property must be set before accessing this property.
The ModelMetadata property must be set before accessing this property.
A field previously marked invalid should not be marked valid.
A field previously marked invalid should not be marked valid.
A field previously marked invalid should not be marked skipped.
A field previously marked invalid should not be marked skipped.
The maximum number of allowed model errors has been reached.
The maximum number of allowed model errors has been reached.
Body
Body
Custom
Custom
Form
Form
Header
Header
Services
Services
ModelBinding
ModelBinding
Path
Path
Query
Query
The provided binding source '{0}' is a composite. '{1}' requires that the source must represent a single type of input.
The provided binding source '{0}' is a composite. '{1}' requires that the source must represent a single type of input.
The provided binding source '{0}' is not a request-based binding source. '{1}' requires that the source must represent data from an HTTP request.
The provided binding source '{0}' is not a request-based binding source. '{1}' requires that the source must represent data from an HTTP request.
The provided binding source '{0}' is a greedy data source. '{1}' does not support greedy data sources.
The provided binding source '{0}' is a greedy data source. '{1}' does not support greedy data sources.
The provided binding source '{0}' is not a greedy data source. '{1}' only supports greedy data sources.
The provided binding source '{0}' is not a greedy data source. '{1}' only supports greedy data sources.
Context for execution.
The list of . This includes all actions that are valid for the current
request, as well as their constraints.
The current .
The .
Represents an with or without a corresponding
.
Creates a new .
The instance.
The associated with .
The instance.
Gets or sets a value indicating whether or not can be reused across requests.
Context for an action constraint provider.
Creates a new .
The associated with the request.
The for which constraints are being created.
The list of objects.
The associated with the request.
The for which constraints are being created.
The list of objects.
A candidate action for action selection.
Creates a new .
The representing a candidate for selection.
The list of instances associated with .
The representing a candiate for selection.
The list of instances associated with .
Supports conditional logic to determine whether or not an associated action is valid to be selected
for the given request.
Action constraints have the secondary effect of making an action with a constraint applied a better
match than one without.
Consider two actions, 'A' and 'B' with the same action and controller name. Action 'A' only allows the
HTTP POST method (via a constraint) and action 'B' has no constraints.
If an incoming request is a POST, then 'A' is considered the best match because it both matches and
has a constraint. If an incoming request uses any other verb, 'A' will not be valid for selection
due to it's constraint, so 'B' is the best match.
Action constraints are also grouped according to their order value. Any constraints with the same
group value are considered to be part of the same application policy, and will be executed in the
same stage.
Stages run in ascending order based on the value of . Given a set of actions which
are candidates for selection, the next stage to run is the lowest value of for any
constraint of any candidate which is greater than the order of the last stage.
Once the stage order is identified, each action has all of its constraints in that stage executed.
If any constraint does not match, then that action is not a candidate for selection. If any actions
with constraints in the current state are still candidates, then those are the 'best' actions and this
process will repeat with the next stage on the set of 'best' actions. If after processing the
subsequent stages of the 'best' actions no candidates remain, this process will repeat on the set of
'other' candidate actions from this stage (those without a constraint).
The constraint order.
Constraints are grouped into stages by the value of . See remarks on
.
Determines whether an action is a valid candidate for selection.
The .
True if the action is valid for selection, otherwise false.
A factory for .
will be invoked during action selection
to create constraint instances for an action.
Place an attribute implementing this interface on a controller or action to insert an action
constraint created by a factory.
Gets a value that indicates if the result of
can be reused across requests.
Creates a new .
The per-request services.
An .
A marker interface that identifies a type as metadata for an .
Gets the order value for determining the order of execution of providers. Providers execute in
ascending numeric value of the property.
Providers are executed in an ordering determined by an ascending sort of the property.
A provider with a lower numeric value of will have its
called before that of a provider with a higher numeric value of
. The method is called in the reverse ordering after
all calls to . A provider with a lower numeric value of
will have its method called after that of a provider
with a higher numeric value of .
If two providers have the same numeric value of , then their relative execution order
is undefined.
A filter that allows anonymous requests, disabling some s.
A context for action filters, specifically calls.
Instantiates a new instance.
The .
All applicable implementations.
The controller instance containing the action.
Gets or sets an indication that an action filter short-circuited the action and the action filter pipeline.
Gets the controller instance containing the action.
Gets or sets the caught while executing the action or action filters, if
any.
Gets or sets the for the
, if an was caught and this information captured.
Gets or sets an indication that the has been handled.
Gets or sets the .
A context for action filters, specifically and
calls.
Instantiates a new instance.
The .
All applicable implementations.
The arguments to pass when invoking the action. Keys are parameter names.
The controller instance containing the action.
Gets or sets the to execute. Setting to a non-null
value inside an action filter will short-circuit the action and any remaining action filters.
Gets the arguments to pass when invoking the action. Keys are parameter names.
Gets the controller instance containing the action.
A delegate that asynchronously returns an indicating the action or the next
action filter has executed.
A that on completion returns an .
A context for authorization filters i.e. and
implementations.
Instantiates a new instance.
The .
All applicable implementations.
Gets or sets the result of the request. Setting to a non-null value inside
an authorization filter will short-circuit the remainder of the filter pipeline.
A context for exception filters i.e. and
implementations.
Instantiates a new instance.
The .
All applicable implementations.
Gets or sets the caught while executing the action.
Gets or sets the for the
, if this information was captured.
Gets or sets an indication that the has been handled.
Gets or sets the .
An abstract context for filters.
Instantiates a new instance.
The .
All applicable implementations.
Gets all applicable implementations.
Descriptor for an .
describes an with an order and scope.
Order and scope control the execution order of filters. Filters with a higher value of Order execute
later in the pipeline.
When filters have the same Order, the Scope value is used to determine the order of execution. Filters
with a higher value of Scope execute later in the pipeline. See Microsoft.AspNetCore.Mvc.FilterScope
for commonly used scopes.
For implementions, the filter runs only after an exception has occurred,
and so the observed order of execution will be opposite that of other filters.
Creates a new .
The .
The filter scope.
If the implements , then the value of
will be taken from . Otherwise the value
of will default to 0.
The instance.
The filter order.
The filter scope.
Used to associate executable filters with instances
as part of . An should
inspect and set and
as appropriate.
Creates a new .
The .
Creates a new .
The .
Gets the containing the filter metadata.
Gets or sets the executable associated with .
Gets or sets a value indicating whether or not can be reused across requests.
A context for filter providers i.e. implementations.
Instantiates a new instance.
The .
The s, initially created from s or a cache entry.
Gets or sets the .
Gets or sets the s, initially created from s or a
cache entry. s should set on existing items or
add new s to make executable filters available.
A filter that surrounds execution of the action.
Called before the action executes, after model binding is complete.
The .
Called after the action executes, before the action result.
The .
A filter that asynchronously surrounds execution of the action, after model binding is complete.
Called asynchronously before the action, after model binding is complete.
The .
The . Invoked to execute the next action filter or the action itself.
A that on completion indicates the filter has executed.
A filter that asynchronously confirms request authorization.
Called early in the filter pipeline to confirm request is authorized.
The .
A that on completion indicates the filter has executed.
A filter that runs asynchronously after an action has thrown an .
Called after an action has thrown an .
The .
A that on completion indicates the filter has executed.
A filter that asynchronously surrounds execution of model binding, the action (and filters) and the action
result (and filters).
Called asynchronously before the rest of the pipeline.
The .
The . Invoked to execute the next resource filter or the remainder
of the pipeline.
A which will complete when the remainder of the pipeline completes.
A filter that asynchronously surrounds execution of the action result.
Called asynchronously before the action result.
The .
The . Invoked to execute the next result filter or the result itself.
A that on completion indicates the filter has executed.
A filter that confirms request authorization.
Called early in the filter pipeline to confirm request is authorized.
The .
A filter that runs after an action has thrown an .
Called after an action has thrown an .
The .
A filter that requires a reference back to the that created it.
The that created this filter instance.
An interface for filter metadata which can create an instance of an executable filter.
Gets a value that indicates if the result of
can be reused across requests.
Creates an instance of the executable filter.
The request .
An instance of the executable filter.
Marker interface for filters handled in the MVC request pipeline.
A provider. Implementations should update
to make executable filters available.
Gets the order value for determining the order of execution of providers. Providers execute in
ascending numeric value of the property.
Providers are executed in an ordering determined by an ascending sort of the property.
A provider with a lower numeric value of will have its
called before that of a provider with a higher numeric value of
. The method is called in the reverse ordering after
all calls to . A provider with a lower numeric value of
will have its method called after that of a provider
with a higher numeric value of .
If two providers have the same numeric value of , then their relative execution order
is undefined.
Called in increasing .
The .
Called in decreasing , after all s have executed once.
The .
A filter that specifies the relative order it should run.
Gets the order value for determining the order of execution of filters. Filters execute in
ascending numeric value of the property.
Filters are executed in an ordering determined by an ascending sort of the property.
Asynchronous filters, such as , surround the execution of subsequent
filters of the same filter kind. An asynchronous filter with a lower numeric
value will have its filter method, such as ,
executed before that of a filter with a higher value of .
Synchronous filters, such as , have a before-method, such as
, and an after-method, such as
. A synchronous filter with a lower numeric
value will have its before-method executed before that of a filter with a higher value of
. During the after-stage of the filter, a synchronous filter with a lower
numeric value will have its after-method executed after that of a filter with a higher
value of .
If two filters have the same numeric value of , then their relative execution order
is determined by the filter scope.
A filter that surrounds execution of model binding, the action (and filters) and the action result
(and filters).
Executes the resource filter. Called before execution of the remainder of the pipeline.
The .
Executes the resource filter. Called after execution of the remainder of the pipeline.
The .
A filter that surrounds execution of the action result.
Called before the action result executes.
The .
Called after the action result executes.
The .
A context for resource filters, specifically calls.
Creates a new .
The .
The list of instances.
Gets or sets a value which indicates whether or not execution was canceled by a resource filter.
If true, then a resource filter short-circuted execution by setting
.
Gets or set the current .
Setting or to null will treat
the exception as handled, and it will not be rethrown by the runtime.
Setting to true will also mark the exception as handled.
Gets or set the current .
Setting or to null will treat
the exception as handled, and it will not be rethrown by the runtime.
Setting to true will also mark the exception as handled.
Gets or sets a value indicating whether or not the current has been handled.
If false the will be rethrown by the runtime after resource filters
have executed.
Gets or sets the result.
The may be provided by execution of the action itself or by another
filter.
The has already been written to the response before being made available
to resource filters.
A context for resource filters, specifically and
calls.
Creates a new .
The .
The list of instances.
The list of instances.
Gets or sets the result of the action to be executed.
Setting to a non-null value inside a resource filter will
short-circuit execution of additional resource filters and the action itself.
Gets the list of instances used by model binding.
A delegate that asynchronously returns a indicating model binding, the
action, the action's result, result filters, and exception filters have executed.
A that on completion returns a .
A context for result filters, specifically calls.
Instantiates a new instance.
The .
All applicable implementations.
The copied from .
The controller instance containing the action.
Gets or sets an indication that a result filter set to
true and short-circuited the filter pipeline.
Gets the controller instance containing the action.
Gets or sets the caught while executing the result or result filters, if
any.
Gets or sets the for the
, if an was caught and this information captured.
Gets or sets an indication that the has been handled.
Gets the copied from .
A context for result filters, specifically and
calls.
Instantiates a new instance.
The .
All applicable implementations.
The of the action and action filters.
The controller instance containing the action.
Gets the controller instance containing the action.
Gets or sets the to execute. Setting to a non-null
value inside a result filter will short-circuit the result and any remaining result filters.
Gets or sets an indication the result filter pipeline should be short-circuited.
A delegate that asynchronously returns an indicating the action result or
the next result filter has executed.
A that on completion returns an .
Represents a collection of formatters.
The type of formatters in the collection.
Initializes a new instance of the class that is empty.
Initializes a new instance of the class
as a wrapper for the specified list.
The list that is wrapped by the new collection.
Removes all formatters of the specified type.
The type to remove.
Reads an object from the request body.
Determines whether this can deserialize an object of the
's .
The .
true if this can deserialize an object of the
's . false otherwise.
Reads an object from the request body.
The .
A that on completion deserializes the request body.
A context object used by an input formatter for deserializing the request body into an object.
Creates a new instance of .
The for the current operation.
The name of the model.
The for recording errors.
The of the model to deserialize.
A delegate which can create a for the request body.
Gets the associated with the current operation.
Gets the name of the model. Used as the key or key prefix for errors added to .
Gets the associated with the current operation.
Gets the requested of the request body deserialization.
Gets the requested of the request body deserialization.
Gets a delegate which can create a for the request body.
Result of a operation.
Gets an indication whether the operation had an error.
Gets the deserialized .
null if is true.
Returns an indicating the
operation failed.
An indicating the
operation failed i.e. with true.
Returns a that on completion provides an indicating
the operation failed.
A that on completion provides an indicating the
operation failed i.e. with true.
Returns an indicating the
operation was successful.
The deserialized .
An indicating the
operation succeeded i.e. with false.
Returns a that on completion provides an indicating
the operation was successful.
The deserialized .
A that on completion provides an indicating the
operation succeeded i.e. with false.
Writes an object to the output stream.
Determines whether this can serialize
an object of the specified type.
The formatter context associated with the call.
Returns true if the formatter can write the response; false otherwise.
Writes the object represented by 's Object property.
The formatter context associated with the call.
A Task that serializes the value to the 's response message.
A context object for .
Gets or sets the content type to write to the response.
An can set this value when its
method is called,
and expect to see the same value provided in
Gets or sets the object to write to the response.
Gets or sets the of the object to write to the response.
A context object for .
Creates a new .
The for the current request.
The delegate used to create a for writing the response.
The of the object to write to the response.
The object to write to the response.
Gets or sets the context associated with the current operation.
Gets or sets a delegate used to create a for writing the response.
Binding info which represents metadata associated to an action parameter.
Creates a new .
Creates a copy of a .
The to copy.
Gets or sets the .
Gets or sets the binder model name.
Gets or sets the of the model binder used to bind the model.
Gets or sets the .
Constructs a new instance of from the given .
A collection of attributes which are used to construct
A new instance of .
A metadata object representing a source of data for model binding.
A for the request body.
A for a custom model binder (unknown data source).
A for the request form-data.
A for the request headers.
A for model binding. Includes form-data, query-string
and route data from the request.
A for the request url path.
A for the request query-string.
A for request services.
Creates a new .
The id, a unique identifier.
The display name.
A value indicating whether or not the source is greedy.
A value indicating whether or not the data comes from the HTTP request.
Gets the display name for the source.
Gets the unique identifier for the source. Sources are compared based on their Id.
Gets a value indicating whether or not a source is greedy. A greedy source will bind a model in
a single operation, and will not decompose the model into sub-properties.
For sources based on a , setting to false
will most closely describe the behavior. This value is used inside the default model binders to
determine whether or not to attempt to bind properties of a model.
Set to true for most custom implementations.
If a source represents an which will recursively traverse a model's properties
and bind them individually using , then set to
true.
Gets a value indicating whether or not the binding source uses input from the current HTTP request.
Some sources (like ) are based on application state and not user
input. These are excluded by default from ApiExplorer diagnostics.
Gets a value indicating whether or not the can accept
data from .
The to consider as input.
True if the source is compatible, otherwise false.
When using this method, it is expected that the left-hand-side is metadata specified
on a property or parameter for model binding, and the right hand side is a source of
data used by a model binder or value provider.
This distinction is important as the left-hand-side may be a composite, but the right
may not.
A which can repesent multiple value-provider data sources.
Creates a new .
The set of entries.
Must be value-provider sources and user input.
The display name for the composite source.
A .
Gets the set of entries.
An abstraction used when grouping enum values for .
Initializes a new instance of the EnumGroupAndName structure.
The group name.
The name.
Gets the Group name.
Gets the name.
Provides a which implements .
A which implements either .
Metadata which specificies the data source for model binding.
Gets the .
The is metadata which can be used to determine which data
sources are valid for model binding of a property or parameter.
Defines an interface for model binders.
Attempts to bind a model.
The .
A which will complete when the model binding process completes.
If model binding was successful, the should have
set to true.
A model binder that completes successfully should set to
a value returned from .
Creates instances. Register
instances in MvcOptions.
Creates a based on .
The .
An .
Represents an entity which can provide model name as metadata.
Model name.
Provides a predicate which can determines which model properties should be bound by model binding.
Gets a predicate which can determines which model properties should be bound by model binding.
Defines the methods that are required for a value provider.
Determines whether the collection contains the specified prefix.
The prefix to search for.
true if the collection contains the specified prefix; otherwise, false.
Retrieves a value object using the specified key.
The key of the value object to retrieve.
The value object for the specified key. If the exact key is not found, null.
A factory for creating instances.
Creates a with values from the current request
and adds it to list.
The .
A that when completed will add an instance
to list if applicable.
A context object for .
Creates an for the given .
The for the model.
An .
Gets the .
Gets the .
Gets the .
A context that contains operating information for model binding and validation.
Represents the associated with this context.
The property setter is provided for unit testing purposes only.
Gets or sets a model name which is explicitly set using an .
Gets or sets a value which represents the associated with the
.
Gets or sets the name of the current field being bound.
Gets the associated with this context.
Gets or sets an indication that the current binder is handling the top-level object.
Passed into the model binding system.
Gets or sets the model value for the current operation.
The will typically be set for a binding operation that works
against a pre-existing model object to update certain properties.
Gets or sets the metadata for the model associated with this context.
Gets or sets the name of the model. This property is used as a key for looking up values in
during model binding.
Gets or sets the used to capture values
for properties in the object graph of the model when binding.
The property setter is provided for unit testing purposes only.
Gets the type of the model.
The property must be set to access this property.
Gets or sets a predicate which will be evaluated for each property to determine if the property
is eligible for model binding.
Gets or sets the . Used for tracking validation state to
customize validation behavior for a model object.
The property setter is provided for unit testing purposes only.
Gets or sets the associated with this context.
Gets or sets a which represents the result of the model binding process.
Before an is called, will be set to a value indicating
failure. The binder should set to a value created with
if model binding succeeded.
Pushes a layer of state onto this context. Model binders will call this as part of recursion when binding properties
or collection items.
to assign to the property.
Name to assign to the property.
Name to assign to the property.
Instance to assign to the property.
A scope object which should be used in a using statement where PushContext is called.
Pushes a layer of state onto this context. Model binders will call this as part of recursion when binding properties
or collection items.
A scope object which should be used in a using statement where PushContext is called.
Removes a layer of state pushed by calling .
Return value of . Should be disposed
by caller when child binding context state should be popped off of
the .
Initializes the for a .
Exits the created by calling .
Contains the result of model binding.
Creates a representing a failed model binding operation.
A representing a failed model binding operation.
Creates a representing a successful model binding operation.
The model value. May be null.
A representing a successful model bind.
Gets the model associated with this context.
Gets a value indicating whether or not the value has been set.
This property can be used to distinguish between a model binder which does not find a value and
the case where a model binder sets the null value.
Compares objects for equality.
A .
A .
true if the objects are equal, otherwise false.
Compares objects for inequality.
A .
A .
true if the objects are not equal, otherwise false.
A metadata representation of a model type, property or parameter.
The default value of .
Creates a new .
The .
Gets the container type of this metadata if it represents a property, otherwise null.
Gets a value indicating the kind of metadata element represented by the current instance.
Gets the model type represented by the current instance.
Gets the property name represented by the current instance.
Gets the key for the current instance.
Gets a collection of additional information about the model.
Gets the collection of instances for the model's properties.
Gets the name of a model if specified explicitly using .
Gets the of an of a model if specified explicitly using
.
Gets a binder metadata for this model.
Gets a value indicating whether or not to convert an empty string value to null when
representing a model as text.
Gets the name of the model's datatype. Overrides in some
display scenarios.
null unless set manually or through additional metadata e.g. attributes.
Gets the description of the model.
Gets the composite format (see
http://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to display the model.
Gets the display name of the model.
Gets the composite format (see
http://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to edit the model.
Gets the for elements of if that
implements .
for T if implements
. for object if
implements but not . null otherwise i.e. when
is false.
Gets the ordered and grouped display names and values of all values in
.
An of of mappings between
field groups, names and values. null if is false.
Gets the names and values of all values in .
An of mappings between field names
and values. null if is false.
Gets a value indicating whether has a non-null, non-empty
value different from the default for the datatype.
Gets a value indicating whether the value should be HTML-encoded.
If true, value should be HTML-encoded. Default is true.
Gets a value indicating whether the "HiddenInput" display template should return
string.Empty (not the expression value) and whether the "HiddenInput" editor template should not
also return the expression value (together with the hidden <input> element).
If true, also causes the default display and editor templates to return HTML
lacking the usual per-property <div> wrapper around the associated property. Thus the default
display template effectively skips the property and the default
editor template returns only the hidden <input> element for the property.
Gets a value indicating whether or not the model value can be bound by model binding. This is only
applicable when the current instance represents a property.
If true then the model value is considered supported by model binding and can be set
based on provided input in the request.
Gets a value indicating whether or not the model value is required by model binding. This is only
applicable when the current instance represents a property.
If true then the model value is considered required by model binding and must have a value
supplied in the request to be considered valid.
Gets a value indicating whether is for an .
true if type.IsEnum (type.GetTypeInfo().IsEnum for DNX Core 5.0) is true for
; false otherwise.
Gets a value indicating whether is for an with an
associated .
true if is true and has an
associated ; false otherwise.
Gets a value indicating whether or not the model value is read-only. This is only applicable when
the current instance represents a property.
Gets a value indicating whether or not the model value is required. This is only applicable when
the current instance represents a property.
If true then the model value is considered required by validators.
By default an implicit System.ComponentModel.DataAnnotations.RequiredAttribute will be added
if not present when true..
Gets the instance.
Gets a value indicating where the current metadata should be ordered relative to other properties
in its containing type.
For example this property is used to order items in .
The default order is 10000.
The order value of the current metadata.
Gets the text to display as a placeholder value for an editor.
Gets the text to display when the model is null.
Gets the , which can determine which properties
should be model bound.
Gets a value that indicates whether the property should be displayed in read-only views.
Gets a value that indicates whether the property should be displayed in editable views.
Gets a value which is the name of the property used to display the model.
Gets a string used by the templating system to discover display-templates and editor-templates.
Gets a value that indicates whether properties or elements of the model should be validated.
Gets a collection of metadata items for validators.
Gets the for elements of if that
implements .
Gets a value indicating whether is a simple type.
A simple type is defined as a which has a
that can convert from .
Gets a value indicating whether or not is a .
Gets a value indicating whether or not is a collection type.
A collection type is defined as a which is assignable to .
Gets a value indicating whether or not is an enumerable type.
An enumerable type is defined as a which is assignable to
, and is not a .
Gets a value indicating whether or not allows null values.
Gets the underlying type argument if inherits from .
Otherwise gets .
Identical to unless is true.
Gets a property getter delegate to get the property value from a model object.
Gets a property setter delegate to set the property value on a model object.
Gets a display name for the model.
will return the first of the following expressions which has a
non-null value: DisplayName, PropertyName, ModelType.Name.
The display name.
A read-only collection of objects which represent model properties.
Creates a new .
The properties.
Gets a instance for the property corresponding to .
The property name. Property names are compared using .
The instance for the property specified by , or
null if no match can be found.
Represents the state of an attempt to bind values from an HTTP Request to an action method, which includes
validation information.
The default value for of 200.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class by using values that are copied
from the specified .
The to copy values from.
Root entry for the .
Gets or sets the maximum allowed model state errors in this instance of .
Defaults to 200.
tracks the number of model errors added by calls to
or
.
Once the value of MaxAllowedErrors - 1
is reached, if another attempt is made to add an error,
the error message will be ignored and a will be added.
Errors added via modifying directly do not count towards this limit.
Gets a value indicating whether or not the maximum number of errors have been
recorded.
Returns true if a has been recorded;
otherwise false.
Gets the number of errors added to this instance of via
or .
Gets the key sequence.
Gets the value sequence.
Gets a value that indicates whether any model state values in this model state dictionary is invalid or not validated.
Adds the specified to the instance
that is associated with the specified .
The key of the to add errors to.
The to add.
The associated with the model.
Attempts to add the specified to the
instance that is associated with the specified . If the maximum number of allowed
errors has already been recorded, records a exception instead.
The key of the to add errors to.
The to add.
The associated with the model.
True if the given error was added, false if the error was ignored.
See .
Adds the specified to the instance
that is associated with the specified .
The key of the to add errors to.
The error message to add.
Attempts to add the specified to the
instance that is associated with the specified . If the maximum number of allowed
errors has already been recorded, records a exception instead.
The key of the to add errors to.
The error message to add.
True if the given error was added, false if the error was ignored.
See .
Returns the aggregate for items starting with the
specified .
The key to look up model state errors for.
Returns if no entries are found for the specified
key, if at least one instance is found with one or more model
state errors; otherwise.
Returns for the .
The key to look up model state errors for.
Returns if no entry is found for the specified
key, if an instance is found with one or more model
state errors; otherwise.
Marks the for the entry with the specified
as .
The key of the to mark as valid.
Marks the for the entry with the specified
as .
The key of the to mark as skipped.
Copies the values from the specified into this instance, overwriting
existing values if keys are the same.
The to copy values from.
Sets the of and for
the with the specified .
The key for the entry.
The raw value for the entry.
The values of in a comma-separated .
Sets the value for the with the specified .
The key for the entry
A with data for the entry.
Clears entries that match the key that is passed as parameter.
The key of to clear.
Removes all keys and values from ths instance of .
Removes the with the specified .
The key.
true if the element is successfully removed; otherwise false. This method also
returns false if key was not found.
Returns an enumerator that iterates through this instance of .
An .
An entry in a .
Gets the raw value from the request associated with this entry.
Gets the set of values contained in , joined into a comma-separated string.
Gets the for this entry.
Gets or sets the for this entry.
Gets a value that determines if the current instance of is a container node.
Container nodes represent prefix nodes that aren't explicitly added to the
.
Gets the for a sub-property with the specified .
The property name to lookup.
The if a sub-property was found; otherwise null.
This method returns any existing entry, even those with with value true..
Gets the values for sub-properties.
This method returns all existing entries, even those with with value true.
The that is thrown when too many model errors are encountered.
Creates a new instance of with the specified
exception .
The message that describes the error.
A context for .
Creates a new .
The .
Gets the associated with this context.
Gets the list of instances.
instances should add the appropriate
instances to this list.
Result of an operation.
can represent a single submitted value or multiple submitted values.
Use to consume only a single value, regardless of whether a single value or
multiple values were submitted.
Treat as an to consume all values,
regardless of whether a single value or multiple values were submitted.
A that represents a lack of data.
Creates a new using .
The submitted values.
Creates a new .
The submitted values.
The associated with this value.
Gets or sets the associated with the values.
Gets or sets the values.
Gets the first value based on the order values were provided in the request. Use
to get a single value for processing regardless of whether a single or multiple values were provided
in the request.
Gets the number of submitted values.
Gets an for this .
An .
Converts the provided into a comma-separated string containing all
submitted values.
The .
Converts the provided into a an array of containing
all submitted values.
The .
Compares two objects for equality.
A .
A .
true if the values are equal, otherwise false.
Compares two objects for inequality.
A .
A .
false if the values are equal, otherwise true.
Provider for error messages the model binding system detects.
Error message the model binding system adds when a property with an associated
BindRequiredAttribute is not bound.
Default is "A value for the '{0}' property was not provided.".
Error message the model binding system adds when either the key or the value of a
is bound but not both.
Default is "A value is required.".
Error message the model binding system adds when a null value is bound to a
non- property.
Default is "The value '{0}' is invalid.".
Error message the model binding system adds when is of type
or and value is known.
Default is "The value '{0}' is not valid for {1}.".
Error message the model binding system adds when is of type
or and value is unknown.
Default is "The supplied value is invalid for {0}.".
Fallback error message HTML and tag helpers display when a property is invalid but the
s have null s.
Default is "The value '{0}' is invalid.".
Error message HTML and tag helpers add for client-side validation of numeric formats. Visible in the
browser if the field for a float property (for example) does not have a correctly-formatted value.
Default is "The field {0} must be a number.".
A key type which identifies a .
Creates a for the provided model .
The model .
A .
Creates a for the provided property.
The model type.
The name of the property.
The container type of the model property.
A .
Gets the defining the model property respresented by the current
instance, or null if the current instance does not represent a property.
Gets the represented by the current instance.
Gets a value indicating the kind of metadata represented by the current instance.
Gets the name of the current instance if it represents a parameter or property, or null if
the current instance represents a type.
Enumeration for the kinds of
Used for for a .
Used for for a property.
The context for client-side model validation.
Create a new instance of .
The for validation.
The for validation.
The to be used in validation.
The attributes dictionary for the HTML tag being rendered.
Gets the attributes dictionary for the HTML tag being rendered.
Used to associate validators with instances
as part of . An should
inspect and set and
as appropriate.
Creates a new .
Creates a new .
The .
Gets the metadata associated with the .
Gets or sets the .
Gets or sets a value indicating whether or not can be reused across requests.
A context for .
Creates a new .
The for the model being validated.
The list of s.
Gets the .
Gets the validator metadata.
This property provides convenience access to .
Gets the list of instances.
instances should add the appropriate properties when
is called.
Provides a collection of s.
Creates set of s by updating
in .
The associated with this call.
Validates a model value.
Validates the model value.
The .
A list of indicating the results of validating the model value.
Provides validators for a model value.
Creates the validators for .
The .
Implementations should add the instances to the appropriate
instance which should be added to
.
Defines a strategy for enumerating the child entries of a model object which should be validated.
Gets an containing a for
each child entry of the model object to be validated.
The associated with .
The model prefix associated with .
The model object.
An .
A context object for .
Create a new instance of .
The for validation.
The for validation.
The to be used in validation.
The model container.
The model to be validated.
Gets the model object.
Gets the model container object.
A common base class for and .
Instantiates a new .
The for this context.
The for this model.
The to be used by this context.
Gets the .
Gets the .
Gets the .
A context for .
Creates a new .
The .
The list of s.
Gets the .
Gets the validator metadata.
This property provides convenience access to .
Gets the list of instances. instances
should add the appropriate properties when
is called.
Contains data needed for validating a child entry of a model object. See .
Creates a new .
The associated with .
The model prefix associated with .
The model object.
The model prefix associated with .
The associated with .
The model object.
Used for tracking validation state to customize validation behavior for a model object.
Creates a new .
An entry in a . Records state information to override the default
behavior of validation for an object.
Gets or sets the model prefix associated with the entry.
Gets or sets the associated with the entry.
Gets or sets a value indicating whether the associated model object should be validated.
Gets or sets an for enumerating child entries of the associated
model object.
Used to associate validators with instances
as part of . An should
inspect and set and
as appropriate.
Creates a new .
Creates a new .
The .
Gets the metadata associated with the .
Gets or sets the .
Gets or sets a value indicating whether or not can be reused across requests.
Represents the routing information for an action that is attribute routed.
The route template. May be null if the action has no attribute routes.
Gets the order of the route associated with a given action. This property determines
the order in which routes get executed. Routes with a lower order value are tried first. In case a route
doesn't specify a value, it gets a default order of 0.
Gets the name of the route associated with a given action. This property can be used
to generate a link by referring to the route by name instead of attempting to match a
route by provided route data.
Context object to be used for the URLs that generates.
The name of the action method that uses to generate URLs.
The name of the controller that uses to generate URLs.
The object that contains the route parameters that
uses to generate URLs.
The protocol for the URLs that generates
such as "http" or "https"
The host name for the URLs that generates.
The fragment for the URLs that generates.
Context object to be used for the URLs that generates.
The name of the route that uses to generate URLs.
The object that contains the route values for the generated URLs.
The protocol for the URLs that generates
such as "http" or "https"
The host name for the URLs that generates.
The fragment for the URLs that generates.