Click or drag to resize
UIElementInfoProvider Class
UIElement info data container class.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractProvider
    CMS.DataEngineBaseAbstractInfoProvider
      CMS.DataEngineAbstractInfoProviderUIElementInfoProvider
        CMS.DataEngineAbstractInfoProviderUIElementInfo, UIElementInfoProvider, ObjectQueryUIElementInfo
          CMS.DataEngineAbstractInfoProviderUIElementInfo, UIElementInfoProvider
            CMS.ModulesUIElementInfoProvider

Namespace: CMS.Modules
Assembly: CMS.Modules (in CMS.Modules.dll) Version: 10.0.0
Syntax
C#
public class UIElementInfoProvider : AbstractInfoProvider<UIElementInfo, UIElementInfoProvider>

The UIElementInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodUIElementInfoProvider
Constructor. Init hashtables for ID and Fullname (ResourceName|ElementName)
Top
Fields
  NameDescription
Public fieldStatic memberAPPLICATION_LEVEL
Defines application root level.
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Public fieldStatic memberMAX_ELEMENT_LEVEL
Maximum nesting level of UI element.
Top
Properties
  NameDescription
Public propertyStatic memberAllowEditOnlyCurrentModule
Indicates whether allow editing only current selected module
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsDataAvailable
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.)
Protected propertyProviderName
Provider name
(Inherited from BaseAbstractInfoProvider.)
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Top
Methods
  NameDescription
Public methodAddSiteWhereCondition(String, Int32, String, Boolean)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodAddSiteWhereCondition(String, Int32, String, Boolean, String)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodApplySourceTQuery
If the provider has a data source specified, applies this source to the given query. Returns the modified query.
(Inherited from BaseAbstractInfoProvider.)
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByFullName
Gets the info object by its full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clear hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo(DataRow, Boolean)
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Protected methodDeleteData(String) Obsolete.
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteData(IWhereCondition) Obsolete.
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteUIElementInfo(Int32)
Deletes the specified UIElement.
Public methodStatic memberDeleteUIElementInfo(UIElementInfo)
Deletes the specified UIElement.
Protected methodDeleteUIElementInfoInternal
Deletes the specified UIElement.
Public methodStatic memberGetApplicationNavigationString
Returns navigation string that describes a route to the application given by UI element.
Public methodGetBindingWhereCondition(String, Int32)
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetBindingWhereCondition(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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCurrentProvider
Gets the current provider instance
(Inherited from AbstractInfoProviderTProvider.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByColumnT
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByGuidColumn Obsolete.
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByIntColumn Obsolete.
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByStringColumn Obsolete.
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets collection of dependency keys to be touched when modifying the current object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetElementCaption
Gets the element caption. If caption is not set the display name is used.
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetExistingIDsInternal Obsolete.
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetFirstChildElement
Get first child of UI element
Protected methodGetFirstChildElementInternal
Get first child of UI element
Protected methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryGetFullNameDictionary.)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
(Overrides BaseAbstractInfoProviderGetFullNameWhereCondition(String).)
Protected methodGetGeneralObjectQuery
Gets an object query from the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetChildUIElement
Returns dataset with child elements filtered by additional condition
Protected methodGetChildUIElementInternal
Returns dataset with child elements filtered by additional condition
Public methodStatic memberGetChildUIElements(Int32)
Returns DataSet with child elements of the specified parent element.
Public methodStatic memberGetChildUIElements(Int32, String)
Returns DataSet with child elements of the specified parent element.
Public methodStatic memberGetChildUIElements(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 methodGetChildUIElementsInternal(Int32, String)
Returns DataSet with child elements of the specified parent element.
Protected methodGetChildUIElementsInternal(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 methodGetInfo(ActionTQuery)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByColumnT
Gets an instance of info object based on the column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIntColumn Obsolete.
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByStringColumn Obsolete.
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetLastElementOrder
Returns last element order for specified parent element.
Protected methodGetLastElementOrderInternal
Returns last order for specified parent element.
Public methodStatic memberGetModuleTopUIElement
Gets top module's element (element with lowest element level)
Protected methodGetModuleTopUIElementInternal
Gets top module's element (element with lowest element level)
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetResourceUIElements
Returns DataSet with child elements of the specified resource element. Only first level will be returned.
Protected methodGetResourceUIElementsInternal
Returns DataSet with child elements of the specified resource element. Only first level will be returned.
Public methodStatic memberGetRolesUIElements(IEnumerableInt32, String)
Returns all UIElements for which the roles have permission.
Public methodStatic memberGetRolesUIElements(String, String) Obsolete.
Returns all UIElements for which the roles have permission.
Protected methodGetRolesUIElementsInternal(IEnumerableInt32, String)
Returns all UIElements for which the given roles have permission.
Protected methodGetRolesUIElementsInternal(String, String) Obsolete.
Returns all UIElements for which the given roles have permission.
Public methodStatic memberGetRootChildUIElements
Returns child UIElements for the specified module.
Protected methodGetRootChildUIElementsInternal
Returns child UIElements for the specified module.
Public methodStatic memberGetRootUIElementInfo(Int32)
Returns the root UIElement info object for Resource.
Public methodStatic memberGetRootUIElementInfo(String)
Returns root UIElement for the specified module.
Protected methodGetRootUIElementInfoInternal(Int32)
Returns the root UIElement info object for Resource.
Protected methodGetRootUIElementInfoInternal(String)
Returns root UIElement for the specified module.
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberGetUIElementAllChildren Obsolete.
Returns all element's children limited by level's offset
Protected methodGetUIElementAllChildrenInternal
Returns all element's children limited by level's offset
Public methodStatic memberGetUIElementInfo(Guid)
Returns object with specified GUID.
Public methodStatic memberGetUIElementInfo(Int32)
Returns the UIElement info object.
Public methodStatic memberGetUIElementInfo(Int32, String)
Returns the UIElement info object.
Public methodStatic memberGetUIElementInfo(String, String)
Returns the UIElement info object.
Protected methodGetUIElementInfoInternal(Guid)
Returns object with specified GUID.
Protected methodGetUIElementInfoInternal(Int32)
Returns the UIElement info object.
Protected methodGetUIElementInfoInternal(Int32, String)
Returns the UIElement info object.
Protected methodGetUIElementInfoInternal(String, String)
Returns the UIElement info object.
Public methodStatic memberGetUIElements
Returns all UI elements.
Public methodStatic memberGetUIElements(String)
Returns DataSet with specified UI elements.
Public methodStatic memberGetUIElements(String, String)
Returns DataSet with specified UI elements.
Public methodStatic memberGetUIElements(String, String, Int32)
Returns DataSet with specified UI elements.
Public methodStatic memberGetUIElements(String, String, Int32, String)
Returns DataSet with specified UI elements.
Protected methodGetUIElementsInternal
Returns all UI elements.
Protected methodGetUIElementsInternal(String, String, Int32, String)
Returns DataSet with specified UI elements.
Public methodStatic memberGetUIMenuElements(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 methodStatic memberGetUIMenuElements(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 methodGetUIMenuElementsInternal(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 methodGetUIMenuElementsInternal(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 methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtables Obsolete.
Initializes the hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberMoveUIElementDown
Moves specified UI element down within the parent UI element.
Protected methodMoveUIElementDownInternal
Moves specified UI element down within the parent UI element.
Public methodStatic memberMoveUIElementUp
Moves specified UI element up within the parent UI element.
Protected methodMoveUIElementUpInternal
Moves specified UI element up within the parent UI element.
Public methodNewTransaction Obsolete.
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberRefreshDataCounts
Updates all counts for all sub-objects.
Protected methodRefreshDataCountsInternal
Updates all counts for all sub-objects.
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Overrides BaseAbstractInfoProviderRefreshObjectsCounts.)
Protected methodRegister
Registers current provider in providers collection
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProviderTProvider.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTProvider.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetUIElementChildCount
Sets correct ElementChildCount to the specified UIElement.
Protected methodSetUIElementChildCountInternal
Sets correct ElementChildCount to the specified UIElement.
Public methodStatic memberSetUIElementInfo
Sets the specified UIElement data.
Protected methodSetUIElementInfoInternal
Sets the specified UIElement data.
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodUseSource(TInfo) Obsolete.
Sets the provider to use given data as data source
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodUseSource(DataQuerySource) Obsolete.
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also