Click or drag to resize
CustomTableItemProvider Class
Class for retrieving custom table items.
Inheritance Hierarchy
System.Object
  CMS.DataEngine.AbstractInfoProvider<CustomTableItem, CustomTableItemProvider, ObjectQuery<CustomTableItem>>
    CMS.DataEngine.AbstractInfoProvider<CustomTableItem, CustomTableItemProvider>
      CMS.CustomTables.CustomTableItemProvider

Namespace: CMS.CustomTables
Assembly: CMS.CustomTables (in CMS.CustomTables.dll) Version: 12.0.0
Syntax
C#
public class CustomTableItemProvider : AbstractInfoProvider<CustomTableItem, CustomTableItemProvider>

The CustomTableItemProvider type exposes the following members.

Constructors
  NameDescription
Public methodCustomTableItemProvider() Obsolete.
Constructor (Creates uninitialized provider.)
Public methodCustomTableItemProvider(String) Obsolete.
Base constructor for inherited classes and internal purposes
Protected methodCustomTableItemProvider(Boolean, String)
Initializes a new instance of the CustomTableItemProvider class.
Top
Fields
Properties
  NameDescription
Public propertyClassName
Class name
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.IsValid.)
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkInsertInfos(IEnumerable<BaseInfo>)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberCheckLicense
Checks the license.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProvider<TInfo, 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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberClearLicensesCount
Clears custom tables hash count values.
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodCreateInfo
Creates new custom table item instance
(Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.CreateInfo(DataRow, Boolean).)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodCreateWebFarmTask(String, String,Byte[], String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberDeleteItem
Deletes given custom table item
Protected methodDeleteItemInternal
Deletes given custom table item
Public methodStatic memberDeleteItems
Deletes all items for given class.
Protected methodDeleteItemsInternal
Deletes all items for given class.
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberGetClassName
Gets custom table class name from given object type.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberGetItem(Guid, String)
Returns custom table item of specified class name and item GUID.
Public methodStatic memberGetItem(Int32, String)
Returns custom table item of specified class name and item ID.
Public methodStatic memberGetItem<TType>(Guid)
Returns custom table item of specified type.
Public methodStatic memberGetItem<TType>(Int32)
Returns custom table item of specified type.
Protected methodGetItemInternal(Guid)
Returns custom table item of specified class name and item GUID.
Protected methodGetItemInternal(Int32)
Returns custom table item of specified class name and item ID.
Public methodStatic memberGetItemName
Gets custom table item name.
Protected methodGetItemNameInternal
Gets custom table item name.
Public methodStatic memberGetItems(String)
Returns the query for all custom table items.
Public methodStatic memberGetItems(String, String, String, Int32, String)
Returns the query of all data record for given custom table filtered out by where condition and ordered by given expression.
Public methodStatic memberGetItems<TType>()
Returns all custom table items of specified type.
Protected methodGetItemsInternal
Returns the query for all custom table items.
Public methodStatic memberGetLastItemOrder
Returns last item order for specified custom table.
Protected methodGetLastItemOrderInternal
Returns last item order for specified custom table.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodStatic memberGetObjectType
Gets custom table object type from given class name.
Public methodStatic memberGetTypeInfo
Returns the TypeInfo for specified class.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberIsCustomTableItemObjectType
Indicates if given object type represents custom table item.
Public methodStatic memberLicenseVersionCheck
License version checker.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberSetItem
Sets given custom table item
Protected methodSetItemInternal
Sets given custom table item
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodUpdateData(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 methodUpdateObjectInHashtables
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 methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Top
See Also