CMSActionContext Members

Kentico 8.1 API Reference

The CMSActionContext type exposes the following members.

Constructors

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

Methods

	Name	Description
	CloneForNewThread	Clones the object for the new thread (Overrides AbstractContext TContext CloneForNewThread .)
	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 ObjectType .)
	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer ParentObjectType .)
	DisableAll	Disables logging for synchronization, event log, web farm tasks, versioning and cache dependencies Disables timestamp update Disables object invalidation Disables cache usage Disables asynchronous actions Disables sending of emails
	DisableLogging	Disables logging of event log, staging and export tasks
	Dispose	Disposes the object. (Inherited from AbstractActionContext TContext .)
	EnsureRequiredValues	Initialize context
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject ObjectType .)
	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject ObjectType .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject ObjectType .)
	LogDocumentChange	Indicates if the document change should be logged.
	LogObjectChange	Indicates if the object change should be logged.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RegisterColumn(String, Func ParentObjectType, Object )	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisterColumn(String, Func ParentObjectType, Object , Func ParentObjectType, Object, Object )	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisterProperty(String, Func ObjectType, Object )	Registers the given property to the object (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisterProperty(String, Object, Func ObjectType, Object, Object )	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject ObjectType .)
	RestoreOriginalValues	Restores the original values to the context (Overrides AbstractActionContext TContext RestoreOriginalValues .)
	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject ObjectType .)
	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetProperty(String, Object )	Gets the context property. (Inherited from AbstractHierarchicalObject ObjectType .)
	TryGetProperty(String, Object , Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject ObjectType .)
	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer ParentObjectType .)

Extension Methods

	Name	Description
	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
	AllowAsyncActions	Indicates if the actions can run asynchronously. Default is true, if the application is web site, otherwise false.
	AllowInitUser	Indicates if the current user should be initialized.
	AllowLicenseRedirect	Indicates whether a redirect is allowed in case the license check fails. If not, an exception is thrown instead.
	ColumnNames	Available column names. (Inherited from AbstractDataContainer ParentObjectType .)
	CreateSearchTask	Indicates if the search task should be created for the objects.
	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.
	Culture	Current thread culture.
	CurrentAllowAsyncActions	Indicates if the actions can run asynchronously. Default is true.
	CurrentAllowInitUser	Indicates if the current user should be initialized.
	CurrentAllowLicenseRedirect	Indicates whether a redirect is allowed in case the license check fails. If not, an exception is thrown instead.
	CurrentCreateSearchTask	Indicates if the search task should be created for the objects within the context.
	CurrentCreateVersion	Indicates if the object version should be created.
	CurrentCulture	Current thread culture.
	CurrentDeletePhysicalFiles	Indicates whether a physical files should be deleted for attachments, meta files and media files.
	CurrentDisconnected	Indicates if the objects within current context should behave as disconnected
	CurrentEmptyDataForInvalidLicense	Indicates whether a get data queries for object that are not allowed under current license returns empty data set or throw an error.
	CurrentEnableLogContext
	CurrentEnableSmartSearchIndexer	Indicates whether a search task should be executed when it is created.
	CurrentCheckLicense	Indicates whether a license check should be performed when managing objects.
	CurrentInvalidateObject	Indicates if the objects should be invalidated within the context.
	CurrentIsLiveSite	Current user of the context.
	CurrentLogEvents	Indicates if the events should be logged within the context.
	CurrentLogExport	Indicates if the export tasks should be logged within the context.
	CurrentLogIntegration	Indicates if the integration tasks should be logged within the context.
	CurrentLogLicenseWarnings	Indicates whether a warning is logged when license check for feature availability fails.
	CurrentLogSynchronization	Indicates if the staging tasks should be logged within the context.
	CurrentLogWebFarmTasks	Indicates if the web farm tasks should be logged within the context.
	CurrentResetChanges	Indicates whether the changes made to the object instance should be reseted.
	CurrentSendEmails	Indicates if the emails should be sent.
	CurrentSendNotifications	Indicates if the notifications should be sent.
	CurrentSite	Current site of the context.
	CurrentThreadGuid	Guid of the current CMSTread. Empty guid when execution is not running under CMSThread.
	CurrentTouchCacheDependencies	Indicates if the objects cache dependencies should be touched within the context.
	CurrentTouchParent	Indicates if the objects within current context should touch parent object
	CurrentUICulture	Current thread UI culture.
	CurrentUpdateRating	Indicates whether a rating should be updated.
	CurrentUpdateSystemFields	Indicates if the system fields should be updated.
	CurrentUpdateTimeStamp	Indicates if the objects time stamps should be updated within the context.
	CurrentUpdateUserCounts	Indicates whether a user activity points should be updated.
	CurrentUseCache	Indicates if cache should be used for data operations.
	CurrentUseGlobalAdminContext	Indicates if global admin context should be used.
	CurrentUser	Current user of the context.
	DeletePhysicalFiles	Indicates whether a physical files should be deleted for attachments, meta files and media files.
	Disconnected	Indicates if the objects within current context should behave as disconnected
	EmptyDataForInvalidLicense	Indicates whether a get data queries for object that are not allowed under current license returns empty data set or throw an error.
	EnableLogContext	Indicates whether logging through log context (LogContext) is currently enabled.
	EnableSmartSearchIndexer	Indicates whether a search task should be executed when it is created.
	InvalidateObject	Indicates if the objects should be invalidated.
	IsDefault	Returns true if the context is the default request context (Inherited from RequestContainer TParent .)
	IsLiveSite	User of the context.
	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject ObjectType .)
	LogEvents	Indicates if the events should be logged.
	LogExport	Indicates if the export tasks should be logged.
	LogIntegration	Indicates if the integration tasks should be logged.
	LogLicenseWarnings	Indicates whether a warning is logged when license check for feature availability fails.
	LogSynchronization	Indicates if the staging tasks should be logged.
	LogWebFarmTasks	Indicates if the web farm tasks should be logged.
	OriginalData	Previous context data (Inherited from AbstractActionContext TContext .)
	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject ObjectType .)
	PropertyList	Used property list (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject ObjectType .)
	ResetChanges	Indicates whether the changes made to the object instance should be reseted.
	RestoreOriginal	If true, the original values are restored in the context (Inherited from AbstractActionContext TContext .)
	SendEmails	Indicates if email should be sent.
	SendNotifications	Indicates if the notifications should be sent.
	ThreadGuid	Guid of the current CMSTread. Guid.Empty when execution is not running under CMSThread.
	TouchCacheDependencies	Indicates if the objects cache dependencies should be touched.
	TouchParent	Indicates if the objects within current context should touch parent object
	UICulture	Current thread UI culture.
	UpdateRating	Indicates whether a user activity points should be updated.
	UpdateSystemFields	Indicates if the system fields should be updated.
	UpdateTimeStamp	Indicates if the objects time stamps should be updated.
	UpdateUserCounts	Indicates whether a user activity points should be updated.
	UseCache	Indicates if cache should be used for data operations.
	UseGlobalAdminContext	Indicates if global admin context should be used.
	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject ObjectType .)
	User	User of the context.