Microsoft.AspNetCore.Mvc 命名空間
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
提供建置 MVC 應用程式所需的類型。
類別
AcceptedAtActionResult |
, ActionResult 傳回 Accepted (202) 具有 Location 標頭的回應。 |
AcceptedAtRouteResult |
, ActionResult 傳回 Accepted (202) 具有 Location 標頭的回應。 |
AcceptedResult |
, ActionResult 傳回具有 Location 標頭的 Accepted (202) 回應。 |
AcceptVerbsAttribute |
指定動作支援的 HTTP 方法。 |
ActionContext |
已選取做為 HTTP 要求一部分之動作執行的內容物件。 |
ActionContextAttribute |
指定在建立控制器時,應該使用目前的 ActionContext 設定控制器屬性。 屬性必須具有公用集合方法。 |
ActionNameAttribute |
指定動作的名稱。 |
ActionResult |
的預設實作 IActionResult 。 |
ActionResult<TValue> |
包裝 實例或 ActionResult 的型 |
AntiforgeryValidationFailedResult |
BadRequestResult用於反Forgery 驗證失敗的 。 用於 IAntiforgeryValidationFailedResult 比對 MVC 結果篩選內的驗證失敗。 |
ApiBehaviorOptions |
用來設定以 ApiControllerAttribute 標注之型別行為的選項。 |
ApiControllerAttribute |
表示型別和所有衍生型別都用來提供 HTTP API 回應。 使用這個屬性裝飾的控制器會以改善建置 API 的開發人員體驗為目標的功能和行為來設定。 在元件上裝飾時,元件中的所有控制器都會被視為具有 API 行為的控制器。 如需詳細資訊,請參閱 ApiController 屬性。 |
ApiConventionMethodAttribute |
要套用至控制器動作的 API 慣例。 API 慣例可用來影響 ApiExplorer 的輸出。 ApiConventionMethodAttribute 可用來指定適用于動作的確切慣例方法。 ApiConventionTypeAttribute 如需在元件或控制器層級套用慣例的詳細資訊。 |
ApiConventionTypeAttribute |
要套用至包含 MVC 控制器或單一控制器之元件的 API 慣例。 API 慣例可用來影響 ApiExplorer 的輸出。 慣例必須是靜態類型。 慣例中的方法會使用 所 ApiConventionNameMatchAttribute 指定的規則,比對動作方法,這些規則可能會套用至方法名稱或其參數,並 ApiConventionTypeMatchAttribute 套用至參數。 當找不到指定行為的屬性時,MVC 會比 Exact 對方法名稱和參數名稱,並使用 比對 AssignableFrom 參數類型。 |
ApiDescriptionActionData |
表示用來建置 |
ApiExplorerSettingsAttribute |
控制相關聯控制器類別或動作方法之 的可見度和組名 |
AreaAttribute |
指定包含控制器或動作的區域。 |
AutoValidateAntiforgeryTokenAttribute |
屬性,會針對所有不安全的 HTTP 方法,對反分叉權杖進行驗證。 GET、HEAD、OPTIONS 和 TRACE 以外的 HTTP 方法需要反分叉權杖。 |
BadRequestObjectResult |
, ObjectResult 執行時會產生「不正確的要求」 (400) 回應。 |
BadRequestResult |
, StatusCodeResult 執行時會產生錯誤要求 (400) 回應。 |
BindAttribute |
這個屬性可用於動作參數和類型,以表示模型層級中繼資料。 |
BindPropertiesAttribute |
屬性,可針對裝飾控制器或 Razor 頁面模型定義的所有屬性啟用系結。 |
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 |
為所設定的 Cookie 提供程式設計設定 CookieTempDataProvider |
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 |
表示應該使用 < 類型為 「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 傳回 Found (302) 、已永久移動 (301) 、暫存重新導向 (307) 或永久重新導向 (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 時,會使用主機所提供的機制,將物件寫入回應。 |
OkObjectResult |
, ObjectResult 執行時執行內容交涉時,會將實體主體格式化,並在交涉和格式化成功時產生 Status200OK 回應。 |
OkResult |
, StatusCodeResult 執行時會產生空 Status200OK 的回應。 |
PageRemoteAttribute |
適用于 razor 頁面處理常式的 , RemoteAttributeBase 其會設定 Unobtrusive 驗證,以將 Ajax 要求傳送至網站。 叫用的處理常式應該會傳回 JSON,指出值是否有效。 |
PartialViewResult |
表示將 ActionResult 部分檢視轉譯至回應的 。 |
PhysicalFileResult |
執行 FileResult 時,會使用主機所提供的機制,將檔案從磁片寫入回應。 |
ProblemDetails |
電腦可讀取的格式,可根據 在 HTTP API 回應 https://tools.ietf.org/html/rfc7807 中指定錯誤。 |
ProducesAttribute |
指定動作將傳回的預期 Type 篩選,以及支援的回應內容類型。 值 ContentTypes 是用來設定 ContentTypes 。 |
ProducesAttribute<T> |
指定動作將傳回的預期 Type 篩選,以及支援的回應內容類型。 值 ContentTypes 是用來設定 ContentTypes 。 |
ProducesDefaultResponseTypeAttribute |
篩選準則,指定 Type 未涵蓋 ProducesResponseTypeAttribute 的所有 HTTP 狀態碼。 |
ProducesErrorResponseTypeAttribute |
指定以 標注 ApiControllerAttribute 的控制器預設所傳回的類型。 Type 指定當未提供任何值時,用戶端錯誤 (HTTP 狀態碼 4xx) 相關聯的 ProducesResponseTypeAttribute 錯誤模型類型。 如果未指定任何值,MVC 會假設用戶端錯誤類型為 ProblemDetails ,如果使用對應用戶端錯誤 (ClientErrorMapping) 。 如果您的應用程式使用自訂錯誤類型來回應,請使用此選項 Attribute 來設定預設錯誤類型。 |
ProducesResponseTypeAttribute |
指定動作所傳回之值和狀態碼類型的篩選。 |
ProducesResponseTypeAttribute<T> |
指定動作所傳回之值和狀態碼類型的篩選。 |
RazorViewEngineOptionsSetup |
設定 的預設 RazorViewEngineOptions 選項。 |
RedirectResult |
, ActionResult 傳回 Found (302) 、已永久移動 (301) 、暫時重新導向 (307) ,或永久重新導向 (308) 回應,並將 Location 標頭傳送至提供的 URL。 |
RedirectToActionResult |
會 ActionResult 傳回 Found (302) 、已永久移動 (301) 、暫時重新導向 (307) ,或具有 Location 標頭的永久重新導向 (308) 回應。 以控制器動作為目標。 |
RedirectToPageResult |
會 ActionResult 傳回 Found (302) 或已永久移動的 (301) 回應位置標頭。 以已註冊的路由為目標。 |
RedirectToRouteResult |
會 ActionResult 傳回 Found (302) 、已永久移動 (301) 、暫時重新導向 (307) ,或具有 Location 標頭的永久重新導向 (308) 回應。 以已註冊的路由為目標。 |
RemoteAttribute |
RemoteAttributeBase,用於設定非干擾驗證以將 Ajax 要求傳送至網站的控制器。 叫用的動作應該會傳回 JSON,指出值是否有效。 |
RemoteAttributeBase |
, ValidationAttribute 其會設定 Unobtrusive 驗證,以將 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 頁面和 Razor 頁面模型的屬性。 |
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 |
驗證 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 概觀。