BaseInfo Class

Base info class (only carrying the type information).

Base info class (only carrying the type information).

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractObject
    CMS.DataEngine.BaseInfo
      CMS.DataEngine.AbstractInfoBase<TInfo>
      CMS.DataEngine.NotImplementedInfo

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 9.0.0

Syntax

[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

	Name	Description
Protected method	BaseInfo(ObjectTypeInfo)	Constructor.
Protected method	BaseInfo(SerializationInfo, StreamingContext)	Serialization constructor.
Protected method	BaseInfo(SerializationInfo, StreamingContext, ObjectTypeInfo[])	Serialization constructor.

Fields

	Name	Description
Protected field Static member	CONFIGURATION	Administration group
Protected field Static member	CONTENTMANAGEMENT	Content management group
Protected field Static member	DEVELOPMENT	Development group
Protected field Static member	GLOBAL	Global group
Protected field	mStatus	Status of the object.
Protected field Static member	SITE	Site group
Protected field Static member	SOCIALANDCOMMUNITY	Tools group

Properties

	Name	Description
Protected property	AllowClone	Indicates if the object supports cloning.
Protected property	AllowRestore	Indicates if the object supports deleting to recycle bin.
Protected property	AllowTouchParent	Indicates if parent is allowed to be touched, if exists.
Public property	AssignedSites	Collection of the sites to which the object is associated via site bindings (M:N relationships).
Public property	Bindings	Collection of the binding objects for the given object.
Protected property	CacheParentData	If true, the parent object data is cached within object.
Protected property	CodeNameColumn	Code name column name of the info record.
Public property	ColumnNames	Column names.
Protected property	CustomizedColumns	Gets the list of customized columns in current object
Protected property	DisplayNameColumn	Display name column name of the info record.
Public property	Generalized	Generalized interface of this object.
Protected property	HasData	Returns true if the object has it's data storage initialized already
Public property	HasChanged	Returns true if the object changed.
Protected property	CheckUnique	If true, the code name is checked for uniqueness upon saving.
Protected property	ChildDependencies	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 property	Children	Collection of the child objects for the given object.
Public property	Icon	Object icon
Protected property	IgnoreExternalColumns	If true, externally stored columns are ignored and are stored normally in DB.
Protected property	InstanceGUID	Returns the object instance GUID
Protected property	IsCachedObject	If true, the object is cached within the system for later use
Protected property	IsClone	Indicates if the object is clone.
Public property	IsComplete	Returns true if the object is complete (has all columns).
Protected property	IsDisconnected	Returns true if this collection is disconnected from the database
Public property	IsGlobal	Returns true if the object is global object. False if the object belongs to specific site only.
Protected property	IsCheckedOut	Indicates if the object is checked out.
Protected property	IsCheckedOutByUserID	Gets ID of the user who checked the object out.
Protected property	IsObjectValid	Returns true if the object is considered valid.
Public property	Item	Gets or sets the value of the column.
Protected property	LogEvents	If true, Events tasks are logged on the object update.
Protected property	LogExport	If true, export tasks are logged on the object update.
Protected property	LogIntegration	If true, integration tasks are being logged.
Protected property	LogSynchronization	Indicates how should be handled the logging of synchronization tasks on the object update.
Protected property	LogWebFarmTasks	If true, web farm tasks are logged on the object update.
Public property	MetaFiles	Collection of the metafiles belonging to the object.
Protected property	Name	Returns the code name of the object
Protected property	ObjectCategory	Object category.
Protected property	ObjectCodeName	Object code name.
Protected property	ObjectDisplayName	Object display name.
Protected property	ObjectFullName	Object full name if exists
Protected property	ObjectGroupID	Object community group ID.
Protected property	ObjectGUID	Object GUID.
Protected property	ObjectIcon	Object icon metafile.
Protected property	ObjectIconGUID	Object icon GUID.
Protected property	ObjectID	Object ID.
Protected property	ObjectIsCustom	Indicates if object is custom.
Protected property	ObjectIsCustomized	Indicates if object is customized.
Protected property	ObjectLastAccessed	Object last access time (uses internally by providers).
Protected property	ObjectLastModified	Last modified time.
Protected property	ObjectOrder	Returns the order of the object among the other objects.
Protected property	ObjectParent	Object parent.
Protected property	ObjectParentID	Object parent ID.
Public property	ObjectSettings	Object settings
Protected property	ObjectSite	Returns the object site.
Protected property	ObjectSiteID	Object site ID.
Protected property	ObjectSiteName	Object site name.
Protected property	ObjectStatus	Returns the current status of the object.
Protected property	ObjectThumbnail	Object thumbnail metafile.
Protected property	ObjectThumbnailGUID	Object thumbnail GUID.
Protected property	ObjectVersionGUID	Object version GUID.
Public property	OtherBindings	Collection of the binding objects for the given object.
Public property	Parent	Object parent
Protected property	ParentObjectType	Parent object type.
Protected property	PrioritizedProperties	Gets the list of properties which should be prioritized in the macro controls (IntelliSense, MacroTree).
Public property	Processes	Collection of the processes belonging to the object.
Public property	Properties	Properties of the object available through GetProperty.
Protected property	ReferringObjects	Collection of the objects depending on this object (object which have FK to this object).
Public property	RelatedData	Custom data connected to the object.
Public property	RelatedObjects	Related objects.
Public property	ScheduledTasks	Collection of the scheduled tasks belonging to the object.
Public property	Site	Object site
Protected property	SupportsVersioning	Indicates if the object versioning is supported. Default false
Public property	Thumbnail	Object thumbnail
Protected property	TouchCacheDependencies	If true, cache dependencies are touched when the object is changed.
Public property	TypeInfo	Object type information.
Protected property	UpdateTimeStamp	If true, timestamp of the object is updated when saved.
Protected property	ValidateCodeName	If true, the code name is validated upon saving.
Protected property	VersioningEnabled	Indicates if the object versioning is enabled by the settings.

Methods

	Name	Description
Protected method	AddColumnPrefixesWhereCondition	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 method Static member	AddDependencyDefaultDataWhereCondition	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 method	BuildObjectPath	Builds the path from the given column.
Public method Static member	Clear	Clears hashtable with cached properties of all object types.
Protected method	ClearCache	Clears the nested cached objects
Protected method	ClearCachedValues	Clears the cached values depending on the given column value.
Public method	ClearData	Clears data from the object.
Public method	CloneObject	Creates the clone of the object
Public method	CompareTo	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 method	ContainsColumn	Returns true if the object contains given column.
Protected method	CopyExternalColumns	Copy value of external columns directly via set value
Protected method	CopyMemoryProperties	Copies memory properties
Public method	DataChanged	Returns true if the object changed.
Public method	Delete	Deletes the object using appropriate provider
Protected method	DeleteExternalColumns	Goes through the columns which are stored externally and deletes all the files.
Protected method	DeleteObject	Deletes the object using appropriate provider.
Public method	Destroy	Destroys the object including its version history using appropriate provider
Protected method	Disconnect	Disconnects the collection from the database.
Protected method	EnsureBinaryData()	Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
Protected method	EnsureBinaryData(Boolean)	Makes sure that the binary data is loaded into binary column of the object.
Protected method	EnsureCodeName	Ensures the code name of the object if not set
Protected method	EnsureGUID	Ensures the GUID of the object
Protected method	EnsureHierarchyColumns	Ensures the IDPath and Level columns.
Protected method	EnsureLastModified	Ensures the last modified time stamp of the object
Protected method	EnsureUniqueCodeName	Ensures that the object has a unique code name within it's context
Protected method	ExecuteRemoveDependencyQuery	Executes given query text using specified connection string.
Public method	ExecuteWithOriginalData	Executes the given action using original data of the object
Protected method	ExportDefaultData	Exports the default object installation data
Protected method	Finalize	Destructor (Overrides Object.Finalize().)
Protected method	GetAutomaticCodeName	Gets the automatic code name for the object
Protected method	GetBinaryData	Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
Public method	GetBooleanValue	Gets the boolean value from the object.
Protected method Static member	GetClearCacheMethods	Gets the dictionary of methods for clearing the cache inside the info object [columnName] => [clearCacheAction]
Protected method	GetColumnNames	Gets the default list of column names for this class
Protected method	GetCount	Gets count of the objects filtered by given where condition.
Protected method	GetCurrentObjectPathPart	Builds the path from the given column.
Protected method	GetCustomProperties	Gets list of custom properties.
Protected method	GetData	Returns the data according to the set of input parameters.
Protected method	GetDataQueryInternal	Gets the data query for this object type
Public method	GetDateTimeValue	Gets the DateTime value from the object.
Protected method	GetDefaultData	Returns the default object installation data
Protected method	GetDefaultDataExportColumns	Returns names of all columns that should be exported with default data as a comma separated string.
Protected method	GetDefaultDataWhereCondition	Gets the where condition to filter out the default installation data
Protected method	GetDefaultObject	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 method	GetDependenciesNames	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 method	GetDependenciesNamesAuto	Returns a list of object names which depend on this object.
Protected method	GetDependencyCacheKeys	Gets the array of dependency cache keys for current object.
Public method	GetDependencyObjectType	Gets dependency object type
Protected method	GetDependentObjectsWhereConditions	Returns dictionary collection of where conditions selecting dependent objects for each dependent type.
Public method	GetDoubleValue	Gets the double value from the object.
Protected method	GetEditingPageURL	Gets the object editing page URL.
Protected method	GetExisting	Returns the existing object based on current object data.
Protected method	GetExistingBase	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 method	GetExistingWhereCondition()	Gets a where condition to find an existing object based on current object
Protected method	GetExistingWhereCondition(Boolean)	Gets a where condition to find an existing object based on current object
Protected method	GetExternalColumns	Returns the list of columns registered as the external columns.
Protected method	GetExternalFiles	Goes through the columns which are stored externally and returns the list of particular files this object uses.
Protected method	GetFullObjectName	Returns the name of the object within its parent hierarchy.
Protected method	GetGeneralizedInfo	Gets the generalized info for this object
Protected method	GetGlobalPermissionName	Returns name of the global permission name corresponding to the given permission name. By default, "Global" + permissionName is returned.
Protected method	GetGroupWhereCondition	Gets the group where condition for the object
Public method	GetGuidValue	Gets the guid value from the object.
Protected method	GetChildDependencies	Gets the child dependencies repository
Protected method	GetChildWhereCondition	Gets the child object where condition.
Protected method	GetIconUrl(Page, String)	Gets the object icon URL
Protected method	GetIconUrl(Int32, Int32, Int32)	Gets the object icon URL
Protected method	GetIDPathPartLength	Returns the length of a part of IDPath.
Public method	GetIntegerValue	Gets the integer value from the object.
Protected method	GetLastObjectOrder	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 method	GetLockObject	Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
Protected method	GetModifiedFrom	Gets the DataSet of all the objects modified from specified date.
Protected method	GetNameCollisions	Gets the list of the name collisions of the given object
Protected method	GetNamePathPartColumn	Returns the name of the column which is used to build the NamePath
Protected method	GetObject	Gets the object by specified where condition.
Public method	GetObjectData	Object serialization.
Protected method	GetObjectChildren	Gets the object children repository
Protected method	GetObjectIdentifier	Gets the object identifier that uniquely identifies the object
Protected method	GetObjectKey	Gets the unique string key for the object.
Protected method	GetObjectName	Returns object name combining object type name and object display name.
Protected method	GetObjectOrderID	Returns ID of the item being ordered. By default return ObjectID. This is overridden in TreeNode, where NodeID has to be supplied.
Protected method	GetObjectTypeForColumn	Gets the object type for the given column or null if the object type is not found or unknown.
Protected method	GetOrderIdentityWhereCondition	Gets order identity where condition to identify the object to be ordered
Protected method	GetOrderQueryParameters	Creates QueryDataParameters with special macros for object order management.
Public method	GetOriginalValue	Returns the original value of column.
Protected method	GetOtherBindings	Gets the repository of other bindings
Protected method	GetParent	Returns the parent object.
Protected method	GetPermissionName	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 method	GetPermissionObjectType	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 method	GetPermissionToCheck	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 method	GetPhysicalFiles	Gets DataSet with physical files.
Public method	GetProperty	Gets the property value.
Protected method	GetPropertyType	Gets the type of the given property
Protected method	GetReferringObjects	Gets the repository of depending objects
Protected method	GetRegisteredProperties	Gets list of registered properties.
Public method	GetSearchID	Gets the id column value which is used as search id by default.
Protected method	GetSiblingsQueryInternal	Gets the parameterized query to get siblings of the object (If there is no parent-child hierarchy, query is parameterized for all objects)
Protected method	GetSiblingsWhereCondition	Creates where condition according to Parent, Group and Site settings.
Protected method	GetSiteWhereCondition	Gets the site where condition for the object
Public method	GetStringValue	Gets the string value from the object.
Protected method	GetSynchronizedColumns	Gets the list of synchronized columns for this object or null if all columns are synchronized
Protected method	GetThumbnailUrl	Gets the object thumbnail URL
Protected method	GetUniqueCodeName	Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Protected method	GetUniqueDisplayName	Returns the unique display name for the specified object.
Protected method	GetUniqueName	Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Protected method	GetUniqueNameWhereCondition	Constructs base where condition for checking column value uniqueness. This method can be overridden in child classes to add more conditions.
Public method	GetValue	Gets the object value.
Protected method	GetValueForTranslation	Returns value for translation services. Returns unmodified field content by default.
Protected method	GetVirtualFileRelativePath	Returns virtual relative path for specific column Ensures the GUID of the object
Public method	ChangedColumns	Returns list of column names which values were changed.
Protected method	CheckDefaultPermissions	Check universal permissions for an object
Protected method	CheckDependencies	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 method	CheckLicense	Checks the object license. Returns true if the licensing conditions for this object were matched.
Public method	CheckPermissions	Checks whether the specified user has permissions for this object.
Protected method	CheckPermissionsInternal	Checks whether the specified user has permissions for this object. This method is called automatically after CheckPermissions event was fired.
Protected method	CheckPermissionsWithHandler	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 method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name.
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
Protected method	InitObjectsOrder	Inits the proper order of the sibling objects so the order column is consistent.
Protected method	InitObjectsOrderPostprocessing	Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization.
Public method	Insert	Inserts the object using appropriate provider
Protected method	InsertAsClone	Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
Protected method	InsertAsCloneInternal	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 method	InsertAsClonePostprocessing	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 method	Invalidate	Invalidates the object in the object table.
Protected method	IsAvailableOnSite	Checks whether info object as available on given site. Available means that object is global or assigned to given site.
Protected method	IsCheckedOutByUser	Returns true if the object is checked out by the specified user.
Protected method	IsChildOf	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 method	IsModifiedExternally	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 method	IsObjectInvalid	Returns true if the object is invalid.
Public method	ItemChanged	Returns true if the item on specified column name changed.
Protected method	LoadData	Loads the object using the given settings
Public method	MacroRepresentation	By default, BaseInfo has no special macro representation.
Public method	MakeComplete	Makes the object data complete.
Protected method	NewObject	Creates new object of the given class based on the given settings
Protected method	PermissionCheckException	Fires an exception in case authorization result is false (denied or insignificant)
Public method	Property<PropertyType>	Returns the extension property for the object (Inherited from AbstractObject.)
Protected method	Reconnect	Reconnects the collection to the database.
Protected method	RemoveObjectDependencies	Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
Public method	ResetChanges	Resets the object changes and keeps the new values as unchanged according to the asUnchanged parameter.
Protected method	RestoreSettings	Restores local settings for object instance.
Public method	RevertChanges	Reverts the object changes to the original values.
Protected method	SaveExternalColumns	Goes through the columns which are stored externally and ensures them in the external storage.
Protected method	SerializationNotSupported	Throws serialization not supported exception
Protected method	SetObject	Updates the object using appropriate provider.
Protected method	SetObjectAlphabeticalOrder	Moves the object to the right position according to the custom order.
Protected method	SetObjectOrder	Moves the object to the specified order. The move is done within the object's siblings.
Protected method	SetObjectOrderPostprocessing	Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
Protected method	SetParent	Updates the parent object, enables to update the data that is overridden in the parent object before or after it is saved
Public method	SetValue(String, Object)	Sets the object value.
Public method	SetValue(String, Object, Boolean)	Sets the object value to the nullable column.
Public method	SetValue(String, Object, Object)	Sets the object value to the nullable column.
Protected method	SortAlphabetically	Sort objects alphabetically.
Protected method	StoreSettings	Stores local settings for object instance.
Public method	SubmitChanges	Submits the changes in the object to the database.
Public method	ToMacroString	Returns the default text representation in the macros.
Public method	ToString	Returns the text representation of the object (Overrides Object.ToString().)
Protected method	TouchParent	Updates the parent object by saving it (to update the timestamp).
Public method	TryGetProperty(String, Object)	Returns value of property.
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property.
Public method	TryGetValue	Returns value of column.
Public method	Update	Updates the database entity using appropriate provider
Protected method	UpdateExternalColumns	Goes through the columns which are stored externally and updates DB versions with the data from external storage.
Protected method	UpdateFromDB	Updates the data of the object from DB (updates also ObjectSettings).
Protected method	UpdatePhysicalFiles	Saves physical files.
Protected method	WriteDefaultData	Writes the default object installation data into xml file

Operators

	Name	Description
Public operator Static member	Implicit(BaseInfo to GeneralizedInfo)	Implicit operator for conversion from BaseInfo class to GeneralizedInfo
Public operator Static member	Implicit(GeneralizedInfo to BaseInfo)	Implicit operator for conversion from GeneralizedInfo class to BaseInfo

Extension Methods

	Name	Description
Public Extension Method	Compare	Compares two BaseInfo objects (data & structure) according to comparison settings given. (Defined by DataExtensions.)
Public Extension Method	CopyTo	Copies the data of specified columns of the source object to the target object. (Defined by DataExtensions.)
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	Serialize	Returns object data serialized into the XML element. (Defined by SerializationExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)