UIElementInfoProvider Class

UIElement info data container class.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<UIElementInfoProvider>
        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: 10.0.0

Syntax

public class UIElementInfoProvider : AbstractInfoProvider<UIElementInfo, UIElementInfoProvider>

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	hashtableLock	Table lock for loading hashtables (Inherited from BaseAbstractInfoProvider.)
Protected field	infos	Info tables. (Inherited from BaseAbstractInfoProvider.)
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
Protected property	DataSource	Data source for the provider (Inherited from BaseAbstractInfoProvider.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from BaseAbstractInfoProvider.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	InfoType	Returns the type of the info object for this provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsDataAvailable	Returns true if the data is available for this provider (Inherited from BaseAbstractInfoProvider.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractProvider.)
Protected property	ProviderName	Provider name (Inherited from BaseAbstractInfoProvider.)
Public property	TypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)

Methods

	Name	Description
Public method	AddSiteWhereCondition(String, Int32, String, Boolean)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	AddSiteWhereCondition(String, Int32, String, Boolean, String)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ApplySource<TQuery>	If the provider has a data source specified, applies this source to the given query. Returns the modified query. (Inherited from BaseAbstractInfoProvider.)
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByFullName	Gets the info object by its full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByGuid(Guid)	Gets the info object by its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByGuid(Guid, Int32)	Gets the info object by its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoById	Gets the info by ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByName(String)	Gets the info object by its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByName(String, Int32)	Gets the info object by its code name and site Id. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfosByIds	Gets the list of info objects by their IDs. (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>.)
Protected method	ClearHashtables	Clear 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	CreateHashtables	Creates the provider hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo(Int32)	Creates an instance of info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo(DataRow, Boolean)	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 AbstractProvider.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Protected method	DeleteData(String)	Obsolete. Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteData(IWhereCondition)	Obsolete. Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteUIElementInfo(Int32)	Deletes the specified UIElement.
Public method Static member	DeleteUIElementInfo(UIElementInfo)	Deletes the specified UIElement.
Protected method	DeleteUIElementInfoInternal	Deletes the specified UIElement.
Public method Static member	GetApplicationNavigationString	Returns navigation string that describes a route to the application given by UI element.
Public method	GetBindingWhereCondition(String, Int32)	Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetBindingWhereCondition(String, Object[])	Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCacheDependency(DataSet, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCacheDependency(BaseInfo, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCountInternal	Gets the number of items matching the given parameters. Does not check the license when retrieving data. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCurrentProvider	Gets the current provider instance (Inherited from AbstractInfoProvider<TProvider>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByColumn<T>	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByGuidColumn	Obsolete. Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByIntColumn	Obsolete. Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByStringColumn	Obsolete. Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDependencyCacheKeys(DataSet, String, String)	Gets the cache dependency keys for the given DataSet. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDependencyCacheKeys(GeneralizedInfo, String, String)	Gets collection of dependency keys to be touched when modifying the current object. (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.
Protected method	GetEmptyDataSet	Gets the empty data set to be filled by the data (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetExistingIDsInternal	Obsolete. Filters out all object IDs that do not exist in the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetFirstChildElement	Get first child of UI element
Protected method	GetFirstChildElementInternal	Get first child of UI element
Protected method	GetFullNameDictionary	Creates new dictionary for caching the objects by full name (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.GetFullNameDictionary().)
Protected method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name (Overrides BaseAbstractInfoProvider.GetFullNameWhereCondition(String).)
Protected method	GetGeneralObjectQuery	Gets an object query from the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetChildUIElement	Returns dataset with child elements filtered by additional condition
Protected method	GetChildUIElementInternal	Returns dataset with child elements filtered by additional condition
Public method Static member	GetChildUIElements(Int32)	Returns DataSet with child elements of the specified parent element.
Public method Static member	GetChildUIElements(Int32, String)	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	GetInfo(Action<TQuery>)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(IWhereCondition)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(String, String)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	GetInfoByColumn<T>	Gets an instance of info object based on the column value. (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	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIntColumn	Obsolete. Gets an instance of info object based on the integer column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByStringColumn	Obsolete. Gets an instance of info object based on the string column value. (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	GetParentWhereCondition	Gets the where condition to limit the objects to specific parent. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetResourceUIElements	Returns DataSet with child elements of the specified resource element. Only first level will be returned.
Protected method	GetResourceUIElementsInternal	Returns DataSet with child elements of the specified resource element. Only first level will be returned.
Public method Static member	GetRolesUIElements(IEnumerable<Int32>, String)	Returns all UIElements for which the roles have permission.
Public method Static member	GetRolesUIElements(String, String)	Obsolete. Returns all UIElements for which the roles have permission.
Protected method	GetRolesUIElementsInternal(IEnumerable<Int32>, String)	Returns all UIElements for which the given roles have permission.
Protected method	GetRolesUIElementsInternal(String, String)	Obsolete. 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.
Protected method	GetSingleObject	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetTypeInfo	Gets the type info for this provider (Inherited from BaseAbstractInfoProvider.)
Public method Static member	GetUIElementAllChildren	Obsolete. Returns all element's children limited by level's offset
Protected method	GetUIElementAllChildrenInternal	Returns all element's children limited by level's offset
Public method Static member	GetUIElementInfo(Guid)	Returns object with specified GUID.
Public method Static member	GetUIElementInfo(Int32)	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(Guid)	Returns object with specified GUID.
Protected method	GetUIElementInfoInternal(Int32)	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()	Returns all UI elements.
Public method Static member	GetUIElements(String)	Returns DataSet with specified UI elements.
Public method Static member	GetUIElements(String, String)	Returns DataSet with specified UI elements.
Public method Static member	GetUIElements(String, String, Int32)	Returns DataSet with specified UI elements.
Public method Static member	GetUIElements(String, String, Int32, String)	Returns DataSet with specified UI elements.
Protected method	GetUIElementsInternal()	Returns all UI elements.
Protected method	GetUIElementsInternal(String, String, Int32, String)	Returns DataSet with specified UI elements.
Public method Static member	GetUIMenuElements(String)	Returns DataSet with UI elements from second level to fill UI menu and panel. Only elements with not empty ElementCaption will be returned because it says that such elements represent menu items.
Public method Static member	GetUIMenuElements(String, String)	Returns DataSet with UI elements to fill UI menu and panel. Only elements with not empty ElementCaption will be returned because it says that such elements represent menu items.
Protected method	GetUIMenuElementsInternal(String)	Returns DataSet with UI elements from second level to fill UI menu and panel. Only elements with not empty ElementCaption will be returned because it says that such elements represent menu items.
Protected method	GetUIMenuElementsInternal(String, String)	Returns DataSet with UI elements from selected level to fill UI menu and panel. Only elements with not empty ElementCaption will be returned because it says that such elements represent menu items.
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	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtables	Obsolete. Initializes the 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 BaseAbstractInfoProvider.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from BaseAbstractInfoProvider.)
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
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	NewTransaction	Obsolete. Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from BaseAbstractInfoProvider.)
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. (Overrides BaseAbstractInfoProvider.RefreshObjectsCounts().)
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
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	ResetToDefault	Resets the provider to default implementation (Inherited from AbstractInfoProvider<TProvider>.)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TProvider>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	Sets the specified UIElement data.
Protected method	SetUIElementInfoInternal	Sets the specified UIElement data.
Public method	SortAlphabetically	Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	TouchCacheDependencies	Touches the cache dependencies of the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	UseSource(TInfo[])	Obsolete. Sets the provider to use given data as data source (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	UseSource(DataQuerySource)	Obsolete. Sets the provider to use given data as data source (Inherited from BaseAbstractInfoProvider.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)