Click or drag to resize
AbstractInfoBaseTInfoGeneralizedInfoWrapper Class
Info object wrapper for generalized access
Inheritance Hierarchy
SystemObject
  CMS.DataEngineBaseInfoGeneralizedInfoWrapper
    CMS.DataEngineGeneralizedInfo
      CMS.DataEngineGeneralizedAbstractInfo
        CMS.DataEngineAbstractInfoBaseTInfoGeneralizedInfoWrapper
          CMS.DataEngineGeneralizedAbstractInfoTInfo

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131
Syntax
C#
public abstract class GeneralizedInfoWrapper : GeneralizedAbstractInfo

The AbstractInfoBaseTInfoGeneralizedInfoWrapper generic type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAllowClone
Indicates if the object supports cloning.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyAllowRestore
Indicates if the object supports deleting to recycle bin.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyAllowTouchParent
Indicates if parent is allowed to be touched, if exists.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyBindings
The collection of the binding objects for the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyCacheParentData
If true, the parent object data is cached within object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyCheckUnique
If true, the code name is checked for uniqueness upon saving.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyChildDependencies
Collection of the child dependencies for the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyChildren
The collection of the child objects for the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyCodeNameColumn
Code name column name of the info record.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyColumnNames
Column names.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyCustomizedColumns
Gets the list of customized columns in current object
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyDeleteFiles
Indicates if all physical files should be deleted when object will be deleted.
Public propertyDisplayNameColumn
Code name column name of the info record.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyHasChanged
Returns true if the object has changed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyHasData
Returns true if the object has it's data storage initialized already
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIgnoreExternalColumns
If true, externally stored columns are ignored and are stored normally in DB.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsCachedObject
If true, the object is cached within the system for later use
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsCheckedOut
Indicates if the object is checked out.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsCheckedOutByUserID
Gets ID of the user who checked the object out.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsClone
Indicates if the object is clone.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsComplete
Returns true if the object is complete (has all columns).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsDisconnected
Returns true if the object is disconnected from the data source
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyIsObjectValid
Returns true if the object is considered valid.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyLogEvents
If true, events are logged on the object update.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyLogExport
If true, export tasks are logged on the object update.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyLogIntegration
If true, integration tasks are being logged.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyLogSynchronization
If true, synchronization tasks are logged on the object update.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyLogWebFarmTasks
If true, web farm tasks are logged on the object update.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyMainObject
Main object
Public propertyMetaFiles
The collection of the metafiles of the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectCategory
Object category.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectCodeName
Object code name.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectDisplayName
Object name.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectFullName
Object full name if exists
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectGroupID
Object group ID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectGUID
Object GUID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectIcon
Object icon
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectIconGUID
Object icon GUID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectID
Object ID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectIsCustom
Indicates if object is custom (created by customer).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectIsCustomized
Indicates if object is customized.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectLastModified
Object last modified time.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectOrder
Returns the order of the object among the other objects.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectParent
Object parent
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectParentID
Object parent ID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectSiteID
Object site ID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectSiteName
Object site name.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectThumbnail
Object thumbnail
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectThumbnailGUID
Object thumbnail GUID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyObjectVersionGUID
Object version GUID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyOriginalObjectCodeName
Returns the original object code name
(Overrides BaseInfoGeneralizedInfoWrapperOriginalObjectCodeName.)
Public propertyOtherBindings
The collection of the other binding objects for the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyParentObjectType
Parent object type.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyPrioritizedProperties
Gets the list of properties which should be prioritized in the macro controls (IntelliSense, MacroTree).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyProcesses
The collection of the processes of the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyProperties
Properties of the object available through GetProperty.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyReferringObjects
Collection of the objects depending on this object (object which have FK to this object).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyRelatedData
Custom data connected to the object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyScheduledTasks
The collection of the scheduled tasks of the given object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertySupportsVersioning
Indicates if the object versioning is supported.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyTouchCacheDependencies
If true, cache dependencies are touched when the object is changed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyTypeInfo
Type info.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyUpdateTimeStamp
If true, time stamp is updated on object update.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyUpdateVersionGUID
If true, version GUID of the object is updated when saved.
Public propertyValidateCodeName
If true, the code name is validated upon saving.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public propertyVersioningEnabled
Indicates if the object versioning is enabled by the settings.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Top
Methods
  NameDescription
Public methodAnyItemChanged
Returns true if any of the specified column names has changed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodCheckDependencies
Checks object for dependent objects. Returns true if there is at least one dependent object. First tries to execute checkdependencies query, if not found, an automatic process is executed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodCheckLicense
Checks the object license. Returns true if the licensing conditions for this object were matched
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodCheckPermissions
Checks whether the specified user has permissions for this object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
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 BaseInfoGeneralizedInfoWrapper.)
Public methodClone
Returns the clone
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodContainsColumn
Returns true if the object contains specified column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodDataChanged
Returns true if the object changed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodDataChanged(String)
Returns true if the object changed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodDeleteData
Deletes the object from the database.
(Overrides BaseInfoGeneralizedInfoWrapperDeleteData.)
Public methodDeleteExternalColumns
Goes through the columns which are stored externally and deletes all the files.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodDeleteObject
Deletes the object using appropriate provider.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodDisconnect
Disconnects the object from database.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodEnsureBinaryData
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodEnsureBinaryData(Boolean)
Makes sure that the binary data is loaded into binary column of the object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodEnsureCodeName
Ensures the code name of the object if not set
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodEnsureGUID
Ensures the GUID of the object
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodEnsureUniqueCodeName
Ensures that the object has a unique code name within it's context
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodExportDefaultData
Exports the default object installation data
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetBinaryData
Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetCacheDependencies
Gets collection of dependency keys to be touched when modifying the current object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetChildWhereCondition
Gets the child object where condition.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetColumnType
Gets the column type.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetCount
Gets count of the objects filtered by given where condition.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetData
Returns the data according to the set of input parameters.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetDataQuery
Gets the data query for this object type
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetDefaultDataWhereCondition
Gets where condition for default data according to TypeInfo configuration.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetDefaultObject
Returns default object of given object type. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetDependenciesNames
Returns a list of object names which depend on this object. First tries to execute checkdependencies query, if not found, an automatic process is executed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetDependencyObjectType
Gets dependency object type
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetExisting
Returns the existing object based on current object data.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetExternalColumns
Returns the list of columns registered as the external columns.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetExternalFiles
Goes through the columns which are stored externally and returns the list of particular files this object uses.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetFullObjectName
Returns the name of the object within its parent hierarchy.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetIconUrl
Gets the object icon URL
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetLastObjectOrder
Returns number which will be the last order within all the other items (according to Parent, Group and Site settings).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetLockObject
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetModifiedFrom
Gets the DataSet of all the objects modified from specified date.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetObject(Int32)
Gets the object by its ID.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetObject(String)
Gets the object by specified where condition.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetObject(IWhereCondition)
Gets the object by specified where condition.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetObjectKey
Gets the unique string key for the object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetOriginalValue
Returns the original value of column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetParent
Returns the parent object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetPhysicalFiles
Gets DataSet with physical files for current object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetProperty
Returns property with given name (either object or property value).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetPropertyType
Gets the type of the given property
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetSynchronizedColumns
Gets the list of synchronized columns for this object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetThumbnailUrl
Gets the object thumbnail URL
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetUniqueCodeName
Returns the unique code name generated from current object code name.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetUniqueDisplayName
Returns the unique display name generated from current object display name.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetUniqueName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetValue
Returns value of column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetValueForTranslation
Returns value for translation services. Returns unmodified field content by default.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodGetVirtualFileRelativePath
Returns virtual relative path for specific column
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodInitObjectsOrder
Initializes the proper order of the sibling objects so the order column is consistent.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodInsertAsClone(CloneSettings)
Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodInsertAsClone(CloneSettings, CloneResult)
Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodInsertData
Inserts the object to the database.
(Overrides BaseInfoGeneralizedInfoWrapperInsertData.)
Public methodInvalidate
Invalidates the object in the object table.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodIsAvailableOnSite
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodIsCheckedOutByUser
Returns true if the object is checked out by the specified user.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodIsChildOf
Returns true if the object is child of the given object. If parameter parent is null, returns true only if the object is not a child of any object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodIsModifiedExternally
Goes through the columns which are stored externally and checks if the data in DB is the same as in external storage. If all the columns are same returns true, otherwise false.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodItemChanged
Returns true if the item on specified column name changed.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodMakeComplete
Makes the object data complete.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodMoveObjectDown
Moves the object down within the object order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodMoveObjectUp
Moves the object up within the object order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodNewObject
Creates new object of the given class
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Protected methodNotSupported
Throws the not supported exception
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodReconnect
Reconnects the object to database.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodResetChanges
Resets the object changes and keeps the new values as unchanged.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodRestoreSettings
Restores local settings for object instance.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodRevertChanges
Reverts the object changes to the original values.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSaveExternalColumns
Goes through the columns which are stored externally and ensures them in the external storage.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSetData
Updates or inserts the object to the database.
Public methodSetObject
Updates the object using appropriate provider.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSetObjectAlphabeticalOrder
Moves the object to the right position according to the custom order.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSetObjectOrder
Moves the object to the specified order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSetValue
Sets value of column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSortAlphabetically
Moves the object to the right position according to the custom order.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodStoreSettings
Stores local settings for object instance.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodSubmitChanges
Submits the changes in the object to the database.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodTouchParent
Updates the parent object by saving it (to update the timestamp).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodTryGetProperty(String, Object)
Returns property with given name (either object or property value).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodTryGetValue
Returns value of column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodUpdateData
Updates the object to the database.
(Overrides BaseInfoGeneralizedInfoWrapperUpdateData.)
Public methodUpdateExternalColumns
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodUpdateFromDB
Updates the data of the object from DB (updates also ObjectSettings).
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodUpdatePathColumn
Updates given path column.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Public methodUpdatePhysicalFiles
Updates physical files in given DataSet for current object.
(Inherited from BaseInfoGeneralizedInfoWrapper.)
Top
See Also