Microsoft.AspNetCore.Mvc 命名空間
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
提供建置 MVC 應用程式所需的類型。
類別
| 名稱 | Description |
|---|---|
| AcceptedAtActionResult |
一個 ActionResult 回傳 Accepted(202) 回應並標示 Location 標頭的 Response。 |
| AcceptedAtRouteResult |
一個 ActionResult 回傳 Accepted(202) 回應並標示 Location 標頭的 Response。 |
| AcceptedResult |
一個 ActionResult 回傳 Accepted(202) 回應並標示 Location 標頭的 Ant。 |
| 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 |
API 慣例可套用於包含 MVC 控制器或單一控制器的組件。 API 慣例用來影響 ApiExplorer 的輸出。 慣例必須是靜態型別。 慣例中的方法會根據規則與動作方法匹配,這些規則可套用於方法名稱或其參數,而ApiConventionTypeMatchAttribute這些規則ApiConventionNameMatchAttribute則套用於參數。 當找不到指定行為的屬性時,MVC 會用 來匹配方法名稱,參數名稱則用 來匹配Exact,參數類型則用 來匹配。AssignableFrom |
| ApiDescriptionActionData |
代表用於建構 |
| ApiExplorerSettingsAttribute |
控制相關控制器類別或動作方法的 |
| AreaAttribute |
指定包含控制器或動作的區域。 |
| AutoValidateAntiforgeryTokenAttribute |
一個屬性,能驗證所有不安全的 HTTP 方法的防偽造標記。 除了 GET、HEAD、OPTIONS 和 TRACE 以外的 HTTP 方法,則需要防偽造令牌。 |
| BadRequestObjectResult |
ObjectResult執行時會產生一個壞請求(400)回應。 |
| BadRequestResult |
StatusCodeResult執行時會產生壞請求(400)回應。 |
| BindAttribute |
此屬性可用於動作參數與類型,以指示模型層級的元資料。 |
| BindPropertiesAttribute |
一個能綁定裝飾控制器或 Razor Page 模型所定義所有屬性的屬性。 |
| BindPropertyAttribute |
一個屬性可以指定模型名稱或類型 IModelBinder ,用來綁定相關屬性。 |
| CacheProfile |
定義一組可用於回應快取的設定。 |
| ChallengeResult |
ActionResult執行時,該命令涉及HttpContext.ChallengeAsync。 |
| ClientErrorData |
提供產生客戶錯誤的資訊。 此類型用於配置由 的 ClientErrorMapping使用者所產生的用戶端錯誤。 |
| ConflictObjectResult |
ObjectResult執行時會產生衝突(409)回應。 |
| ConflictResult |
StatusCodeResult執行時會產生衝突(409)回應。 |
| ConsumesAttribute |
一個用來指定支援請求內容類型的過濾器。 ContentTypes 用於在多個配對中選擇動作。 |
| ContentResult |
ActionResult執行後會產生包含內容的回應。 |
| Controller |
一個支援檢視的 MVC 控制器的基底類別。 |
| ControllerAttribute |
表示該類型及其被套用至的衍生型別,在預設控制器發現機制中被視為控制器,除非 NonControllerAttribute 該類型套用於階層結構中的任一型別。 |
| ControllerBase |
一個沒有視圖支援的 MVC 控制器的基底類別。 |
| ControllerContext |
與目前控制器請求相關的上下文。 |
| ControllerContextAttribute |
規定建立控制器時,控制器屬性應與電流 ControllerContext 一起設定。 該屬性必須有一個公開集合方法。 |
| CookieTempDataProviderOptions | |
| CreatedAtActionResult |
一個 ActionResult 回傳帶有 Location 標頭的 Created (201) 回應。 |
| CreatedAtRouteResult |
一個 ActionResult 回傳帶有 Location 標頭的 Created (201) 回應。 |
| CreatedResult |
一個 ActionResult 回傳帶有 Location 標頭的 Created (201) 回應。 |
| DefaultApiConventions |
預設的 API 慣例。 |
| DisableRequestSizeLimitAttribute |
關閉請求的體型限制。 |
| EmptyResult |
代表 ActionResult 執行時不會有任何作用。 |
| FileContentResult |
代表執行 ActionResult 時會寫入二進位檔案給回應。 |
| FileResult |
代表一個 ActionResult ,執行時會寫入一個檔案作為回應。 |
| FileStreamResult |
代表 執行 ActionResult 時會從串流寫入一個檔案到回應。 |
| ForbidResult |
ActionResult執行時,該命令涉及HttpContext.ForbidAsync。 |
| FormatFilterAttribute |
一個過濾器,會利用路由資料中的格式值或查詢字串來設定從動作回傳的內容類型 ObjectResult 。 |
| FromBodyAttribute |
指定應以請求主體綁定參數或屬性。 |
| FromFormAttribute |
指定參數或屬性應以請求主體中的表單資料綁定。 |
| FromHeaderAttribute |
指定參數或屬性應以請求標頭綁定。 |
| FromQueryAttribute |
指定參數或屬性應以請求查詢字串綁定。 |
| FromRouteAttribute |
指定參數或屬性應以當前請求的路由資料綁定。 |
| FromServicesAttribute |
指定應使用請求服務綁定參數或屬性。 |
| HiddenInputAttribute |
表示相關屬性或所有與該類型相關的屬性都應使用 <「隱藏」型別的輸入> 元素來編輯。 |
| HttpDeleteAttribute |
識別支援 HTTP DELETE 方法的動作。 |
| HttpGetAttribute |
識別支援 HTTP GET 方法的動作。 |
| HttpHeadAttribute |
識別支援 HTTP HEAD 方法的動作。 |
| HttpOptionsAttribute |
識別支援 HTTP OPTIONS 方法的動作。 |
| HttpPatchAttribute |
識別支援 HTTP PATCH 方法的動作。 |
| HttpPostAttribute |
識別支援 HTTP POST 方法的動作。 |
| HttpPutAttribute |
識別支援 HTTP PUT 方法的動作。 |
| IgnoreAntiforgeryTokenAttribute |
一個跳過反偽造代幣驗證的過濾器。 |
| JsonOptions |
設定SystemTextJsonInputFormatterSystemTextJsonOutputFormatter選項 和 。 |
| JsonPatchExtensions | |
| JsonResult |
一個動作結果,將給定物件格式化為 JSON。 |
| LocalRedirectResult |
回 ActionResult 傳 Found (302)、Moved Permanently (301)、Temporary Redirect (307)或永久 Redirect (308) 回應,並以 Location 標頭指向所提供的本地 URL。 |
| MiddlewareFilterAttribute |
執行由 ConfigurationType. 中介軟體管線將被視為非同步資源過濾器。 |
| MiddlewareFilterAttribute<T> |
執行由 ConfigurationType. 中介軟體管線將被視為非同步資源過濾器。 |
| ModelBinderAttribute |
一個可以指定用於綁定的模型名稱或類型屬性 IModelBinder 。 |
| ModelBinderAttribute<TBinder> |
一個可以指定用於綁定的模型名稱或類型屬性 IModelBinder 。 |
| ModelMetadataTypeAttribute |
此屬性指定要與資料模型類別關聯的元資料類別。 |
| ModelMetadataTypeAttribute<T> |
此屬性指定要與資料模型類別關聯的元資料類別。 |
| 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執行時的 that 會利用主機提供的機制寫入一個物件到回應。 |
| OkObjectResult |
ObjectResult執行後,該 會在執行內容協商、格式化實體實體,若協商與格式化成功,則會產生Status200OK回應。 |
| OkResult |
執行 StatusCodeResult 時會產生空回應 Status200OK 。 |
| PageRemoteAttribute |
A是 RemoteAttributeBase 用於 Razor 頁面處理器,該處理器能設定 Unobrussive 驗證以向網站發送 Ajax 請求。 被呼叫的處理器應回傳 JSON 以表示該值是否有效。 |
| PartialViewResult |
代表 ActionResult 一個對回應呈現部分觀點的 。 |
| PhysicalFileResult |
FileResult On 執行會利用主機提供的機制,從磁碟寫入檔案到回應。 |
| ProblemDetails |
一種機器可讀格式,用於根據 HTTP API 回應 https://tools.ietf.org/html/rfc9110中指定錯誤。 |
| ProducesAttribute |
一個過濾器,指定動作將回傳的預期 Type 值及支援的回應內容類型。 該 ContentTypes 值用於設定 ContentTypes。 |
| ProducesAttribute<T> |
一個過濾器,指定動作將回傳的預期 Type 值及支援的回應內容類型。 該 ContentTypes 值用於設定 ContentTypes。 |
| ProducesDefaultResponseTypeAttribute |
一個針對所有未被 HTTP 狀態ProducesResponseTypeAttribute碼 保護Type的過濾器。 |
| ProducesErrorResponseTypeAttribute |
指定由標註為 ApiControllerAttribute的控制器預設回傳的類型。 Type 指定與 a ProducesResponseTypeAttribute 相關的錯誤模型類型,用於用戶端錯誤(HTTP 狀態碼 4xx)時,若未提供任何值。 當未指定值時,若使用映射用戶端錯誤(ClientErrorMapping),MVC 假設用戶端錯誤類型為 ProblemDetails。 如果你的應用程式使用自訂錯誤類型來回應,請用這個 Attribute 設定預設錯誤類型。 |
| ProducesResponseTypeAttribute |
一個過濾器,指定動作回傳的值型別與狀態碼。 |
| ProducesResponseTypeAttribute<T> |
一個過濾器,指定動作回傳的值型別與狀態碼。 |
| RazorViewEngineOptionsSetup |
設定預設選項。RazorViewEngineOptions |
| RedirectResult |
回 ActionResult 傳 Found (302)、永久移動(301)、臨時重定向(307)或永久重定向(308)回應,並標示 Location 標頭指向所提供 URL。 |
| RedirectToActionResult |
回 ActionResult 傳 Found (302)、Moved Permantally(301)、Temporary Redirect(307)或永久重定向(308)回應,並標示 Location 標頭。 目標是控制器動作。 |
| RedirectToPageResult |
一個 ActionResult 會回傳 Found (302) 或 Moved Permantally (301) 回應,並標示 Location 標頭。 目標是一條已登記的路線。 |
| RedirectToRouteResult |
回 ActionResult 傳 Found (302)、Moved Permantally(301)、Temporary Redirect(307)或永久重定向(308)回應,並標示 Location 標頭。 目標是一條已登記的路線。 |
| RemoteAttribute |
A RemoteAttributeBase 代表控制器,該系統配置 Unobrussive 驗證以向網站發送 Ajax 請求。 呼叫的動作應該會回傳 JSON,以表示該值是否有效。 |
| RemoteAttributeBase |
一個 ValidationAttribute 配置 Unobrusive 驗證以向網站發送 Ajax 請求的程序。 被呼叫的端點應回傳 JSON,以表示該值是否有效。 |
| RequestFormLimitsAttribute |
將指定的限制設為 Form。 |
| RequestSizeLimitAttribute |
將請求本體大小限制設為指定的大小。 |
| RequireHttpsAttribute |
一個授權過濾器,確認請求是否透過 HTTPS 收到。 |
| ResponseCacheAttribute |
指定在回應快取中設定適當標頭所需的參數。 |
| RouteAttribute |
指定控制器上的屬性路由。 |
| SerializableError |
定義一個可序列化的容器來儲存 ModelState 資訊。 這些資訊以鍵值對形式儲存。 |
| ServiceFilterAttribute |
一個在 中找到另一個濾波器的濾波 IServiceProvider器。 |
| ServiceFilterAttribute<TFilter> |
一個在 中找到另一個濾波器的濾波 IServiceProvider器。 |
| SignInResult |
ActionResult執行時,該命令涉及HttpContext.SignInAsync。 |
| SignOutResult |
ActionResult執行時,該命令涉及HttpContext.SignOutAsync。 |
| SkipStatusCodePagesAttribute |
一個防止執行 StatusCodePages 中介軟體的過濾器。 |
| StatusCodeResult |
代表執行 ActionResult 時會產生帶有指定回應狀態碼的 HTTP 回應。 |
| TempDataAttribute |
用 TempDataAttribute 裝飾的屬性會將其值儲存在 ITempDataDictionary. TempDataAttribute 支援於控制器、Razor Pages 及 Razor Page Models 的屬性。 |
| TypeFilterAttribute |
一個過濾器,能產生另一個型別 ImplementationType為 的過濾器,若有依賴注入中缺少的建構子參數,則可擷取。 |
| TypeFilterAttribute<TFilter> |
一個過濾器,能產生另一個型別 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執行時,該 會透過虛擬路徑寫入指定的檔案,並利用主機提供的機制回應。 |
介面
| 名稱 | Description |
|---|---|
| IActionResult |
定義一個代表動作方法結果的契約。 |
| IDesignTimeMvcBuilderConfiguration |
設定IMvcBuilder。 實作此介面以啟用設計時設定(例如在檢視前編譯時)。IMvcBuilder |
| IRequestFormLimitsPolicy |
一個標記介面用於定義請求主體限制政策的過濾器,該表單讀取為表單。 |
| IRequestSizePolicy |
一個標記介面,用於定義請求體最大大小的策略過濾器。 |
| IUrlHelper |
定義協助者在應用程式內建立 ASP.NET MVC URL 的合約。 |
| IViewComponentHelper |
支援在視圖中渲染視圖元件。 |
| IViewComponentResult |
結果類型為 ViewComponent。 |
列舉
| 名稱 | Description |
|---|---|
| CompatibilityVersion |
指定由 配置 MvcOptions的執行時行為的版本相容性。 |
| ResponseCacheLocation |
決定回應中「快取控制」標頭的值。 |
備註
關於 MVC 的介紹,請參見 ASP.NET Core MVC概述。