RequestContext Class

Request context properties

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<RequestContext>
    CMS.Base.AbstractDataContainer<RequestContext>
      CMS.Base.AbstractHierarchicalObject<RequestContext>
        CMS.Base.ContextContainer<RequestContext>
          CMS.Base.AbstractContext<RequestContext>
            CMS.Helpers.RequestContext

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

Syntax

public sealed class RequestContext : AbstractContext<RequestContext>

The RequestContext type exposes the following members.

Constructors

	Name	Description
Public method	RequestContext

Properties

	Name	Description
Public property Static member	ClientApplication	Dictionary to be used to collect data from server for client application.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property Static member	CurrentDomain	Returns current URL domain, without trailing slashes.
Public property Static member	CurrentExcludedStatus	Returns current excluded status of the request path
Public property Static member	CurrentQueryString	Returns the current request URL query string.
Public property Static member	CurrentRelativePath	Current page relative path. e.g. "~/Home.aspx" has relative path "/Home.aspx"
Public property Static member	CurrentScheme	Returns the current request URL scheme.
Public property Static member	CurrentStatus	Returns current request URL rewriting status.
Public property Static member	CurrentURL	Returns the current request URL.
Public property Static member	CurrentUrlExtension	Returns extension (part after last dot) contained in current URL. Extension starting with . (.ext) or empty extension if there is no extension is returned.
Public property Static member	CurrentURLLangPrefix	Gets or sets the value that contains current language prefix for current URL.
Public property Static member	CurrentURLPathPrefix	Gets or sets the value that contains current path prefix for current URL.
Public property Static member	FullDomain	Returns current URL domain with port if exist.
Public property Static member	IsContentPage	Indicates that the current request is a request to the content page.
Public property	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
Public property Static member	IsSSL	Indicates whether current request is SSL request.
Public property Static member	IsUserAuthenticated	Returns true, if the user is authenticated
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Key	Unique container key (Inherited from ContextContainer<TParent>.)
Public property Static member	LogCurrentError	If true (default), the current application error should be logged
Public property Static member	LogPageHit	Indicates if page hit should be logged.
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	RawURL	Current request RawUrl.
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	ResponseIsCompressed	Indicates whether the current response contains compressed data.
Public property Static member	URL	Gets information about URL of current request.
Public property Static member	URLReferrer	Returns URL referrer or empty string if HttPContext is not initialized.
Public property Static member	UseGZip	If true, the filter uses GZip compression on output.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	UseNoCacheForRedirect	Indicates whether current redirect should add no-cache directive to the response header
Public property Static member	UserAgent	Returns user agent or empty string if HttPContext is not initialized.
Public property Static member	UserHostAddress	Gets or sets user host address. Returns empty string if HttpContext is not initialized and other value is not set.
Public property Static member	UserName	Gets user name or empty string if HttpContext is not initialized. The user name is in the exact format in which the user is authenticated (may not be safe name).

Methods

	Name	Description
Public method Static member	ClearCachedUrlValues	Clears the cached values related to URL of the request
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method	CloneForNewThread	Clones the object for new thread (Overrides AbstractContext<TContext>.CloneForNewThread().)
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	EnsureCurrent	Creates the internal ContextContainer<TParent> storage if it does not exist yet. (Inherited from ContextContainer<TParent>.)
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetAsCurrent	Sets the current instance as the current thread item (Inherited from ContextContainer<TParent>.)
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)