Click or drag to resize
LayoutInfoProvider Class
Provides access to information about layout.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderLayoutInfo, LayoutInfoProvider, ObjectQueryLayoutInfo
    CMS.DataEngineAbstractInfoProviderLayoutInfo, LayoutInfoProvider
      CMS.PortalEngineLayoutInfoProvider

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 11.0.0
Syntax
C#
public class LayoutInfoProvider : AbstractInfoProvider<LayoutInfo, LayoutInfoProvider>

The LayoutInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodLayoutInfoProvider
Constructor.
Top
Fields
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberDefaultDirectives
Returns list of default layout directives (ToLower).
Public propertyStatic memberDefaultNamespaces
List of default transformation namespaces
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 propertyStatic memberLayoutsDirectory
Gets layouts directory.
Public propertyStatic memberStoreLayoutsInExternalStorage
Gets or sets the value that indicates whether shared layouts should be stored externally
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Public methodStatic memberAddLayoutDirectives(String)
Adds the layout directives to the transformation.
Public methodStatic memberAddLayoutDirectives(String, LayoutTypeEnum)
Adds the layout directives to the transformation.
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.)
Public methodStatic memberCountWebpartZones(String, LayoutTypeEnum)
Counts webpart zones in layout code.
Public methodStatic memberCountWebpartZones(String, String)
Counts webpart zones in layout code.
Protected methodCountWebpartZonesInternal
Counts webpart zones in layout code.
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.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteLayoutInfo(Int32)
Deletes specified layout.
Public methodStatic memberDeleteLayoutInfo(LayoutInfo)
Deletes specified layout.
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(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 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 memberGetLayoutDirectives
Layout directives are set before layout code.
Public methodStatic memberGetLayoutInfo(Int32)
Returns the LayoutInfo structure for the specified layout.
Public methodStatic memberGetLayoutInfo(String)
Returns the LayoutInfo structure for the specified layout.
Public methodStatic memberGetLayoutName
Returns full layout name from the given virtual layout path.
Public methodStatic memberGetLayouts
Returns all layouts.
Public methodStatic memberGetLayoutTypeCode
Gets the layout type code for the given enum value.
Public methodStatic memberGetLayoutTypeEnum
Gets the layout type enumeration for the given string value.
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.)
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 memberGetVirtualObject
Returns layout info for specified path
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 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 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 memberSetLayoutInfo
Sets the specified layout 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