Click or drag to resize
WebPartInfoProvider Class
Class to provide the WebPartInfo management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderWebPartInfo, WebPartInfoProvider, ObjectQueryWebPartInfo
    CMS.DataEngineAbstractInfoProviderWebPartInfo, WebPartInfoProvider
      CMS.PortalEngineWebPartInfoProvider

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class WebPartInfoProvider : AbstractInfoProvider<WebPartInfo, WebPartInfoProvider>

The WebPartInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodWebPartInfoProvider
Constructor
Top
Fields
Properties
  NameDescription
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.)
Public propertyStatic memberVirtualWebPartsDirectory
Relative path of the directory for the web part virtual objects.
Public propertyStatic memberWebPartsDirectory
Relative path of base directory for the web part files.
Top
Methods
  NameDescription
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.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberDeleteChildWebParts
Deletes all the child web parts of the specified web part.
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 memberDeleteWebPartInfo(Int32)
Delete specified WebPart.
Public methodStatic memberDeleteWebPartInfo(String)
Delete specified WebPart.
Public methodStatic memberDeleteWebPartInfo(WebPartInfo)
Delete specified WebPart.
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetBaseWebPart
Gets the base web part for the specified web part.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetFullPhysicalPath(WebPartInfo, String)
Returns full path of the web part.
Public methodStatic memberGetFullPhysicalPath(String, Int32, String)
Returns full path of the web part.
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 methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously 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 methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously 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 methodGetInfoByIdAsync
Asynchronously 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.)
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 memberGetVirtualWebPartUrl
Returns virtual URL to the web part.
Public methodStatic memberGetWebPartInfo(Int32)
Returns WebPartInfo object for specified WebPartID.
Public methodStatic memberGetWebPartInfo(String)
Returns WebPartInfo object for specified WebPartName.
Public methodStatic memberGetWebPartPhysicalPath
Returns webpart physical path.
Public methodStatic memberGetWebParts
Returns all web parts;
Public methodStatic memberGetWebPartUrl
Returns URL to specified WebPart.
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.)
Public methodStatic memberLoadAllWebParts
Loads all the web parts into the static cache.
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.)
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 methodSet
Inserts or updates the info object in the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodSetAsDefaultProvider

Sets this provider instance as the default provider.

Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization).

(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQuerySetInfo(TInfo).)
Public methodStatic memberSetWebPartInfo
Sets the specified WebPart info data.
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