VirtualContext Class

Stores the virtual context for the current request

Inheritance Hierarchy

System.Object
  CMS.Helpers.VirtualContext

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public static class VirtualContext

The VirtualContext type exposes the following members.

Fields

	Name	Description
Public field Static member	ADMINISTRATION_DOMAIN_PARAMETER	Query string parameter that holds administration url (scheme + domain + appPath)
Public field Static member	PARAM_CULTURE	Name of the culture code parameter
Public field Static member	PARAM_EMBEDED_IN_ADMINISTRATION	Name of the parameter which indicates if page is embedded in administration inside an iframe.
Public field Static member	PARAM_FORM_BUILDER_EXPIRATION	Name of the parameter which indicates form builder preview link expiration.
Public field Static member	PARAM_FORM_BUILDER_URL	Name of the parameter which indicates that data in the VirtualContext URL belong to Form builder.
Public field Static member	PARAM_HASH	Name of the hash parameter
Public field Static member	PARAM_PREVIEW_LINK	Name of the preview link parameter
Public field Static member	PARAM_PREVIEW_MODE	Name of the parameter indicating that the request is in the preview mode and the user name is stored in the cookie.
Public field Static member	PARAM_READONLY_MODE	Name of the parameter which indicates that the virtual context is in readonly mode and cannot modify data.
Public field Static member	PARAM_SITENAME	Name of the site name parameter
Public field Static member	PARAM_USERNAME	Name of the user name parameter
Public field Static member	PARAM_VIEWMODE	Name of the view mode parameter
Public field Static member	PARAM_WF_GUID	Name of the workflow cycle GUID parameter

Properties

	Name	Description
Public property Static member	CurrentURLPrefix	Current prefix for the URL in the virtual context
Public property Static member	IsFormBuilderLinkInitialized	Returns true if form builder virtual context properties have been initialized.
Public property Static member	IsInitialized	Returns true if some virtual context properties have been initialized
Public property Static member	IsPreviewLinkInitialized	Returns true if preview link virtual context properties have been initialized
Public property Static member	ReadonlyMode	Returns true if virtual context is initialized in readonly mode only
Public property Static member	VirtualContextPrefix	Default URL prefix for the pages virtual context. Default value is "/cmsctx/"
Public property Static member	VirtualContextSeparator	Default URL separator for the prefix and original URL for pages with virtual context. Default value is "-"

Methods

	Name	Description
Public method Static member	AddPathHash	Calculates hash for the given path and appends it to the URL.
Public method Static member	ContainsVirtualContextPrefix	Returns true if the URL contains virtual context prefix
Public method Static member	GetFormBuilderPath	Returns path containing VirtualContext data required by Form builder.
Public method Static member	GetItem	Gets the particular item from virtual context
Public method Static member	GetPreviewLinkParameters	Gets the collection of parameters for preview path.
Public method Static member	GetPreviewLinkPathFromVirtualContext	Gets preview link path based on given path and current initialized context.
Public method Static member	GetPreviewModeParameters	Gets the collection of parameters for preview mode.
Public method Static member	GetPreviewModePathFromVirtualContext	Gets preview mode path based on given path and current initialized context.
Public method Static member	GetVirtualContextPath	Removes the virtual context prefix from the given URL
Public method Static member	GetVirtualContextPrefix	Gets the prefix for the virtual context URL
Public method Static member	HandleVirtualContext	Loads and stores the virtual context values for the request.
Public method Static member	ItemIsSet	Returns true, if the given item is set
Public method Static member	LoadVirtualContextValues	Loads the virtual context values from the URL into a NameValueCollection.
Public method Static member	RemoveVirtualContextPrefix	Removes the virtual context prefix from the given URL
Public method Static member	ReplaceVirtualContextPrefix	Replaces the virtual context prefix from the given URL with a new one
Public method Static member	Reset	Resets the current virtual context
Public method Static member	SetItem	Sets the particular item in the virtual context
Public method Static member	StoreVirtualContextValues	Stores key-value pairs into virtual context.
Public method Static member	ValidatePathHash	Validates the hash of the relative path of the document.
Public method Static member	ValidatePrincipal	Validates whether the request carries a valid user name. The username can be either in the URL or in a cookie.