LinkGenerator.GetPathByAddress Метод

  • Ссылка

Определение

Пространство имен:
Microsoft.AspNetCore.Routing
Сборка:
Microsoft.AspNetCore.Routing.Abstractions.dll
Пакет:
Microsoft.AspNetCore.Routing.Abstractions v2.2.0
Пакет:
Microsoft.AspNetCore.App.Ref v3.0.1
Пакет:
Microsoft.AspNetCore.App.Ref v3.1.10
Пакет:
Microsoft.AspNetCore.App.Ref v5.0.0
Пакет:
Microsoft.AspNetCore.App.Ref v6.0.6
Пакет:
Microsoft.AspNetCore.App.Ref v7.0.5
Пакет:
Microsoft.AspNetCore.App.Ref v8.0.0

Перегрузки

GetPathByAddress<TAddress>(TAddress, RouteValueDictionary, PathString, FragmentString, LinkOptions)

Создает URI с абсолютным путем на основе предоставленных значений.
GetPathByAddress<TAddress>(HttpContext, TAddress, RouteValueDictionary, RouteValueDictionary, Nullable<PathString>, FragmentString, LinkOptions)

Создает универсальный код ресурса (URI) с абсолютным путем на основе предоставленных значений и HttpContext.

GetPathByAddress<TAddress>(TAddress, RouteValueDictionary, PathString, FragmentString, LinkOptions)

Создает URI с абсолютным путем на основе предоставленных значений.

public abstract string GetPathByAddress<TAddress> (TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions options = default);
public abstract string? GetPathByAddress<TAddress> (TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);
abstract member GetPathByAddress : 'Address * Microsoft.AspNetCore.Routing.RouteValueDictionary * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string
Public MustOverride Function GetPathByAddress(Of TAddress) (address As TAddress, values As RouteValueDictionary, Optional pathBase As PathString = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As String

Параметры типа

TAddress

Тип адреса.

Параметры

address
TAddress

Значение адреса. Используется для разрешения конечных точек.

values
RouteValueDictionary

Значения маршрута. Используется для развертывания параметров в шаблоне маршрута.

pathBase
PathString

Необязательный путь URI. Добавляется к пути в результирующем универсальном коде ресурса (URI).

fragment
FragmentString

Необязательный фрагмент URI. Добавляется к результирующему универсальному коду ресурса (URI).

options
LinkOptions

Необязательный класс LinkOptions. Параметры предоставленного объекта переопределяют параметры с соответствующими именами из RouteOptions.

Возвращаемое значение

String

Универсальный код ресурса (URI) с абсолютным путем или null.

Применяется к

GetPathByAddress<TAddress>(HttpContext, TAddress, RouteValueDictionary, RouteValueDictionary, Nullable<PathString>, FragmentString, LinkOptions)

Создает универсальный код ресурса (URI) с абсолютным путем на основе предоставленных значений и HttpContext.

public abstract string GetPathByAddress<TAddress> (Microsoft.AspNetCore.Http.HttpContext httpContext, TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Routing.RouteValueDictionary ambientValues = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions options = default);
public abstract string? GetPathByAddress<TAddress> (Microsoft.AspNetCore.Http.HttpContext httpContext, TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Routing.RouteValueDictionary? ambientValues = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);
abstract member GetPathByAddress : Microsoft.AspNetCore.Http.HttpContext * 'Address * Microsoft.AspNetCore.Routing.RouteValueDictionary * Microsoft.AspNetCore.Routing.RouteValueDictionary * Nullable<Microsoft.AspNetCore.Http.PathString> * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string
Public MustOverride Function GetPathByAddress(Of TAddress) (httpContext As HttpContext, address As TAddress, values As RouteValueDictionary, Optional ambientValues As RouteValueDictionary = Nothing, Optional pathBase As Nullable(Of PathString) = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As String

Параметры типа

TAddress

Тип адреса.

Параметры

httpContext
HttpContext

Объект , HttpContext связанный с текущим запросом.

address
TAddress

Значение адреса. Используется для разрешения конечных точек.

values
RouteValueDictionary

Значения маршрута. Используется для развертывания параметров в шаблоне маршрута.

ambientValues
RouteValueDictionary

Значения, связанные с текущим запросом. Необязательный элемент.

pathBase
Nullable<PathString>

Необязательный путь URI. Добавляется к пути в результирующем универсальном коде ресурса (URI). Если значение не указано, будет использоваться значение PathBase .

fragment
FragmentString

Необязательный фрагмент URI. Добавляется к результирующему универсальному коду ресурса (URI).

options
LinkOptions

Необязательный класс LinkOptions. Параметры предоставленного объекта переопределяют параметры с соответствующими именами из RouteOptions.

Возвращаемое значение

String

Универсальный код ресурса (URI) с абсолютным путем или null.

Применяется к