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: 9.0.0
Syntax
C#
public static class VirtualContext

The VirtualContext type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberPARAM_HASH
Name of the hash parameter
Public fieldStatic memberPARAM_PREVIEW_LINK
Name of the preview link parameter
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 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 memberIsUserInitialized
Returns true if user virtual context properties have been initialized
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 memberAddPreviewHash
Gets the custom prefix hash for the virtual context URL validation
Public methodStatic memberContainsVirtualContextPrefix
Returns true if the URL contains virtual context prefix
Public methodStatic memberGetItem
Gets the particular item from virtual context
Public methodStatic memberGetVirtualContextPath(String, NameValueCollection)
Removes the virtual context prefix from the given URL
Public methodStatic memberGetVirtualContextPath(String, NameValueCollection, Boolean)
Removes the virtual context prefix from the given URL
Public methodStatic memberGetVirtualContextPrefix(NameValueCollection)
Gets the prefix for the virtual context URL
Public methodStatic memberGetVirtualContextPrefix(NameValueCollection, Boolean)
Gets the prefix for the virtual context URL
Public methodStatic memberHandleVirtualContext
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 methodStatic memberItemIsSet
Returns true, if the given item is set
Public methodStatic memberLoadVirtualContextValues
Handles the virtual context prefixes in the URL. Returns true, if loading of the virtual context value succeeded.
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 memberValidatePreviewHash
Gets the additional custom prefix parameters part for the virtual context URL
Top
See Also