ObjectTypeInfo Class

Object type info structure.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<ObjectTypeInfo>
    CMS.Base.AbstractDataContainer<ObjectTypeInfo>
      CMS.Base.AbstractHierarchicalObject<ObjectTypeInfo>
        CMS.DataEngine.ObjectTypeInfo
          CMS.DataEngine.DynamicObjectTypeInfo

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

Syntax

[SerializableAttribute]
public class ObjectTypeInfo : AbstractHierarchicalObject<ObjectTypeInfo>

The ObjectTypeInfo type exposes the following members.

Constructors

	Name	Description
Public method	ObjectTypeInfo(String, ObjectTypeInfo)	Constructor.
Public method	ObjectTypeInfo(Type, String, String, String, String, String, String, String, String, String, String, String)	Constructor.

Methods

	Name	Description
Public method	AddDependencies	Adds object dependencies to the existing ones.
Public method	AddNewInstance	Obsolete. Registers a new object instance
Public method	ApplyTypeCondition	Applies condition defined in TypeCondition property to the given info. Returns info without changes if TypeCondition is null.
Public method	AreChildrenInvalid	Returns true if the direct child objects are invalid.
Public method	Clone	Returns clone of type info where all the properties are copied.
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Protected method	CopyEventsTo	Copies the event's hooks from current ObjectTypeInfo to specified one.
Public method	GetBindingColumns	Gets the list of columns representing binding
Public method	GetBindingWhereCondition	Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
Public method	GetDependencyForColumn	Gets the dependency settings for the given column or null if the settings is not found or unknown.
Public method	GetDependencyWhereCondition(String, String, Object[])	Obsolete. Gets the where condition to limit the objects to specific dependencies.
Public method	GetDependencyWhereCondition(String, String, Tuple<String, Nullable<Int32>>[])	Gets the where condition to limit the objects to specific dependencies.
Public method Static member	GetFirstKnownColumn	Gets the first known column from the given list of columns
Public method	GetInstances	Obsolete. Gets the list of instances of the objects.
Public method	GetNiceObjectTypeName	Gets the nice objext type name for this type
Public method	GetObjectPathWhereCondition	Gets the where condition to limit the objects to specific path.
Public method	GetObjectTypeForColumn	Gets the object type for the given column or null if the object type is not found or unknown.
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetSiteWhereCondition	Gets the where condition to limit the objects to specific site.
Public method	GetTypeColumns	Returns the column names of specified object type, separated by semicolon.
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasEvents	Returns true if this type info has some events
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	CheckTypeCondition	Checks if condition defined in TypeCondition is not violated by the given info.
Public method	ChildrenInvalidated	Invalidates direct child objects of specific parent.
Public method	IncludeToParentDataSet	Gets value of appropriate include to parent data set property due to operation.
Public method	InvalidateAllObjects()	Invalidates all objects of this type.
Public method	InvalidateAllObjects(Boolean)	Invalidates all objects of this type.
Public method	InvalidateColumnNames()	Invalidates column names.
Public method	InvalidateColumnNames(Boolean)	Invalidates column names.
Public method	IsDynamicDependency	Obsolete. Indicates if dependency object type id dynamic
Public method	IsForeignKey	Indicates if given column is foreign key.
Public method	IsObjectInvalid	Returns true if the object is invalid.
Public method Static member	MergeTypeInfos	Merges two or more type infos. Single valued properties are taken from the first type info, list properties are merged from all the participating typeinfos.
Public method	ObjectInvalidated	Invalidates specific object.
Public method	RaiseOnLoadRelatedData	Raises the on load related data event.
Public method	RaiseOnLogObjectChange	Raises the OnLogObjectChange event.
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	RemoveInstance	Obsolete. Removes a new object instance from the list
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	ToJSON	Returns JSON representation of TypeInfo instance.
Public method	ToXML	Returns XML representation of TypeInfo instance.
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	COLUMN_NAME_UNKNOWN	Uknown column name.
Public field Static member	VALUE_UNKNOWN	Uknown value.

Properties

	Name	Description
Public property	AllowDataExport	Specifies whether the object supports data export. By default the value is true for all objects except binding objects.
Public property Static member	AllowObjectRelationships	If true, object relationships are allowed.
Public property	AllowPostProcessing	Indicates if object allows post-processing during the import and staging process.
Public property	AllowRestore	Indicates if the object supports deleting to recycle bin. By default the value is true for all objects except binding objects.
Public property	AllowTouchParent	Indicates if parent is allowed to be touched, if exists. Default is true.
Public property	AssemblyNameColumn	Name of the column with assembly name.
Public property	BinaryColumn	Binary column name of the info record.
Public property	BindingObjectTypes	Binding object types, list of object types separated by semicolon.
Public property	CategoryIDColumn	Category ID column name.
Public property	CategoryObject	Empty read-only instance of the category object (if this type has a category object) For example settings key will have a SettingsCategoryInfo object here.
Public property	ClassStructureInfo	Class structure information. If not set explicitly, it is retrieved automatically by class name.
Public property	CodeColumn	Name of the column that contains code of the object (markup).
Public property	CodeNameColumn	Code name column name of the info record.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	ColumnsInvalidated	Indicates whether column names are invalidated. Default is false.
Public property	ConsistsOf	Defines the list of object TypeInfos that are part of this wrapper object. If the object is not a wrapper, this property is not initialized.
Public property	ContainsMacros	Indicates if the object may contain some macros in it's values. Default is true.
Public property	CSSColumn	Name of the column that contains CSS of the object.
Public property	CustomizedColumnsColumn	Column name which contains customized columns.
Public property	DefaultData	Default data exported within installation.
Public property	DefaultOrderBy	Default order by clause for getting data.
Public property	DeleteAsDependency	Indicates if object should be deleted when removing dependencies of other object.
Public property	DeleteObjectWithAPI	If true, the object is always deleted using API methods in the remove dependencies phase, not the generated queries. Use for objects where additional actions are performed during deletion. Default is false.
Public property	DependsOn	List of objects this object depends on (foreign keys definition of the object with the exception of SiteID column and ParentID columns to the objects which are directly visible via reference, for the foreign keys of objects of other modules not visible by this module, use Extends property in those object to define the foreign key in this object).
Public property	DisplayNameColumn	Display name column name of the info record.
Public property	EnabledColumn	Name of the column which determines whether the object is enabled or disabled within the system.
Public property	Events	Events handled by object of this type
Public property	Extends	List of columns which which this object extends other objects as a foreign key.
Public property	ExtensionColumn	File extension column (for objects with binary column - column which specifies extension type of binary data).
Public property	Feature	Get/sets info's feature for license check
Public property	FormDefinitionColumn	Form definition column name
Public property Static member	GlobalLogSynchronization	If true, object tasks are logged.
Public property	GroupIDColumn	Community group ID column name of the info record, returns specific column if the object can be also group object.
Public property	GUIDColumn	GUID column.
Public property	HasAutomaticProperties	If true, the object of this type has got some automatic properties
Public property	HasExternalColumns	If true, the object has externally stored columns. Default is false.
Public property	HasMetaFiles	If true, the objects can have meta files. By default no metafiles to simplify general processes
Public property	HasObjectRelationships	If true, the objects can have relationships to other objects. By default no relationships to simplify general processes.
Public property	HasObjectSettings	Indicates if the object can have object settings. Default is false.
Public property	HasProcesses	If true, the processes can be run on the objects. By default no processes to simplify general processes.
Public property	HasScheduledTasks	If true, the scheduled tasks can be run on the objects. By default no scheduled tasks to simplify general processes.
Public property	CheckDependenciesOnDelete	If true, the CheckDependencies procedure is first called within the remove dependencies procedure and if there are some, the remove dependencies procedure throws and exception and does not continue.
Public property	CheckPermissions	Determines whether the permissions should be checked when the object is accessed within the macro engine as an inner object. Default is true.
Public property	ChildDependencyColumns	Name of the columns (separated by semicolon) of object dependencies which should be included into the parent data (for example class data for BizForms).
Public property	ChildObjectTypes	Child object types, list of object types separated by semicolon.
Public property	IconGUIDColumn	Name of the column that contains the GUID of the object icon meta file.
Public property	IconMetaFileGroup	Name of the meta file group of the icon meta file.
Public property	IDColumn	ID column.
Public property	ImportExportSettings	Import/export settings.
Public property	IncludeToSynchronizationParentDataSet	If false, the object is not included in the parent DataSet (for synchronization).
Public property	IncludeToVersionParentDataSet	Indicates if the objects should be included in version data set of it's parent
Public property	InfoType	Info class type
Public property	Inherited	Indicates if the type info is inherited (list info for example).
Public property	InstanceCount	Gets the number of registered isntances.
Public property	IsBinding	Returns true if the object is binding. Set forces the object to behave as binding.
Public property	IsCategory	Returns true if object is category type. Default is false.
Public property	IsCustomColumn	Column name of the info record for flag IsCustom.
Public property	IsDataObjectType	Indicates if the object is dynamic based on data in the DB (e.g. custom table item or biz form item objecttypes).
Public property	IsMainObject	Indicates if the object is main (= is not child of other objects).
Public property	IsMultipleBinding	Indicates if the object is binding between more than two objects.
Public property	IsSelfBinding	Returns true if the binding is binding to the same object as parent.
Public property	IsSiteBinding	Returns true if the object is site binding.
Public property	IsSiteObject	Returns true if the object is site
Public property	IsTriggerTarget	If true, the object can be targeted by triggers. Default is false.
Public property	IsVirtualObject	Indicates if object is stored in DB or only in memory. If true, object is stored in memory and cannot be queried by SQL. Default is false.
Public property	IsWrapper	Returns true if object is wrapper. Object consists of several partial objects.
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	LastObjectInvalidated	Last time of the object invalidation.
Public property	LogEvents	If true, Events tasks are logged on the object update. Default is false.
Public property	LogIntegration	If true, integration tasks are being logged. Default is true.
Public property Static member	LogSiteBindings	If true, object tasks are logged when site binding changes.
Public property	LogSynchronization	If true, synchronization tasks are logged on the object update.
Public property	MaxCodeNameLength	Maximum length of the object code name.
Public property	MimeTypeColumn	Mime type column (for objects with binary column - column which specifies mime type of binary data).
Public property	ModuleInfo	Returns ModuleInfo object retrieved by ModuleName.
Public property	ModuleName	Name of the module where the object belongs.
Public property	Name	Object type name, if not set, ObjectClassName is returned.
Public property	NameGloballyUnique	If true, the object code name must be unique both per site, and through global objects. If false, the name is unique per site only. Default is false.
Public property	NestedInfoTypes	List of nested info object types that contain the data internally
Public property	ObjectClassName	Object class name.
Public property	ObjectDependencies	Object dependencies (list of foreign keys definition of the object with the exception of SiteID column and ParentID columns). Automatically computed from Extends and DependsOn lists of all objects within the system.
Public property	ObjectIDPathColumn	ID path column name of the info record, returns specific column if the object has hierarchical structure.
Public property	ObjectLevelColumn	Object level column. If the object has hierarchical structure, determines the depth within the tree.
Public property	ObjectNamePathColumn	Name path column name of the info record, returns specific column if the object has hierarchical structure.
Public property	ObjectPathColumn	Path column name of the info record, returns specific column if the object has hierarchical structure.
Public property	ObjectType	Object type.
Public property	OrderColumn	Order column name of the info record.
Public property	OriginalObjectType	Original object type of virtual object types. For normal object type it's same as object type.
Public property	OriginalTypeInfo	Original object type of virtual object types. For normal object type it's same as object type.
Public property	OtherBindingObjectTypes	Other binding types (ObjectType constants separated by semicolon) - binding types where this object participate but is not parent object of those binding types.
Public property	ParentIDColumn	Parent ID column name of the info record, returns specific column if the object is child object (has parent).
Public property	ParentObjectType	Parent object type.
Public property	ParentTypeInfo	Parent type information of the info record if the object is child object (has parent).
Public property	PossibleParentIDColumn	Possible parent ID column name of the info record in case the parent ID column is optional (if the object can be both global and child).
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	ProviderIsCustomizable	Indicates if provider supports methods customization
Public property	ProviderObject	Returns the provider object for this type info.
Public property	ProviderType	Provider type.
Public property	ReferenceColumnNames	Names of the columns that reference some object.
Public property	RegisterAsBindingToObjectTypes	If set (= not null), than the automatic process of registering the object type in the BindingObjectTypes list is bypassed and the registration is forced to the specified types in this list.
Public property	RegisterAsChildToObjectTypes	If set (= not null), than the automatic process of registering the object type in the ChildObjectTypes list is bypassed and the registration is forced to the specified types in this list.
Public property	RegisterAsOtherBindingToObjectTypes	If set (= not null), than the automatic process of registering the object type in the OtherBindingObjectTypes list is bypassed and the registration is forced to the specified types in this list.
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	RelatedTypeInfos	Returns list of related TypeInfos of this TypeInfo (the relationship is made from OriginalTypeInfo property, but reflects the relationship from both sides).
Public property	RememberUniGridState	Indicates whether UniGrids working with objects of this type will remember their state, i.e., filter, page number, page size and sorting order.
Public property	RequiredObject	If true, the object is required when imported / synchronized. If false, the object can be skipped when some error occurs. Default is true.
Public property	ResourceIDColumn	Resource ID column name of the info record, returns specific column if the object is dependant on a resource.
Public property	SearchContentColumn	Column which stores cached content extracted for this Info object to be used in search indexing. Used by the method EnsureSearchContent.
Public property	SensitiveColumns	List of column names which are sensitive from the privacy point of view (i.e. UserPassword, etc.). Those columns are automatically excluded from macro engine and REST.
Public property	SiteBinding	Site binding object type (if exists).
Public property	SiteBindingObject	Site binding object (if exists).
Public property	SiteIDColumn	Site ID column name of the info record.
Public property	SizeColumn	File size column (for objects with binary column - column which specifies size of the binary data).
Public property	SupportsCloneToOtherSite	Indicates if object can be cloned to different site than the site of the original. Default is true.
Public property	SupportsCloning	Indicates if object can be cloned. Default is true.
Public property	SupportsGlobalObjects	If true, object can be either site or global (for example poll). Default is false.
Public property	SupportsInvalidation	If true, the object is automatically invalidated upon it's change. Default is false.
Public property	SupportsLocking	Indicates is the object supports locking (check-in / check-out). Default is false.
Public property	SupportsSearch	Indicates if object can be searched. Default is true for main objects.
Public property	SupportsVersioning	Indicates if the object versioning is supported. Default is false.
Public property	SynchronizationObjectTreeLocations	Object tree locations for synchronization
Public property	ThumbnailGUIDColumn	Name of the column that contains the GUID of the object thumbnail meta file.
Public property	ThumbnailMetaFileGroup	Name of the meta file group of the thumbnail meta file.
Public property	TimeStampColumn	Time stamp column.
Public property	TouchCacheDependencies	If true, cache dependencies are touched when the object is changed. Default is false.
Public property Static member	TrackObjectInstances	If true, object instances are tracked.
Public property	TypeCondition	Condition which can distinguish between several object types within one Info class. This is used for two purposes - first to generate correct type WHERE condition which is used in GetData (for example) and for correct object initialization when creating empty BaseInfo objects for specified object type. If you need to specify more complex WHERE condition, use property WhereCondition which has higher priority.
Public property	UpdateTimeStamp	If true, timestamp of the object is updated when saved.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	VersionGUIDColumn	Name of the column that contains the version GUID of the object.
Public property	WhereCondition	Default where condition restricting the data of this particular object type.
Public property	WrapperObjectType	Wrapper object type - type of the object which is is a wrapper for this object type.

Events

	Name	Description
Public event	OnLoadRelatedData	Fires when the related data should be loaded to the object.
Public event Static member	OnLogGlobalObjectChange	Fires when the object change should be logged - Global handler
Public event	OnLogObjectChange	Fires when the object change should be logged - Handler for particular type info