Click or drag to resize
VirtualContext Class
Stores the virtual context for the current request
Inheritance Hierarchy
SystemObject
  CMS.HelpersVirtualContext

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131
Syntax
C#
public static class VirtualContext

The VirtualContext type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberADMINISTRATION_DOMAIN_PARAMETER
Query string parameter that holds administration url (scheme + domain + appPath)
Public fieldStatic memberPARAM_CULTURE
Name of the culture code parameter
Public fieldStatic memberPARAM_EMBEDED_IN_ADMINISTRATION
Name of the parameter which indicates if page is embedded in administration inside an iframe.
Public fieldStatic memberPARAM_FORM_BUILDER_EXPIRATION
Name of the parameter which indicates form builder preview link expiration.
Public fieldStatic memberPARAM_FORM_BUILDER_URL
Name of the parameter which indicates that data in the VirtualContext URL belong to Form builder.
Public fieldStatic memberPARAM_HASH
Name of the hash parameter
Public fieldStatic memberPARAM_PREVIEW_LINK
Name of the preview link parameter
Public fieldStatic memberPARAM_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 fieldStatic memberPARAM_READONLY_MODE
Name of the parameter which indicates that the virtual context is in readonly mode and cannot modify data.
Public fieldStatic memberPARAM_SITENAME
Name of the site name parameter
Public fieldStatic memberPARAM_USERNAME
Name of the user name parameter
Public fieldStatic memberPARAM_VIEWMODE
Name of the view mode parameter
Public fieldStatic memberPARAM_WF_GUID
Name of the workflow cycle GUID parameter
Top
Properties
  NameDescription
Public propertyStatic memberCurrentURLPrefix
Current prefix for the URL in the virtual context
Public propertyStatic memberIsFormBuilderLinkInitialized
Returns true if form builder virtual context properties have been initialized.
Public propertyStatic memberIsInitialized
Returns true if some virtual context properties have been initialized
Public propertyStatic memberIsPreviewLinkInitialized
Returns true if preview link virtual context properties have been initialized
Public propertyStatic memberReadonlyMode
Returns true if virtual context is initialized in readonly mode only
Public propertyStatic memberVirtualContextPrefix
Default URL prefix for the pages virtual context. Default value is "/cmsctx/"
Public propertyStatic memberVirtualContextSeparator
Default URL separator for the prefix and original URL for pages with virtual context. Default value is "-"
Top
Methods
  NameDescription
Public methodStatic memberAddPathHash
Calculates hash for the given path and appends it to the URL.
Public methodStatic memberContainsVirtualContextPrefix
Returns true if the URL contains virtual context prefix
Public methodStatic memberGetFormBuilderPath
Returns path containing VirtualContext data required by Form builder.
Public methodStatic memberGetItem
Gets the particular item from virtual context
Public methodStatic memberGetPreviewLinkParameters
Gets the collection of parameters for preview path.
Public methodStatic memberGetPreviewLinkPathFromVirtualContext
Gets preview link path based on given path and current initialized context.
Public methodStatic memberGetPreviewModeParameters
Gets the collection of parameters for preview mode.
Public methodStatic memberGetPreviewModePathFromVirtualContext
Gets preview mode path based on given path and current initialized context.
Public methodStatic memberGetVirtualContextPath
Removes the virtual context prefix from the given URL
Public methodStatic memberGetVirtualContextPrefix
Gets the prefix for the virtual context URL
Public methodStatic memberHandleVirtualContext
Loads and stores the virtual context values for the request.
Public methodStatic memberItemIsSet
Returns true, if the given item is set
Public methodStatic memberLoadVirtualContextValues
Loads the virtual context values from the URL into a NameValueCollection.
Public methodStatic memberRemoveVirtualContextPrefix
Removes the virtual context prefix from the given URL
Public methodStatic memberReplaceVirtualContextPrefix
Replaces the virtual context prefix from the given URL with a new one
Public methodStatic memberReset
Resets the current virtual context
Public methodStatic memberSetItem
Sets the particular item in the virtual context
Public methodStatic memberStoreVirtualContextValues
Stores key-value pairs into virtual context.
Public methodStatic memberValidatePathHash
Validates the hash of the relative path of the document.
Public methodStatic memberValidatePrincipal
Validates whether the request carries a valid user name. The username can be either in the URL or in a cookie.
Top
See Also