Generates a new friendly Url based on the parameters supplied

Namespace: DotNetNuke.Entities.Urls
Assembly: DotNetNuke (in DotNetNuke.dll)

Syntax

C#
public abstract string ChangeFriendlyUrl(
	TabInfo tab,
	string friendlyUrlPath,
	FriendlyUrlOptions options,
	string cultureCode,
	ref string endingPageName,
	out bool useDnnPagePath,
	ref List<string> messages
)
Visual Basic
Public MustOverride Function ChangeFriendlyUrl ( 
	tab As TabInfo,
	friendlyUrlPath As String,
	options As FriendlyUrlOptions,
	cultureCode As String,
	ByRef endingPageName As String,
	<OutAttribute> ByRef useDnnPagePath As Boolean,
	ByRef messages As List(Of String)
) As String

Parameters

tab
Type: DotNetNuke.Entities.Tabs..::..TabInfo
The current Tab the Friendly Url is for
friendlyUrlPath
Type: System..::..String
The current friendly Url Path (minus alias) as generated by the Advanced Friendly Url provider
options
Type: DotNetNuke.Entities.Urls..::..FriendlyUrlOptions
The current friendly Url options that apply to the current portal, as configured within the Extension Url Provider settings. These include space replacement values and other settings which should be incorporated into the Friendly Url generation.
cultureCode
Type: System..::..String
paramcultureCodeM:DotNetNuke.Entities.Urls.ExtensionUrlProvider.ChangeFriendlyUrl(DotNetNuke.Entities.Tabs.TabInfo,System.String,DotNetNuke.Entities.Urls.FriendlyUrlOptions,System.String,System.String@,System.Boolean@,System.Collections.Generic.List{System.String}@)
endingPageName
Type: System..::..String%
The 'pageName' value that comes from the FriendlyUrl API of DNN. Normally this is the 'default.aspx' value (DotNetNuke.Common.Globals.glbDefaultPage). A value of 'default.aspx' is discarded. However, it may be a different value for other modules and if not default.aspx will be appended to the end of the Url. This is a ref parameter, so it can either be left as-is, or changed to default.aspx or "" if no specific value is required.
useDnnPagePath
Type: System..::..Boolean%
Output parameter, must be set by module Friendly Url Provider. If true, the /pagename/ part of the Url will be removed, and the Url path will be relative from the site root (example.com/custom-module-path instead of example.com/pagename/custom-module-path)
messages
Type: System.Collections.Generic..::..List<(Of <(<'String>)>)>%
A list of information messages used for both debug output and UI information. Add any informational message to this collection if desired.

Return Value

Friendly Url for specified values. Return friendlyUrlPath if no change is made.

Remarks

Note using 'useDnnPagePath' = true requires having a specific tab returned from the TransformFriendlyUrlToQueryString below. Usage of the 'useDnnPagePath' implies the TransformFriendlyUrlToQueryString method returns a ?tabid=xx value in the querystring. It also means the provider level property 'AlwaysUsesDnnPagePath' must return 'false'

See Also