CMSActionContext Class

Ensures context for the actions block.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<CMSActionContext>
    CMS.Base.AbstractDataContainer<CMSActionContext>
      CMS.Base.AbstractHierarchicalObject<CMSActionContext>
        CMS.Base.ContextContainer<CMSActionContext>
          CMS.Base.AbstractContext<CMSActionContext>
            CMS.Base.AbstractActionContext<CMSActionContext>
              CMS.Base.CMSActionContext

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

Syntax

public sealed class CMSActionContext : AbstractActionContext<CMSActionContext>

The CMSActionContext type exposes the following members.

Constructors

	Name	Description
Public method	CMSActionContext()	Constructor
Public method	CMSActionContext(IUserInfo)	Constructor. Ensures that all actions during the life of this object will use the given user context.

Properties

	Name	Description
Public property	AllowAsyncActions	Indicates if the actions can run asynchronously. Default is true, if the application is web site, otherwise false.
Public property	AllowInitUser	Indicates if the current user should be initialized.
Public property	AllowLicenseRedirect	Indicates whether a redirect is allowed in case the license check fails. If not, an exception is thrown instead.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	ContinuousIntegrationAllowObjectSerialization	Configures if object serialization within continuous integration is allowed in the given context
Public property	CreateSearchTask	Indicates if the search task should be created for the objects.
Public property	CreateVersion	Indicates if the object version should be created. In the context of Delete, false means the object will be destroyed, true means it will be in the recycle bin.
Public property Static member	CurrentAllowAsyncActions	Indicates if the actions can run asynchronously. Default is true.
Public property Static member	CurrentAllowInitUser	Indicates if the current user should be initialized.
Public property Static member	CurrentAllowLicenseRedirect	Indicates whether a redirect is allowed in case the license check fails. If not, an exception is thrown instead.
Public property Static member	CurrentCheckLicense	Indicates whether a license check should be performed when managing objects.
Public property Static member	CurrentContinuousIntegrationAllowObjectSerialization	Indicates if object serialization within continuous integration is allowed in the given context
Public property Static member	CurrentCreateSearchTask	Indicates if the search task should be created for the objects within the context.
Public property Static member	CurrentCreateVersion	Indicates if the object version should be created.
Public property Static member	CurrentDeletePhysicalFiles	Indicates whether a physical files should be deleted for attachments, meta files and media files.
Public property Static member	CurrentDisconnected	Indicates if the objects within current context should behave as disconnected
Public property Static member	CurrentEmptyDataForInvalidLicense	Indicates whether a get data queries for object that are not allowed under current license returns empty data set or throw an error.
Public property Static member	CurrentEnableLogContext	Indicates whether logging through log context (LogContext) is currently enabled.
Public property Static member	CurrentEnableSmartSearchIndexer	Indicates whether a search task should be executed when it is created.
Public property Static member	CurrentIsLiveSite	Indicates whether the currently running code executes on the live site.
Public property Static member	CurrentLogEvents	Indicates if the events should be logged within the context.
Public property Static member	CurrentLogExport	Indicates if the export tasks should be logged within the context.
Public property Static member	CurrentLogIntegration	Indicates if the integration tasks should be logged within the context.
Public property Static member	CurrentLogLicenseWarnings	Indicates whether a warning is logged when license check for feature availability fails.
Public property Static member	CurrentLogSynchronization	Indicates if the staging tasks should be logged within the context.
Public property Static member	CurrentLogWebFarmTasks	Indicates if the web farm tasks should be logged within the context.
Public property Static member	CurrentResetChanges	Indicates whether the changes made to the object instance should be reseted.
Public property Static member	CurrentSendEmails	Indicates if the emails should be sent.
Public property Static member	CurrentSendNotifications	Indicates if the notifications should be sent.
Public property Static member	CurrentSite	Current site of the context.
Public property Static member	CurrentThreadGuid	Guid of the current CMSTread. Empty guid when execution is not running under CMSThread.
Public property Static member	CurrentTouchCacheDependencies	Indicates if the objects cache dependencies should be touched within the context.
Public property Static member	CurrentTouchParent	Indicates if the objects within current context should touch parent object
Public property Static member	CurrentUpdateRating	Indicates whether a rating should be updated.
Public property Static member	CurrentUpdateSystemFields	Indicates if the system fields should be updated.
Public property Static member	CurrentUpdateTimeStamp	Indicates if the objects time stamps should be updated within the context.
Public property Static member	CurrentUpdateUserCounts	Indicates whether a user activity points should be updated.
Public property Static member	CurrentUseCacheForSynchronizationXMLs	Indicates if XMLs in synchronization module should be cached/obtained from cache.
Public property Static member	CurrentUseGlobalAdminContext	Indicates if global admin context should be used.
Public property Static member	CurrentUser	Current user of the context.
Public property	DeletePhysicalFiles	Indicates whether a physical files should be deleted for attachments, meta files and media files.
Public property	Disconnected	Indicates if the objects within current context should behave as disconnected
Public property	EmptyDataForInvalidLicense	Indicates whether a get data queries for object that are not allowed under current license returns empty data set or throw an error.
Public property	EnableLogContext	Indicates whether logging through log context (LogContext) is currently enabled.
Public property	EnableSmartSearchIndexer	Indicates whether a search task should be executed when it is created.
Public property	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
Public property	IsLiveSite	Indicates whether the currently running code executes on the live site.
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	LogEvents	Indicates if the events should be logged.
Public property	LogExport	Indicates if the export tasks should be logged.
Public property	LogIntegration	Indicates if the integration tasks should be logged.
Public property	LogLicenseWarnings	Indicates whether a warning is logged when license check for feature availability fails.
Public property	LogSynchronization	Indicates if the staging tasks should be logged.
Public property	LogWebFarmTasks	Indicates if the web farm tasks should be logged.
Protected property	OriginalData	Previous context data (Inherited from AbstractActionContext<TContext>.)
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
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	ResetChanges	Indicates whether the changes made to the object instance should be reseted.
Public property	RestoreOriginal	If true, the original values are restored in the context (Inherited from AbstractActionContext<TContext>.)
Public property	SendEmails	Indicates if email should be sent.
Public property	SendNotifications	Indicates if the notifications should be sent.
Public property	ThreadCulture	Current thread culture.
Public property	ThreadGuid	Guid of the current CMSTread. Guid.Empty when execution is not running under CMSThread.
Public property	TouchCacheDependencies	Indicates if the objects cache dependencies should be touched.
Public property	TouchParent	Indicates if the objects within current context should touch parent object
Public property	UpdateRating	Indicates whether a user activity points should be updated.
Public property	UpdateSystemFields	Indicates if the system fields should be updated.
Public property	UpdateTimeStamp	Indicates if the objects time stamps should be updated.
Public property	UpdateUserCounts	Indicates whether a user activity points should be updated.
Public property	UseCacheForSynchronizationXMLs	Indicates if XMLs in synchronization module should be cached/obtained from cache.
Public property	UseGlobalAdminContext	Indicates if global admin context should be used.
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	User	User of the context.

Methods

	Name	Description
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method	CloneForNewThread	Clones the object for the 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	DisableAll	Disables all automated actions except for the ones necessary to keep the system consistent Disables: Logging for synchronization, event log, web farm tasks, versioning and cache dependencies Timestamp update Object invalidation Cache usage Asynchronous actions Sending of emails Smart search indexing Updating ratings Does not disable: Object serialization
Public method	DisableLogging	Disables logging of event log, staging and export tasks
Public method	Dispose	Disposes the object. (Inherited from AbstractActionContext<TContext>.)
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>.)
Public method Static member	LogDocumentChange	Indicates if the document change should be logged.
Public method Static member	LogObjectChange	Indicates if the object change should be logged.
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>.)
Protected method	RestoreOriginalValues	Restores the original values to the context (Overrides AbstractActionContext<TContext>.RestoreOriginalValues().)
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>.)
Protected method	StoreOriginalValue<TValue>(Nullable<TValue>, TValue)	Stores current value as the original value if original value hasn't been stored yet. (Inherited from AbstractActionContext<TContext>.)
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>.)

Examples

using(var ctx = new CMSActionContext() { LogEvents = false }) { DoSomeAction(); }