AntiforgeryExtensions.GetHtml(IAntiforgery, HttpContext) Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.ViewFeatures
Assembly:
Microsoft.AspNetCore.Mvc.ViewFeatures.dll
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v1.0.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v1.1.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v2.0.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v2.1.0
Package:
Microsoft.AspNetCore.Mvc.ViewFeatures v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
AntiforgeryExtensions.cs
Source:
AntiforgeryExtensions.cs
Source:
AntiforgeryExtensions.cs

Generates an <input type="hidden"> element for an antiforgery token.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Html::IHtmlContent ^ GetHtml(Microsoft::AspNetCore::Antiforgery::IAntiforgery ^ antiforgery, Microsoft::AspNetCore::Http::HttpContext ^ httpContext);
public static Microsoft.AspNetCore.Html.IHtmlContent GetHtml (this Microsoft.AspNetCore.Antiforgery.IAntiforgery antiforgery, Microsoft.AspNetCore.Http.HttpContext httpContext);
static member GetHtml : Microsoft.AspNetCore.Antiforgery.IAntiforgery * Microsoft.AspNetCore.Http.HttpContext -> Microsoft.AspNetCore.Html.IHtmlContent
<Extension()>
Public Function GetHtml (antiforgery As IAntiforgery, httpContext As HttpContext) As IHtmlContent

Parameters

antiforgery
IAntiforgery

The IAntiforgery instance.

httpContext
HttpContext

The HttpContext associated with the current request.

Returns

IHtmlContent

A IHtmlContent containing an <input type="hidden"> element. This element should be put inside a <form>.

Remarks

This method has a side effect: A response cookie is set if there is no valid cookie associated with the request.

Applies to