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: 8.2.23

Syntax

public static class VirtualContext

The VirtualContext type exposes the following members.

Methods

	Name	Description
Public method Static member	AddPreviewHash	Gets the custom prefix hash for the virtual context URL validation
Public method Static member	ContainsVirtualContextPrefix	Returns true if the URL contains virtual context prefix
Public method Static member	GetItem	Gets the particular item from virtual context
Public method Static member	GetVirtualContextPath(String, NameValueCollection)	Removes the virtual context prefix from the given URL
Public method Static member	GetVirtualContextPath(String, NameValueCollection, Boolean)	Removes the virtual context prefix from the given URL
Public method Static member	GetVirtualContextPrefix(NameValueCollection)	Gets the prefix for the virtual context URL
Public method Static member	GetVirtualContextPrefix(NameValueCollection, Boolean)	Gets the prefix for the virtual context URL
Public method Static member	HandleVirtualContext	Handles the virtual context for the request. Returns true, if loading of the virtual context succeeded and the request is a virtual context request.
Public method Static member	ItemIsSet	Returns true, if the given item is set
Public method Static member	LoadVirtualContextValues	Handles the virtual context prefixes in the URL. Returns true, if loading of the virtual context value succeeded.
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	ValidatePreviewHash	Gets the additional custom prefix parameters part for the virtual context URL

Fields

	Name	Description
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_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	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	IsUserInitialized	Returns true if user virtual context properties have been initialized
Public property Static member	VirtualContextPrefix	Default URL prefix for the pages virtual context. Default value is "/cms/context/"
Public property Static member	VirtualContextSeparator	Default URL separator for the prefix and original URL for pages with virtual context. Default value is "-"