PageLinkGeneratorExtensions.GetPathByPage Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetPathByPage(LinkGenerator, String, String, Object, PathString, FragmentString, LinkOptions) |
Generates a URI with an absolute path based on the provided values. |
| GetPathByPage(LinkGenerator, HttpContext, String, String, Object, Nullable<PathString>, FragmentString, LinkOptions) |
Generates a URI with an absolute path based on the provided values. |
GetPathByPage(LinkGenerator, String, String, Object, PathString, FragmentString, LinkOptions)
Generates a URI with an absolute path based on the provided values.
public static string GetPathByPage (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string page, string handler = default, object values = default, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions options = default);public static string? GetPathByPage (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string page, string? handler = default, object? values = default, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);static member GetPathByPage : Microsoft.AspNetCore.Routing.LinkGenerator * string * string * obj * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string<Extension()>
Public Function GetPathByPage (generator As LinkGenerator, page As String, Optional handler As String = Nothing, Optional values As Object = Nothing, Optional pathBase As PathString = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As StringParameters
- generator
- LinkGenerator
The LinkGenerator.
- page
- String
The page name. Used to resolve endpoints.
- handler
- String
The page handler name. Used to resolve endpoints. Optional.
- values
- Object
The route values. Optional. Used to resolve endpoints and expand parameters in the route template.
- pathBase
- PathString
An optional URI path base. Prepended to the path in the resulting URI.
- fragment
- FragmentString
A URI fragment. Optional. Appended to the resulting URI.
- options
- LinkOptions
An optional LinkOptions. Settings on provided object override the settings with matching
names from RouteOptions.
Returns
A URI with an absolute path, or null if a URI cannot be created.
Applies to
GetPathByPage(LinkGenerator, HttpContext, String, String, Object, Nullable<PathString>, FragmentString, LinkOptions)
Generates a URI with an absolute path based on the provided values.
public static string GetPathByPage (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string page = default, string handler = default, object values = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions options = default);public static string? GetPathByPage (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string? page = default, string? handler = default, object? values = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);static member GetPathByPage : Microsoft.AspNetCore.Routing.LinkGenerator * Microsoft.AspNetCore.Http.HttpContext * string * string * obj * Nullable<Microsoft.AspNetCore.Http.PathString> * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string<Extension()>
Public Function GetPathByPage (generator As LinkGenerator, httpContext As HttpContext, Optional page As String = Nothing, Optional handler As String = Nothing, Optional values As Object = Nothing, Optional pathBase As Nullable(Of PathString) = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As StringParameters
- generator
- LinkGenerator
The LinkGenerator.
- httpContext
- HttpContext
The HttpContext associated with the current request.
- page
- String
The page name. Used to resolve endpoints. Optional. If null is provided, the current page route value
will be used.
- handler
- String
The page handler name. Used to resolve endpoints. Optional.
- values
- Object
The route values. Optional. Used to resolve endpoints and expand parameters in the route template.
- pathBase
- Nullable<PathString>
An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of PathBase will be used.
- fragment
- FragmentString
A URI fragment. Optional. Appended to the resulting URI.
- options
- LinkOptions
An optional LinkOptions. Settings on provided object override the settings with matching
names from RouteOptions.
Returns
A URI with an absolute path, or null if a URI cannot be created.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for