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

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

The UIElementInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodUIElementInfoProvider
Constructor. Init hashtables for ID and Fullname (ResourceName|ElementName)
Top
Fields
Properties
  NameDescription
Public propertyStatic memberAllowEditOnlyCurrentModule
Indicates whether allow editing only current selected module
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Public methodAddSiteWhereCondition Obsolete.
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBeginTransaction
Creates a new transaction over this provider.
(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.)
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 methodClearHashtables
Clears the object's 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 methodCreateInfo
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteInfo
Deletes the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteInfo(TInfo).)
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.
Public methodStatic memberGetApplicationNavigationString
Returns navigation string that describes a route to the application given by UI element.
Public methodStatic memberGetChildUIElement Obsolete.
Returns dataset with child elements filtered by additional condition
Protected methodGetChildUIElementInternal Obsolete.
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) Obsolete.
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 methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetElementCaption
Gets the element caption. If caption is not set the display name is used.
Public methodStatic memberGetFirstChildElement Obsolete.
Get first child of UI element
Protected methodGetFirstChildElementInternal Obsolete.
Get first child of UI element
Public methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
Public methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
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 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 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 methodStatic memberGetResourceUIElements Obsolete.
Returns DataSet with child elements of the specified resource element. Only first level will be returned.
Protected methodGetResourceUIElementsInternal Obsolete.
Returns DataSet with child elements of the specified resource element. Only first level will be returned.
Public methodStatic memberGetRolesUIElements
Returns all UIElements for which the roles have permission.
Protected methodGetRolesUIElementsInternal
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 Obsolete.
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition Obsolete.
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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(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, String) Obsolete.
Returns DataSet with specified UI elements.
Public methodStatic memberGetUIElements(String, String, Int32, String) Obsolete.
Returns DataSet with specified UI elements.
Protected methodGetUIElementsInternal Obsolete.
Returns DataSet with specified UI elements.
Public methodStatic memberGetUIMenuElements(String) Obsolete.
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) Obsolete.
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) Obsolete.
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) Obsolete.
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.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.
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 methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQuerySetInfo(TInfo).)
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.
Public methodSortAlphabetically Obsolete.
Sorts the object alphabetically.
(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 methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also