PreviewLinkGenerator.GeneratePreviewModeUrl Method

Generates preview mode URL for the specified page and user.

Namespace: CMS.DocumentEngine.Internal
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public string GeneratePreviewModeUrl(
	Guid userGuid,
	bool readonlyMode = true,
	bool embededInAdministration = false,
	NameValueCollection queryString = null,
	string cultureCode = null
)

Parameters

userGuid

Type: System.Guid
User GUID to be stored in the preview link URL. If left empty, the user name is not stored in the generated URL.

readonlyMode (Optional)

Type: System.Boolean
Indicates if read-only mode should be enabled to disallow modify actions and POST requests.

embededInAdministration (Optional)

Type: System.Boolean
Indicates if page is embedded in administration inside an iframe.

queryString (Optional)

Type: System.Collections.Specialized.NameValueCollection
Optional additional query string parameters.

cultureCode (Optional)

Type: System.String
Culture code for which the preview link should be generated.

Return Value

Type: String

Remarks

Preview mode is used for the page builder and the preview tab.