Click or drag to resize
WebPartContainerInfoProvider Class
Class providing WebPartContainerInfo management.
Inheritance Hierarchy
System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<WebPartContainerInfoProvider>
        CMS.DataEngine.AbstractInfoProvider<WebPartContainerInfo, WebPartContainerInfoProvider, ObjectQuery<WebPartContainerInfo>>
          CMS.DataEngine.AbstractInfoProvider<WebPartContainerInfo, WebPartContainerInfoProvider>
            CMS.PortalEngine.WebPartContainerInfoProvider

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 9.0.0
Syntax
C#
public class WebPartContainerInfoProvider : AbstractInfoProvider<WebPartContainerInfo, WebPartContainerInfoProvider>

The WebPartContainerInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodWebPartContainerInfoProvider
Constructor.
Top
Fields
  NameDescription
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Public fieldStatic memberWP_CHAR
Specifies the character that is used as a placeholder in the web part container editing
Top
Properties
  NameDescription
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyHashtableSettings
Hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProvider<TInfo, 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 propertyStoreEmptyValuesInHashtables
If true, provider hashtables store empty values for not found objects to reduce database calls
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyStatic memberStoreWebPartContainersInExternalStorage
Gets or sets the value that indicates whether WebPart containers should be stored externally.
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Public propertyStatic memberWebPartContainersDirectory
Gets the WebPart containers directory path.
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 AbstractInfoProvider<TInfo, 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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodApplySource<TQuery>
If the provider has a data source specified, applies this source to the given query. Returns the modified query.
(Inherited from BaseAbstractInfoProvider.)
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkInsertInfos(IEnumerable<TInfo>)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberClear
Clear hashtable.
Protected methodClearHashtables
Clear hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodCreateInfo(DataRow, Boolean)
Creates a new info object.
(Inherited from AbstractInfoProvider<TInfo, 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(Action<TQuery>)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodDeleteData(String)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodDeleteData(IWhereCondition)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberDeleteWebPartContainerInfo(Int32)
Deletes specified webPartContainer.
Public methodStatic memberDeleteWebPartContainerInfo(WebPartContainerInfo)
Deletes specified webPartContainer.
Protected methodDeleteWebPartContainerInfoInternal
Deletes specified webPartContainer.
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 AbstractInfoProvider<TInfo, 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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberGetContainers
Returns all web part containers.
Protected methodGetContainersInternal
Returns all web part containers.
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider<TInfo, 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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDataByColumn<T>
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDataByGuidColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDataByIntColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDataByStringColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetExistingIDsInternal
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfo(Action<TQuery>)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String)
Gets an instance of info object based on the given code name.
(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)
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, Int32)
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 methodGetInfoByCodeNameFromDB
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByFullName(String)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByFullName(String, Boolean)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByFullNameInternal
Gets the info by its full name from the database
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid, Int32)
Gets an instance of info object based on the 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 methodGetInfoByGuidColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuidFromDB
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoById(Int32)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoById(Int32, Boolean)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByIntColumn
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByStringColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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 methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodGetSiteWhereCondition(Int32)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodGetSiteWhereCondition(Int32, Boolean)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberGetWebPartContainerInfo(Int32)
Returns the WebPartContainerInfo structure for the specified webPartContainer.
Public methodStatic memberGetWebPartContainerInfo(String)
Returns the WebPartContainerInfo structure for the specified webPartContainer.
Public methodStatic memberGetWebPartContainerInfoByGUID
Returns object with specified GUID.
Protected methodGetWebPartContainerInfoInternal(Guid)
Returns WebPartContainer object with specified GUID.
Protected methodGetWebPartContainerInfoInternal(Int32)
Returns Web part container object with specified ID.
Protected methodGetWebPartContainerInfoInternal(String)
Returns WebPartContainer object with specified code name.
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 methodInit
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInitHashtables
Initializes the hashtable settings
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodLoadGeneration
Loads the specified generation of the objects.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodLoadObjectsToHashtables
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodNewTransaction
Creates a new transaction over this provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.)
Protected methodRecalculateData
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.)
Protected methodRegister
Registers current provider in providers collection
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberRemoveFromHash
Remove from hash table.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodReplaceData Obsolete.
Replaces the data in the given columns.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProvider<TProvider>.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProvider<TProvider>.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberSetWebPartContainerInfo
Sets (updates or inserts) specified webPartContainer.
Protected methodSetWebPartContainerInfoInternal
Sets (updates or inserts) specified web part container.
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodUseSource(TInfo[])
Sets the provider to use given data as data source
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodUseSource(DataQuerySource)
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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Top
See Also