UIPageURLSettings Class

Configuration class used for building UI page URLs.

Inheritance Hierarchy

System.Object
  CMS.UIControls.UIPageURLSettings

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class UIPageURLSettings

The UIPageURLSettings type exposes the following members.

Constructors

	Name	Description
Public method	UIPageURLSettings	Default constructor.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	Action	Action like 'new' etc.
Public property	AdditionalQuery	Additional query to append to resulting URL.
Public property	AllowSplitview	Defines whether to allow transformation of URL to splitview page.
Public property	AllowViewValidate	Defines whether to allow transformation of URL to ViewValidate page.
Public property	AppendCurrentQuery	Determines whether the query string of the current page should be appended to final URL.
Public property	Culture	Culture code (for the context of current action)
Public property	DeviceProfile	Device profile code name
Public property	CheckPreferredCulture	Returns true if preferred culture check should be performed.
Public property	IncludeLiveSiteURL	Indicates if live site URL should be included in result.
Public property	Mode	Mode like 'design', 'ediform' etc.
Public property	Node	Node (for the context of current action or displayed document)
Public property	NodeID	Node identifier (for the context of current action or displayed document)
Public property	PreferredURL	Preferred URL to be transformed or updated.
Public property	ProtectUsingHash	Determines whether the final URL should be protected by hash.
Public property	QueryParameters	Collection of query parameters to use during building final URL.
Public property	SplitViewSourceURL	URL to use as a referential for creating splitview URL.
Public property	TransformToCompareUrl	If TRUE, original URL will be transformed to it's comparison variant.