UIElementInfoProvider Class

UIElement info data container class.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<UIElementInfo, UIElementInfoProvider, ObjectQuery<UIElementInfo>>
    CMS.DataEngine.AbstractInfoProvider<UIElementInfo, UIElementInfoProvider>
      CMS.Modules.UIElementInfoProvider

Namespace: CMS.Modules
Assembly: CMS.Modules (in CMS.Modules.dll) Version: 13.0.131

Syntax

public class UIElementInfoProvider : AbstractInfoProvider<UIElementInfo, UIElementInfoProvider>, 
	IFullNameInfoProvider, IRelatedObjectCountProvider, IUIElementInfoProvider, IInfoProvider<UIElementInfo>, 
	IInfoByIdProvider<UIElementInfo>, IInfoByGuidProvider<UIElementInfo>

The UIElementInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	UIElementInfoProvider	Constructor. Init hashtables for ID and Fullname (ResourceName|ElementName)

Fields

	Name	Description
Public field Static member	APPLICATION_LEVEL	Defines application root level.
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public field Static member	MAX_ELEMENT_LEVEL	Maximum nesting level of UI element.

Properties

	Name	Description
Public property Static member	AllowEditOnlyCurrentModule	Indicates whether allow editing only current selected module
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteUIElementInfo(Int32)	Obsolete. Deletes the specified UIElement.
Public method Static member	DeleteUIElementInfo(UIElementInfo)	Obsolete. Deletes the specified UIElement.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetApplicationNavigationString	Returns navigation string that describes a route to the application given by UI element.
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetChildUIElements(Int32)	Returns DataSet with child elements of the specified parent element.
Public method Static member	GetChildUIElements(String, String)	Returns DataSet with child elements of the specified element ordered by ElementOrder. Only elements with not empty ElementCaption will be returned because it says that such elements represent menu items.
Protected method	GetChildUIElementsInternal(Int32, String)	Returns DataSet with child elements of the specified parent element.
Protected method	GetChildUIElementsInternal(String, String)	Returns DataSet with child elements of the specified element ordered by ElementOrder. Only elements with not empty ElementCaption will be returned because it says that such elements represent menu items.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetElementCaption	Gets the element caption. If caption is not set the display name is used.
Public method	GetFullNameDictionary	Creates new dictionary for caching the objects by full name
Public method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetLastElementOrder	Returns last element order for specified parent element.
Protected method	GetLastElementOrderInternal	Returns last order for specified parent element.
Public method Static member	GetModuleTopUIElement	Gets top module's element (element with lowest element level)
Protected method	GetModuleTopUIElementInternal	Gets top module's element (element with lowest element level)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetRolesUIElements	Returns all UIElements for which the roles have permission.
Protected method	GetRolesUIElementsInternal	Returns all UIElements for which the given roles have permission.
Public method Static member	GetRootChildUIElements	Returns child UIElements for the specified module.
Protected method	GetRootChildUIElementsInternal	Returns child UIElements for the specified module.
Public method Static member	GetRootUIElementInfo(Int32)	Returns the root UIElement info object for Resource.
Public method Static member	GetRootUIElementInfo(String)	Returns root UIElement for the specified module.
Protected method	GetRootUIElementInfoInternal(Int32)	Returns the root UIElement info object for Resource.
Protected method	GetRootUIElementInfoInternal(String)	Returns root UIElement for the specified module.
Public method Static member	GetUIElementInfo(Guid)	Obsolete. Returns object with specified GUID.
Public method Static member	GetUIElementInfo(Int32)	Obsolete. Returns the UIElement info object.
Public method Static member	GetUIElementInfo(Int32, String)	Returns the UIElement info object.
Public method Static member	GetUIElementInfo(String, String)	Returns the UIElement info object.
Protected method	GetUIElementInfoInternal(Int32, String)	Returns the UIElement info object.
Protected method	GetUIElementInfoInternal(String, String)	Returns the UIElement info object.
Public method Static member	GetUIElements	Obsolete. Returns all UI elements.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	MoveUIElementDown	Moves specified UI element down within the parent UI element.
Protected method	MoveUIElementDownInternal	Moves specified UI element down within the parent UI element.
Public method Static member	MoveUIElementUp	Moves specified UI element up within the parent UI element.
Protected method	MoveUIElementUpInternal	Moves specified UI element up within the parent UI element.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RefreshDataCounts	Updates all counts for all sub-objects.
Protected method	RefreshDataCountsInternal	Updates all counts for all sub-objects.
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects.
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Set	Inserts or updates the info object in the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Public method Static member	SetUIElementChildCount	Sets correct ElementChildCount to the specified UIElement.
Protected method	SetUIElementChildCountInternal	Sets correct ElementChildCount to the specified UIElement.
Public method Static member	SetUIElementInfo	Obsolete. Sets the specified UIElement data.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)