Microsoft.AspNetCore.Mvc 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
提供生成 MVC 应用所需的类型。
类
AcceptedAtActionResult |
返回 ActionResult “位置”标头的“已接受” (202) 响应。 |
AcceptedAtRouteResult |
返回 ActionResult “位置”标头的“已接受” (202) 响应。 |
AcceptedResult |
返回 ActionResult 具有 Location 标头的“已接受” (202) 响应。 |
AcceptVerbsAttribute |
指定操作支持的 HTTP 方法。 |
ActionContext |
用于执行已选择为 HTTP 请求一部分的操作的上下文对象。 |
ActionContextAttribute |
指定在创建控制器时应使用当前 ActionContext 设置控制器属性。 该属性必须具有公共集方法。 |
ActionNameAttribute |
指定操作的名称。 |
ActionResult |
的默认实现 。IActionResult |
ActionResult<TValue> |
|
AntiforgeryValidationFailedResult |
BadRequestResult用于防伪验证失败。 用于 IAntiforgeryValidationFailedResult 匹配 MVC 结果筛选器内的验证失败。 |
ApiBehaviorOptions |
用于为批注的类型 ApiControllerAttribute配置行为的选项。 |
ApiControllerAttribute |
指示类型以及所有派生类型都用于提供 HTTP API 响应。 使用此属性修饰的控制器配置了旨在改进生成 API 的开发人员体验的功能和行为。 在程序集上修饰时,程序集中的所有控制器都将被视为具有 API 行为的控制器。 有关详细信息,请参阅 ApiController 属性。 |
ApiConventionMethodAttribute |
要应用于控制器操作的 API 约定。 API 约定用于影响 ApiExplorer 的输出。 ApiConventionMethodAttribute 可用于指定适用于操作的确切约定方法。 ApiConventionTypeAttribute 有关在程序集或控制器级别应用约定的详细信息。 |
ApiConventionTypeAttribute |
要应用于包含 MVC 控制器或单个控制器的程序集的 API 约定。 API 约定用于影响 ApiExplorer 的输出。 约定必须是静态类型。 约定中的方法与操作方法匹配,方法是使用可应用于方法名称或其参数ApiConventionTypeMatchAttribute以及应用于参数的规则指定的ApiConventionNameMatchAttribute操作方法。 如果未找到指定行为的属性,则 MVC 会匹配使用 Exact 的方法名称和参数名称,并使用参数类型进行匹配 AssignableFrom。 |
ApiDescriptionActionData |
表示用于生成存储在其中的Properties一 |
ApiExplorerSettingsAttribute |
控制关联控制器类或操作方法的可见性和组名称 |
AreaAttribute |
指定包含控制器或操作的区域。 |
AutoValidateAntiforgeryTokenAttribute |
一个属性,用于验证所有不安全 HTTP 方法的防伪令牌。 除 GET、HEAD、OPTIONS 和 TRACE 以外的 HTTP 方法需要防伪令牌。 |
BadRequestObjectResult |
ObjectResult执行时将生成错误请求 (400) 响应。 |
BadRequestResult |
StatusCodeResult执行时将生成错误请求 (400) 响应。 |
BindAttribute |
此属性可用于操作参数和类型,以指示模型级别元数据。 |
BindPropertiesAttribute |
为修饰控制器或 Razor 页面模型定义的所有属性启用绑定的属性。 |
BindPropertyAttribute |
可以指定用于绑定关联属性的模型名称或类型的 IModelBinder 属性。 |
CacheProfile |
定义一组可用于响应缓存的设置。 |
ChallengeResult |
执行时调用HttpContext.ChallengeAsync的 。ActionResult |
ClientErrorData |
生成客户端错误的信息。 此类型用于配置使用者 ClientErrorMapping生成的客户端错误。 |
ConflictObjectResult |
ObjectResult执行时将生成冲突 (409) 响应。 |
ConflictResult |
StatusCodeResult执行时将生成冲突 (409) 响应。 |
ConsumesAttribute |
一个筛选器,指定受支持的请求内容类型。 ContentTypes 用于选择一个操作,否则将有多个匹配项。 |
ContentResult |
ActionResult执行时会生成包含内容的响应。 |
Controller |
具有视图支持的 MVC 控制器的基类。 |
ControllerAttribute |
指示此属性应用于的类型和任何派生类型都被视为默认控制器发现机制的控制器,除非 NonControllerAttribute 应用于层次结构中的任何类型。 |
ControllerBase |
没有视图支持的 MVC 控制器的基类。 |
ControllerContext |
与控制器的当前请求关联的上下文。 |
ControllerContextAttribute |
指定在创建控制器时应使用当前 ControllerContext 设置控制器属性。 该属性必须具有公共集方法。 |
CookieTempDataProviderOptions |
为设置的 Cookie 提供编程配置 CookieTempDataProvider |
CreatedAtActionResult |
返回 ActionResult 具有 Location 标头的创建 (201) 响应。 |
CreatedAtRouteResult |
返回 ActionResult 具有 Location 标头的创建 (201) 响应。 |
CreatedResult |
返回 ActionResult 具有 Location 标头的创建 (201) 响应。 |
DefaultApiConventions |
默认 API 约定。 |
DisableRequestSizeLimitAttribute |
禁用请求正文大小限制。 |
EmptyResult |
表示 ActionResult 执行时不会执行任何操作。 |
FileContentResult |
表示 ActionResult 执行时将二进制文件写入响应。 |
FileResult |
表示执行时将写入文件作为响应的一个 ActionResult 值。 |
FileStreamResult |
表示 ActionResult 执行时将文件从流写入响应。 |
ForbidResult |
执行时调用HttpContext.ForbidAsync的 。ActionResult |
FormatFilterAttribute |
将使用路由数据或查询字符串中的格式值设置操作返回的内容类型 ObjectResult 的筛选器。 |
FromBodyAttribute |
指定应使用请求正文绑定参数或属性。 |
FromFormAttribute |
指定在请求正文中使用表单数据绑定参数或属性。 |
FromHeaderAttribute |
指定应使用请求标头绑定参数或属性。 |
FromQueryAttribute |
指定应使用请求查询字符串绑定参数或属性。 |
FromRouteAttribute |
指定应使用当前请求中的路由数据绑定参数或属性。 |
FromServicesAttribute |
指定应使用请求服务绑定参数或属性。 |
HiddenInputAttribute |
指示应使用 <类型为“hidden”的输入> 元素编辑具有关联类型的关联属性或所有属性。 |
HttpDeleteAttribute |
标识支持 HTTP DELETE 方法的操作。 |
HttpGetAttribute |
标识支持 HTTP GET 方法的操作。 |
HttpHeadAttribute |
标识支持 HTTP HEAD 方法的操作。 |
HttpOptionsAttribute |
标识支持 HTTP OPTIONS 方法的操作。 |
HttpPatchAttribute |
标识支持 HTTP PATCH 方法的操作。 |
HttpPostAttribute |
标识支持 HTTP POST 方法的操作。 |
HttpPutAttribute |
标识支持 HTTP PUT 方法的操作。 |
IgnoreAntiforgeryTokenAttribute |
跳过防伪令牌验证的筛选器。 |
JsonOptions |
配置 SystemTextJsonInputFormatter 和 SystemTextJsonOutputFormatter. |
JsonPatchExtensions | |
JsonResult |
将给定对象的格式设置为 JSON 的操作结果。 |
LocalRedirectResult |
返回 ActionResult “已找到” (302) 、永久 (301) 、临时重定向 (307) 或永久重定向 (308) 响应,并将位置标头移动到提供的本地 URL。 |
MiddlewareFilterAttribute |
执行由 . ConfigurationType. 提供的中间件管道。 中间件管道将被视为异步资源筛选器。 |
ModelBinderAttribute |
可以指定用于绑定的 IModelBinder 模型名称或类型的属性。 |
ModelMetadataTypeAttribute |
此属性指定要与数据模型类关联的元数据类。 |
MvcJsonOptions |
为 MVC 框架中的 JSON 提供编程配置。 |
MvcNewtonsoftJsonOptions |
使用 Newtonsoft.JSON 为 JSON 格式化程序提供编程配置。 |
MvcOptions |
为 MVC 框架提供编程配置。 |
MvcViewOptions |
为 MVC 框架中的视图提供编程配置。 |
NoContentResult |
StatusCodeResult执行时将生成 204 无内容响应。 |
NonActionAttribute |
指示控制器方法不是操作方法。 |
NonControllerAttribute |
指示默认控制器发现机制不会将此属性应用到的类型和任何派生类型视为控制器。 |
NonViewComponentAttribute |
指示默认视图组件发现机制不会将此属性应用到的类型和任何派生类型视为视图组件。 |
NotFoundObjectResult |
ObjectResult执行时将生成“找不到” (404) 响应。 |
NotFoundResult |
表示 StatusCodeResult 执行时将生成“找不到” (404) 响应。 |
ObjectResult |
ActionResult执行时,将使用主机提供的机制将对象写入响应。 |
OkObjectResult |
ObjectResult执行内容协商时,设置实体正文的格式,并在协商和格式设置成功时生成Status200OK响应。 |
OkResult |
StatusCodeResult执行时将生成空Status200OK响应。 |
PageRemoteAttribute |
一个 RemoteAttributeBase 用于 razor 页面处理程序,该处理程序配置了“无干扰验证”,以向网站发送 Ajax 请求。 调用的处理程序应返回 JSON,指示该值是否有效。 |
PartialViewResult |
表示向响应呈现部分视图的一个 ActionResult 。 |
PhysicalFileResult |
FileResult执行时将使用主机提供的机制将文件从磁盘写入响应。 |
ProblemDetails |
一种计算机可读格式,用于根据 https://tools.ietf.org/html/rfc7807HTTP API 响应指定错误。 |
ProducesAttribute |
一个筛选器,用于指定操作将返回的预期 Type 以及支持的响应内容类型。 该值 ContentTypes 用于设置 ContentTypes。 |
ProducesDefaultResponseTypeAttribute |
一个筛选器,指定 Type 未涵盖 ProducesResponseTypeAttribute的所有 HTTP 状态代码的筛选器。 |
ProducesErrorResponseTypeAttribute |
指定默认情况下由带注释的 ApiControllerAttribute控制器返回的类型。 Type 指定在未提供任何值时,与客户端错误关联的 ProducesResponseTypeAttribute 错误模型类型, (HTTP 状态代码 4xx) 。 如果未指定任何值,则 MVC 假定客户端错误类型为 ProblemDetails,如果使用映射客户端错误 (ClientErrorMapping) 。 如果应用程序使用自定义错误类型进行响应,请使用此选项 Attribute 来配置默认错误类型。 |
ProducesResponseTypeAttribute |
一个筛选器,指定操作返回的值和状态代码的类型。 |
RazorViewEngineOptionsSetup |
设置默认 RazorViewEngineOptions选项。 |
RedirectResult |
返回 ActionResult “已找到” (302) 、永久移动 (301) 、临时重定向 (307) 或永久重定向 (308) 响应,并将位置标头移动到提供的 URL。 |
RedirectToActionResult |
返回 ActionResult “已找到” (302) 、永久移动 (301) 、临时重定向 (307) 或具有位置标头的永久重定向 (308) 响应。 以控制器操作为目标。 |
RedirectToPageResult |
返回 ActionResult “已找到 (302) ”或“永久移动” (301) 响应,其中包含 Location 标头。 以已注册的路由为目标。 |
RedirectToRouteResult |
返回 ActionResult “已找到” (302) 、永久移动 (301) 、临时重定向 (307) 或具有位置标头的永久重定向 (308) 响应。 以已注册的路由为目标。 |
RemoteAttribute |
一 RemoteAttributeBase 个控制器,用于将非干扰验证配置为向网站发送 Ajax 请求的控制器。 调用的操作应返回 JSON,指示该值是否有效。 |
RemoteAttributeBase |
一个 ValidationAttribute 配置非干扰性验证,以向网站发送 Ajax 请求。 调用的终结点应返回 JSON,指示该值是否有效。 |
RequestFormLimitsAttribute |
将指定的限制设置为 .Form |
RequestSizeLimitAttribute |
将请求正文大小限制设置为指定大小。 |
RequireHttpsAttribute |
一个授权筛选器,用于确认通过 HTTPS 接收请求。 |
ResponseCacheAttribute |
指定在响应缓存中设置适当标头所需的参数。 |
RouteAttribute |
指定控制器上的属性路由。 |
SerializableError |
定义用于存储 ModelState 信息的可序列化容器。 此信息存储为键/值对。 |
ServiceFilterAttribute |
查找另一个 IServiceProvider筛选器的筛选器。 |
SignInResult |
执行时调用HttpContext.SignInAsync的 。ActionResult |
SignOutResult |
执行时调用HttpContext.SignOutAsync的 。ActionResult |
SkipStatusCodePagesAttribute |
阻止执行 StatusCodePages 中间件的筛选器。 |
StatusCodeResult |
表示 ActionResult 执行时将生成具有给定响应状态代码的 HTTP 响应。 |
TempDataAttribute |
使用 TempDataAttribute 修饰的属性将在其值中存储并从中 ITempDataDictionary加载。 TempDataAttribute 控制器、Razor 页面和 Razor 页面模型的属性支持。 |
TypeFilterAttribute |
一个筛选器,用于创建另一个类型的 ImplementationType筛选器,如果存在,则从依赖项注入中检索缺少的构造函数参数。 |
UnauthorizedObjectResult |
ObjectResult执行时会生成未经授权的 (401) 响应。 |
UnauthorizedResult |
表示 UnauthorizedResult 执行时将生成未经授权的 (401) 响应。 |
UnprocessableEntityObjectResult |
ObjectResult执行时将生成无法处理的实体 (422) 响应。 |
UnprocessableEntityResult |
StatusCodeResult执行时将生成无法处理的实体 (422) 响应。 |
UnsupportedMediaTypeResult |
StatusCodeResult执行时将生成 UnsupportedMediaType (415) 响应。 |
UrlHelperExtensions |
URL 帮助程序扩展方法的静态类。 |
ValidateAntiForgeryTokenAttribute |
指定应用此属性的类或方法验证反伪造令牌。 如果反伪造令牌不可用,或者令牌无效,验证将失败,并且操作方法不会执行。 |
ValidationProblemDetails |
验证错误的 A ProblemDetails 。 |
ViewComponent |
视图组件的基类。 |
ViewComponentAttribute |
指示类和所有子类都是视图组件。 (可选)指定视图组件的名称。 如果为多个视图组件定义基类,则将此属性与该基组件相关联。 |
ViewComponentResult |
一个将视图组件呈现给响应的视图 IActionResult 组件。 |
ViewDataAttribute |
使用 ViewDataAttribute 修饰的属性将在其值中存储并从中 ViewDataDictionary加载。 ViewDataDictionary 控制器的属性和 Razor 页面处理程序支持。 |
ViewResult |
表示呈现响应视图的一个 ActionResult 。 |
VirtualFileResult |
FileResult执行时,使用主机提供的机制将使用虚拟路径指定的文件写入响应。 |
接口
IActionResult |
定义表示操作方法结果的协定。 |
IDesignTimeMvcBuilderConfiguration |
配置 .IMvcBuilder 实现此接口,以便在预编译视图) 期间启用设计时配置 (IMvcBuilder。 |
IRequestFormLimitsPolicy |
筛选器的标记接口,用于为请求正文读取形式的限制定义策略。 |
IRequestSizePolicy |
筛选器的标记接口,用于为请求正文定义最大大小的策略。 |
IUrlHelper |
定义帮助程序在应用程序中为 ASP.NET MVC 生成 URL 的协定。 |
IViewComponentHelper |
支持在视图中呈现视图组件。 |
IViewComponentResult |
的结果 ViewComponent类型。 |
枚举
CompatibilityVersion |
指定由 .. MvcOptions配置的运行时行为的版本兼容性。 |
ResponseCacheLocation |
确定响应中“Cache-control”标头的值。 |
注解
有关 MVC 的简介,请参阅 ASP.NET Core MVC 概述。