Click or drag to resize
UIPageURLSettings Class
Configuration class used for building UI page URLs.
Inheritance Hierarchy
SystemObject
  CMS.UIControlsUIPageURLSettings

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
Syntax
C#
public class UIPageURLSettings

The UIPageURLSettings type exposes the following members.

Constructors
  NameDescription
Public methodUIPageURLSettings
Default constructor.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyAction
Action like 'new' etc.
Public propertyAdditionalQuery
Additional query to append to resulting URL.
Public propertyAllowSplitview
Defines whether to allow transformation of URL to splitview page.
Public propertyAllowViewValidate
Defines whether to allow transformation of URL to ViewValidate page.
Public propertyAppendCurrentQuery
Determines whether the query string of the current page should be appended to final URL.
Public propertyCulture
Culture code (for the context of current action)
Public propertyDeviceProfile
Device profile code name
Public propertyCheckPreferredCulture
Returns true if preferred culture check should be performed.
Public propertyIncludeLiveSiteURL
Indicates if live site URL should be included in result.
Public propertyMode
Mode like 'design', 'ediform' etc.
Public propertyNode
Node (for the context of current action or displayed document)
Public propertyNodeID
Node identifier (for the context of current action or displayed document)
Public propertyPreferredURL
Preferred URL to be transformed or updated.
Public propertyProtectUsingHash
Determines whether the final URL should be protected by hash.
Public propertyQueryParameters
Collection of query parameters to use during building final URL.
Public propertySplitViewSourceURL
URL to use as a referential for creating splitview URL.
Public propertyTransformToCompareUrl
If TRUE, original URL will be transformed to it's comparison variant.
Top
See Also