Click or drag to resize
BaseInfo Class
Base info class (only carrying the type information).
Base info class (only carrying the type information).
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 9.0.0
Syntax
C#
[SerializableAttribute]
public abstract class BaseInfo : AbstractObject, 
	IInfo, IAdvancedDataContainer, ISerializable, ICMSObject, IHierarchicalDataContainer, 
	IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, 
	IComparable, IRelatedData, IMacroObject

The BaseInfo type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldStatic memberCONFIGURATION
Administration group
Protected fieldStatic memberCONTENTMANAGEMENT
Content management group
Protected fieldStatic memberDEVELOPMENT
Development group
Protected fieldStatic memberGLOBAL
Global group
Protected fieldmStatus
Status of the object.
Protected fieldStatic memberSITE
Site group
Protected fieldStatic memberSOCIALANDCOMMUNITY
Tools group
Top
Properties
  NameDescription
Protected propertyAllowClone
Indicates if the object supports cloning.
Protected propertyAllowRestore
Indicates if the object supports deleting to recycle bin.
Protected propertyAllowTouchParent
Indicates if parent is allowed to be touched, if exists.
Public propertyAssignedSites
Collection of the sites to which the object is associated via site bindings (M:N relationships).
Public propertyBindings
Collection of the binding objects for the given object.
Protected propertyCacheParentData
If true, the parent object data is cached within object.
Protected propertyCodeNameColumn
Code name column name of the info record.
Public propertyColumnNames
Column names.
Protected propertyCustomizedColumns
Gets the list of customized columns in current object
Protected propertyDisplayNameColumn
Display name column name of the info record.
Public propertyGeneralized
Generalized interface of this object.
Protected propertyHasData
Returns true if the object has it's data storage initialized already
Public propertyHasChanged
Returns true if the object changed.
Protected propertyCheckUnique
If true, the code name is checked for uniqueness upon saving.
Protected propertyChildDependencies
Collection of the child dependencies for the given object. These are objects which should be included into the parent data (for example class data for BizForms), but aren't direct child of the object.
Public propertyChildren
Collection of the child objects for the given object.
Public propertyIcon
Object icon
Protected propertyIgnoreExternalColumns
If true, externally stored columns are ignored and are stored normally in DB.
Protected propertyInstanceGUID
Returns the object instance GUID
Protected propertyIsCachedObject
If true, the object is cached within the system for later use
Protected propertyIsClone
Indicates if the object is clone.
Public propertyIsComplete
Returns true if the object is complete (has all columns).
Protected propertyIsDisconnected
Returns true if this collection is disconnected from the database
Public propertyIsGlobal
Returns true if the object is global object. False if the object belongs to specific site only.
Protected propertyIsCheckedOut
Indicates if the object is checked out.
Protected propertyIsCheckedOutByUserID
Gets ID of the user who checked the object out.
Protected propertyIsObjectValid
Returns true if the object is considered valid.
Public propertyItem
Gets or sets the value of the column.
Protected propertyLogEvents
If true, Events tasks are logged on the object update.
Protected propertyLogExport
If true, export tasks are logged on the object update.
Protected propertyLogIntegration
If true, integration tasks are being logged.
Protected propertyLogSynchronization
Indicates how should be handled the logging of synchronization tasks on the object update.
Protected propertyLogWebFarmTasks
If true, web farm tasks are logged on the object update.
Public propertyMetaFiles
Collection of the metafiles belonging to the object.
Protected propertyName
Returns the code name of the object
Protected propertyObjectCategory
Object category.
Protected propertyObjectCodeName
Object code name.
Protected propertyObjectDisplayName
Object display name.
Protected propertyObjectFullName
Object full name if exists
Protected propertyObjectGroupID
Object community group ID.
Protected propertyObjectGUID
Object GUID.
Protected propertyObjectIcon
Object icon metafile.
Protected propertyObjectIconGUID
Object icon GUID.
Protected propertyObjectID
Object ID.
Protected propertyObjectIsCustom
Indicates if object is custom.
Protected propertyObjectIsCustomized
Indicates if object is customized.
Protected propertyObjectLastAccessed
Object last access time (uses internally by providers).
Protected propertyObjectLastModified
Last modified time.
Protected propertyObjectOrder
Returns the order of the object among the other objects.
Protected propertyObjectParent
Object parent.
Protected propertyObjectParentID
Object parent ID.
Public propertyObjectSettings
Object settings
Protected propertyObjectSite
Returns the object site.
Protected propertyObjectSiteID
Object site ID.
Protected propertyObjectSiteName
Object site name.
Protected propertyObjectStatus
Returns the current status of the object.
Protected propertyObjectThumbnail
Object thumbnail metafile.
Protected propertyObjectThumbnailGUID
Object thumbnail GUID.
Protected propertyObjectVersionGUID
Object version GUID.
Public propertyOtherBindings
Collection of the binding objects for the given object.
Public propertyParent
Object parent
Protected propertyParentObjectType
Parent object type.
Protected propertyPrioritizedProperties
Gets the list of properties which should be prioritized in the macro controls (IntelliSense, MacroTree).
Public propertyProcesses
Collection of the processes belonging to the object.
Public propertyProperties
Properties of the object available through GetProperty.
Protected propertyReferringObjects
Collection of the objects depending on this object (object which have FK to this object).
Public propertyRelatedData
Custom data connected to the object.
Public propertyRelatedObjects
Related objects.
Public propertyScheduledTasks
Collection of the scheduled tasks belonging to the object.
Public propertySite
Object site
Protected propertySupportsVersioning
Indicates if the object versioning is supported. Default false
Public propertyThumbnail
Object thumbnail
Protected propertyTouchCacheDependencies
If true, cache dependencies are touched when the object is changed.
Public propertyTypeInfo
Object type information.
Protected propertyUpdateTimeStamp
If true, timestamp of the object is updated when saved.
Protected propertyValidateCodeName
If true, the code name is validated upon saving.
Protected propertyVersioningEnabled
Indicates if the object versioning is enabled by the settings.
Top
Methods
  NameDescription
Protected methodAddColumnPrefixesWhereCondition
Adds restriction to given where filtering out all rows where given column starts with one of excluded prefixes found in TypeInfo default data settings.
Protected methodStatic memberAddDependencyDefaultDataWhereCondition
Adds default data where condition of given dependency on given dependencyIDColumn to given where condition. Returns original where condition if no such dependency exists.
Protected methodBuildObjectPath
Builds the path from the given column.
Public methodStatic memberClear
Clears hashtable with cached properties of all object types.
Protected methodClearCache
Clears the nested cached objects
Protected methodClearCachedValues
Clears the cached values depending on the given column value.
Public methodClearData
Clears data from the object.
Public methodCloneObject
Creates the clone of the object
Public methodCompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodContainsColumn
Returns true if the object contains given column.
Protected methodCopyExternalColumns
Copy value of external columns directly via set value
Protected methodCopyMemoryProperties
Copies memory properties
Public methodDataChanged
Returns true if the object changed.
Public methodDelete
Deletes the object using appropriate provider
Protected methodDeleteExternalColumns
Goes through the columns which are stored externally and deletes all the files.
Protected methodDeleteObject
Deletes the object using appropriate provider.
Public methodDestroy
Destroys the object including its version history using appropriate provider
Protected methodDisconnect
Disconnects the collection from the database.
Protected methodEnsureBinaryData
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
Protected methodEnsureBinaryData(Boolean)
Makes sure that the binary data is loaded into binary column of the object.
Protected methodEnsureCodeName
Ensures the code name of the object if not set
Protected methodEnsureGUID
Ensures the GUID of the object
Protected methodEnsureHierarchyColumns
Ensures the IDPath and Level columns.
Protected methodEnsureLastModified
Ensures the last modified time stamp of the object
Protected methodEnsureUniqueCodeName
Ensures that the object has a unique code name within it's context
Protected methodExecuteRemoveDependencyQuery
Executes given query text using specified connection string.
Public methodExecuteWithOriginalData
Executes the given action using original data of the object
Protected methodExportDefaultData
Exports the default object installation data
Protected methodFinalize
Destructor
(Overrides ObjectFinalize.)
Protected methodGetAutomaticCodeName
Gets the automatic code name for the object
Protected methodGetBinaryData
Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
Public methodGetBooleanValue
Gets the boolean value from the object.
Protected methodStatic memberGetClearCacheMethods
Gets the dictionary of methods for clearing the cache inside the info object [columnName] => [clearCacheAction]
Protected methodGetColumnNames
Gets the default list of column names for this class
Protected methodGetCount
Gets count of the objects filtered by given where condition.
Protected methodGetCurrentObjectPathPart
Builds the path from the given column.
Protected methodGetCustomProperties
Gets list of custom properties.
Protected methodGetData
Returns the data according to the set of input parameters.
Protected methodGetDataQueryInternal
Gets the data query for this object type
Public methodGetDateTimeValue
Gets the DateTime value from the object.
Protected methodGetDefaultData
Returns the default object installation data
Protected methodGetDefaultDataExportColumns
Returns names of all columns that should be exported with default data as a comma separated string.
Protected methodGetDefaultDataWhereCondition
Gets the where condition to filter out the default installation data
Protected methodGetDefaultObject
Returns default object of given object type. Has to be overridden in specific info. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
Protected 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.
Protected methodGetDependenciesNamesAuto
Returns a list of object names which depend on this object.
Protected methodGetDependencyCacheKeys
Gets the array of dependency cache keys for current object.
Public methodGetDependencyObjectType
Gets dependency object type
Protected methodGetDependentObjectsWhereConditions
Returns dictionary collection of where conditions selecting dependent objects for each dependent type.
Public methodGetDoubleValue
Gets the double value from the object.
Protected methodGetEditingPageURL
Gets the object editing page URL.
Protected methodGetExisting
Returns the existing object based on current object data.
Protected methodGetExistingBase
Returns single info object and ensures correct GUID vs. code name priority is used (if applicable) after resolving provided whereCondition.

If no object match provided whereCondition, null is returned.

Protected methodGetExistingWhereCondition
Gets a where condition to find an existing object based on current object
Protected methodGetExistingWhereCondition(Boolean)
Gets a where condition to find an existing object based on current object
Protected methodGetExternalColumns
Returns the list of columns registered as the external columns.
Protected methodGetExternalFiles
Goes through the columns which are stored externally and returns the list of particular files this object uses.
Protected methodGetFullObjectName
Returns the name of the object within its parent hierarchy.
Protected methodGetGeneralizedInfo
Gets the generalized info for this object
Protected methodGetGlobalPermissionName
Returns name of the global permission name corresponding to the given permission name. By default, "Global" + permissionName is returned.
Protected methodGetGroupWhereCondition
Gets the group where condition for the object
Public methodGetGuidValue
Gets the guid value from the object.
Protected methodGetChildDependencies
Gets the child dependencies repository
Protected methodGetChildWhereCondition
Gets the child object where condition.
Protected methodGetIconUrl(Page, String)
Gets the object icon URL
Protected methodGetIconUrl(Int32, Int32, Int32)
Gets the object icon URL
Protected methodGetIDPathPartLength
Returns the length of a part of IDPath.
Public methodGetIntegerValue
Gets the integer value from the object.
Protected methodGetLastObjectOrder
Returns number which will be the last order within all the other items (according to Parent, Group and Site settings). I.e. returns largest existing order + 1.
Protected methodGetLockObject
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
Protected methodGetModifiedFrom
Gets the DataSet of all the objects modified from specified date.
Protected methodGetNameCollisions
Gets the list of the name collisions of the given object
Protected methodGetNamePathPartColumn
Returns the name of the column which is used to build the NamePath
Protected methodGetObject
Gets the object by specified where condition.
Public methodGetObjectData
Object serialization.
Protected methodGetObjectChildren
Gets the object children repository
Protected methodGetObjectIdentifier
Gets the object identifier that uniquely identifies the object
Protected methodGetObjectKey
Gets the unique string key for the object.
Protected methodGetObjectName
Returns object name combining object type name and object display name.
Protected methodGetObjectOrderID
Returns ID of the item being ordered. By default return ObjectID. This is overridden in TreeNode, where NodeID has to be supplied.
Protected methodGetObjectTypeForColumn
Gets the object type for the given column or null if the object type is not found or unknown.
Protected methodGetOrderIdentityWhereCondition
Gets order identity where condition to identify the object to be ordered
Protected methodGetOrderQueryParameters
Creates QueryDataParameters with special macros for object order management.
Public methodGetOriginalValue
Returns the original value of column.
Protected methodGetOtherBindings
Gets the repository of other bindings
Protected methodGetParent
Returns the parent object.
Protected methodGetPermissionName
Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. Derived classes can override this method to change permission which is checked (for example check for global permissions if object is global).
Protected methodGetPermissionObjectType
Returns the permission object type of the object (checks the SiteID column and SiteBinding columns). According to this value, the permission check is performed.
Protected methodGetPermissionToCheck
Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. Derived classes can override this method to change permission which is checked (for example check for global permissions if object is global).
Protected methodGetPhysicalFiles
Gets DataSet with physical files.
Public methodGetProperty
Gets the property value.
Protected methodGetPropertyType
Gets the type of the given property
Protected methodGetReferringObjects
Gets the repository of depending objects
Protected methodGetRegisteredProperties
Gets list of registered properties.
Public methodGetSearchID
Gets the id column value which is used as search id by default.
Protected methodGetSiblingsQueryInternal
Gets the parameterized query to get siblings of the object (If there is no parent-child hierarchy, query is parameterized for all objects)
Protected methodGetSiblingsWhereCondition
Creates where condition according to Parent, Group and Site settings.
Protected methodGetSiteWhereCondition
Gets the site where condition for the object
Public methodGetStringValue
Gets the string value from the object.
Protected methodGetSynchronizedColumns
Gets the list of synchronized columns for this object or null if all columns are synchronized
Protected methodGetThumbnailUrl
Gets the object thumbnail URL
Protected methodGetUniqueCodeName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Protected methodGetUniqueDisplayName
Returns the unique display name for the specified object.
Protected methodGetUniqueName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Protected methodGetUniqueNameWhereCondition
Constructs base where condition for checking column value uniqueness. This method can be overridden in child classes to add more conditions.
Public methodGetValue
Gets the object value.
Protected methodGetValueForTranslation
Returns value for translation services. Returns unmodified field content by default.
Protected methodGetVirtualFileRelativePath
Returns virtual relative path for specific column Ensures the GUID of the object
Public methodChangedColumns
Returns list of column names which values were changed.
Protected methodCheckDefaultPermissions
Check universal permissions for an object
Protected 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.
Protected methodCheckLicense
Checks the object license. Returns true if the licensing conditions for this object were matched.
Public methodCheckPermissions
Checks whether the specified user has permissions for this object.
Protected methodCheckPermissionsInternal
Checks whether the specified user has permissions for this object. This method is called automatically after CheckPermissions event was fired.
Protected methodCheckPermissionsWithHandler
Checks whether the specified user has permissions for this object. Outcome of this method is determined by combining results of CheckPermissions event and CheckPermissionsInternal method.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
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.
Protected methodInitObjectsOrder
Inits the proper order of the sibling objects so the order column is consistent.
Protected methodInitObjectsOrderPostprocessing
Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization.
Public methodInsert
Inserts the object using appropriate provider
Protected methodInsertAsClone
Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
Protected methodInsertAsCloneInternal
This method is called on cloned object prepared in memory by InsertAsClone method. Override if you need to do further actions before inserting actual object to DB (insert special objects, modify foreign keys, copy files, etc.). Calls Insert() by default.
Protected methodInsertAsClonePostprocessing
This method is called once the object is completely cloned (with all children, bindings, etc.). Override if you need to do further actions after the object has been cloned.
Protected methodInvalidate
Invalidates the object in the object table.
Protected methodIsAvailableOnSite
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
Protected methodIsCheckedOutByUser
Returns true if the object is checked out by the specified user.
Protected 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.
Protected 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.
Protected methodIsObjectInvalid
Returns true if the object is invalid.
Public methodItemChanged
Returns true if the item on specified column name changed.
Protected methodLoadData
Loads the object using the given settings
Public methodMacroRepresentation
By default, BaseInfo has no special macro representation.
Public methodMakeComplete
Makes the object data complete.
Protected methodNewObject
Creates new object of the given class based on the given settings
Protected methodPermissionCheckException
Fires an exception in case authorization result is false (denied or insignificant)
Public methodPropertyPropertyType
Returns the extension property for the object
(Inherited from AbstractObject.)
Protected methodReconnect
Reconnects the collection to the database.
Protected methodRemoveObjectDependencies
Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
Public methodResetChanges
Resets the object changes and keeps the new values as unchanged according to the asUnchanged parameter.
Protected methodRestoreSettings
Restores local settings for object instance.
Public methodRevertChanges
Reverts the object changes to the original values.
Protected methodSaveExternalColumns
Goes through the columns which are stored externally and ensures them in the external storage.
Protected methodSerializationNotSupported
Throws serialization not supported exception
Protected methodSetObject
Updates the object using appropriate provider.
Protected methodSetObjectAlphabeticalOrder
Moves the object to the right position according to the custom order.
Protected methodSetObjectOrder
Moves the object to the specified order. The move is done within the object's siblings.
Protected methodSetObjectOrderPostprocessing
Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
Protected methodSetParent
Updates the parent object, enables to update the data that is overridden in the parent object before or after it is saved
Public methodSetValue(String, Object)
Sets the object value.
Public methodSetValue(String, Object, Boolean)
Sets the object value to the nullable column.
Public methodSetValue(String, Object, Object)
Sets the object value to the nullable column.
Protected methodSortAlphabetically
Sort objects alphabetically.
Protected methodStoreSettings
Stores local settings for object instance.
Public methodSubmitChanges
Submits the changes in the object to the database.
Public methodToMacroString
Returns the default text representation in the macros.
Public methodToString
Returns the text representation of the object
(Overrides ObjectToString.)
Protected methodTouchParent
Updates the parent object by saving it (to update the timestamp).
Public methodTryGetProperty(String, Object)
Returns value of property.
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
Public methodTryGetValue
Returns value of column.
Public methodUpdate
Updates the database entity using appropriate provider
Protected methodUpdateExternalColumns
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
Protected methodUpdateFromDB
Updates the data of the object from DB (updates also ObjectSettings).
Protected methodUpdatePhysicalFiles
Saves physical files.
Protected methodWriteDefaultData
Writes the default object installation data into xml file
Top
Operators
  NameDescription
Public operatorStatic member(BaseInfo to GeneralizedInfo)
Implicit operator for conversion from BaseInfo class to GeneralizedInfo
Public operatorStatic member(GeneralizedInfo to BaseInfo)
Implicit operator for conversion from GeneralizedInfo class to BaseInfo
Top
Extension Methods
  NameDescription
Public Extension MethodCompare
Compares two BaseInfo objects (data & structure) according to comparison settings given.
(Defined by DataExtensions.)
Public Extension MethodCopyTo
Copies the data of specified columns of the source object to the target object.
(Defined by DataExtensions.)
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodSerialize
Returns object data serialized into the XML element.
(Defined by SerializationExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Top
See Also