Click or drag to resize
ObjectTypeInfo Properties

The ObjectTypeInfo type exposes the following members.

Properties
  NameDescription
Public propertyAllowDataExport
Indicates whether the system allows users to export the object type's data into files of various formats from listings (UniGrid). True by default for all objects except for binding objects.
Public propertyAllowRestore
Determines whether the system stores deleted objects of the type in the recycle bin. By default the value is true for all objects with allowed synchronization or versioning except for binding objects.
Public propertyAllowTouchParent
Indicates if parent is allowed to be touched, if exists. Default is true.
Public propertyAssemblyNameColumn
The name of the class field (column) that stores the assembly name of a related class in the project's code.
Public propertyBinaryColumn
The name of the class field (column) that stores binary data for objects.
Public propertyBindingObjectTypes
Gets list of binding object types.
Public propertyCategoryIDColumn
Category ID column name.
Public propertyCategoryObject
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 propertyCheckDependenciesOnDelete
If true, the system prevents objects of the type from being deleted if they are the target of a required reference for at least one other object in the system. Applies to object types that are the target of a Required type reference from another object type. The CheckDependencies procedure is first called within the remove dependencies procedure and if there are some, the remove dependencies procedure throws an exception and does not continue.
Public propertyCheckPermissions
Determines whether the system checks read permissions for the given module when accessing objects of the type in the macro engine. True by default. The permissions are checked for the user who saved the macro, not the user viewing the result.
Public propertyChildDependencyColumns
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 propertyChildObjectTypes
Gets list of child object types.
Public propertyClassStructureInfo
Class structure information. If not set explicitly, it is retrieved automatically by class name.
Public propertyCodeColumn
Name of the column that contains code of the object (markup).
Public propertyCodeNameColumn
The name of the class field (column) that stores the unique text identifiers of objects. Can be null for object types without a dedicated code name column.
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyColumnsInvalidated
Indicates whether column names are invalidated. Default is false.
Public propertyCompositeObjectType
Composite object type - type of the object which is a composite object for this object type.
Public propertyConsistsOf
Defines the list of object types that are part of this composite object. If the object is not a composite object, this property is not initialized.
Public propertyContainsMacros
Indicates whether the object type has fields that can contain macro expressions in their values. Determines if objects are processed when resigning macros in the system. True by default. You can set the value to False to optimize the performance of the resigning process (during manual resigning and upgrades). Does not affect the resolving of macros.
Public propertyContinuousIntegrationSettings
Determines how the object behaves within continuous integration. Set through the properties of the ContinuousIntegrationSettings class.
Public propertyCSSColumn
Name of the column that contains CSS of the object.
Public propertyCustomizedColumnsColumn
The name of the class field (column) that contains customized columns.
Public propertyDefaultData
Default data exported within installation. Affects default data and web template data export.
Public propertyDefaultOrderBy
Default order by clause for getting data.
Public propertyDeleteAsDependency
Indicates if object should be deleted when removing dependencies of other object.
Public propertyDeleteObjectWithAPI
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 propertyDependsOn
List of ObjectDependency instances that define references (foreign keys) pointing to other objects that are directly visible. Allows the system to maintain referential integrity of relationships when importing or staging objects, or perform chain deleting of objects together with referenced objects. Do not include site or parent references that are specified by the SiteIDCOlumn and ParentIDColumn properties.
Public propertyDependsOnIndirectly
List of object types on which this object type depends on indirectly. Indirectly means there is no column with reference pointing to object of specified object type. Allows the system to maintain chain of dependencies between object types. Do not include direct dependencies like parent, site or dependencies specified by DependsOn.
Public propertyDisplayNameColumn
The name of the class field (column) that stores the visible names of objects (names used in the administration interface or on the live site).
Public propertyEnabledColumn
The name of the class field (column) that indicates whether objects are enabled or disabled.
Public propertyEvents
Events handled by object of this type
Public propertyExtends
List of ExtraColumn instances that extend other object types by defining a reference (foreign key) pointing to this object type. Allows the system to maintain referential integrity of relationships when importing or staging objects, or perform chain deleting of objects together with referenced objects.
Public propertyExtensionColumn
Intended for object types that store binary data. Sets the name of the class field (column) that stores the extension type of the binary data.
Public propertyFeature
Get/sets info's feature for license check
Public propertyFormDefinitionColumn
Form definition column name
Public propertyStatic memberGlobalLogSynchronization
If true, object tasks are logged.
Public propertyGroupIDColumn
The name of the class field (column) that stores group IDs for objects related to specific community groups.
Public propertyGUIDColumn
The name of the class field (column) that stores the GUID identifiers of objects.
Public propertyHasAutomaticProperties
If true, the object of this type has got some automatic properties
Public propertyHasExternalColumns
If true, the object has externally stored columns. Default is false.
Public propertyHasMetaFiles
If true, the objects can have meta files. By default no metafiles to simplify general processes
Public propertyHasObjectSettings
Indicates if the object can have object settings. Default is false.
Public propertyHasProcesses
If true, the processes can be run on the objects. By default no processes to simplify general processes.
Public propertyHasScheduledTasks
If true, the scheduled tasks can be run on the objects. By default no scheduled tasks to simplify general processes.
Public propertyIconGUIDColumn
Name of the column that contains the GUID of the object icon meta file.
Public propertyIconMetaFileGroup
Name of the meta file group of the icon meta file.
Public propertyIDColumn
The name of the class field (column) that stores the IDs of objects (i.e. the primary key column). Can be null in rare cases, for example binding objects without an identity column.
Public propertyImportExportSettings
Defines how the object type works with the Export and Import features. Set through the properties of the ImportExportSettings class.
Public propertyIncludeToVersionParentDataSet
Determines if objects of the given type are included in the version data of parent objects. True by default.
Public propertyInstanceCount
Gets the number of registered isntances.
Public propertyIsBinding
Indicates whether the object type represents a relationship between two or more object types. Setting to true forces the object type to behave as a binding.
Public propertyIsCategory
Indicates whether the object type represents a category for organizing other objects in a tree hierarchy (for example web part categories). The default value is false.
Public propertyIsComposite
Returns true if object is a composite object. Object consists of several partial objects.
Public propertyIsCustomColumn
Column name of the info record for flag IsCustom.
Public propertyIsDataObjectType
Indicates if the object is dynamic based on data in the DB (e.g. custom table item or biz form item object types).
Public propertyIsListingObjectTypeInfo
Indicates if the object type info is used as read-only data source for listing controls such as grids or selectors.
Public propertyIsMainObject
Indicates if the object is main (= is not child of other objects).
Public propertyIsMultipleBinding
Indicates if the object is binding between more than two objects.
Public propertyIsSelfBinding
Identifies binding classes that connect two objects of the same type = the binding's parent type is the same as the object dependency type
Public propertyIsSiteBinding
Returns true if the object is site binding.
Public propertyIsSiteObject
Returns true for site-related object types. is true if the SiteIDColumn or GroupIDColumn property is set in the type information, or if the object type has a site-related parent.
Public propertyIsTriggerTarget
If true, the object can be targeted by triggers. Default is false.
Public propertyIsVirtualObject
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 propertyItem
Gets the value of particular property
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyLastObjectInvalidated
Last time of the object invalidation.
Public propertyLogEvents
Indicates whether the system logs events into the Event log when objects of the type are updated. False by default.
Public propertyLogIntegration
Determines whether the system logs integration bus synchronization tasks for objects of the type. True by default.
Public propertyStatic memberLogSiteBindings
If true, object tasks are logged when site binding changes.
Public propertyMacroCollectionName
Gets or sets name of object collection used for the object type's data in the macro engine. If not set, the ObjectClassName is used by default.
Public propertyMaxCodeNameLength
Maximum length of the object code name.
Public propertyMimeTypeColumn
Intended for object types that store binary data. Sets the name of the class field (column) that stores the mime type of the binary data.
Public propertyModuleInfo
Gets the ModuleInfo object based on the value of the ModuleName property.
Public propertyModuleName
The code name of the module under which the object type belongs. Always required for all object type information definitions.
Public propertyNameGloballyUnique
If true, the system validates the code names of objects to be unique across both global and site-related objects. If false, global objects can have the same code name as a site-specific object. The default value is false. Applies to object types with a specified SiteIDColumn that also have the SupportsGlobalObjects property set to true.
Public propertyNestedInfoTypes
List of nested info object types that contain the data internally
Public propertyObjectClassName
The code name assigned to the matching module class in the Kentico administration interface. Identifies the object types's definition in the database. Required for all object types.
Public propertyObjectDependencies
Object dependencies (list of foreign keys definition of the object with the exception of SiteID column and ParentID columns). Automatically computed from DependsOn and Extends lists of all objects within the system.
Public propertyObjectIDPathColumn
Intended for objects that have a hierarchical tree structure. Sets the name of the class field (column) that stores the path of objects in the hierarchy structure, consisting of object IDs.
Public propertyObjectLevelColumn
Intended for objects that have a hierarchical tree structure. Sets the name of the class field (column) that stores the depth of objects in the hierarchy structure.
Public propertyObjectNamePathColumn
Intended for objects that have a hierarchical tree structure. Sets the name of the class field (column) that stores the path of objects in the hierarchy structure, consisting of object names.
Public propertyObjectPathColumn
Intended for objects that have a hierarchical tree structure. Sets the name of the class field (column) that stores the path of objects in the hierarchy structure. You can also set the path column separately for paths built out of objects names or object IDs through the ObjectNamePathColumn and ObjectIDPathColumn properties.
Public propertyObjectType
The primary identifier string for the object type. This identifier is used to select object types in the API, user interface components (UniGrid, UniSelector), REST calls, etc. Required for all object types.
Public propertyOrderColumn
The name of the class field (column) that stores the order of objects (for object types that have a defined order). Allows automatic actions for changing object order on listing pages (in UniGrid components).
Public propertyOriginalObjectType
Original object type of virtual object types. For normal object type it's same as object type.
Public propertyOriginalTypeInfo
Original object type of virtual object types. For normal object type it's null.
Public propertyOtherBindingObjectTypes
Gets list of other binding types - binding types where this object participate but is not parent object of those binding types.
Public propertyParentIDColumn
The name of the class field (column) that stores the IDs of parent objects. Null for object types without a parent object.
Public propertyParentObjectType
The object type name of the parent (as defined in the type information of the parent object type). Null for object types without a parent object.
Public propertyParentTypeInfo
Gets the ObjectTypeInfo instance representing the parent object type.
Public propertyPossibleParentIDColumn
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 propertyProperties
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyPropertyList
Used property list
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyProviderIsCustomizable
Indicates if provider supports methods customization
Public propertyProviderObject
Gets an instance of the provider class set for the object type (specified by the ProviderType property).
Public propertyProviderType
The type of the object's InfoProvider class. Required for all object types.
Public propertyReferenceColumnNames
Names of the columns that reference some object.
Public propertyRegisterAsBindingToObjectTypes
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 propertyRegisterAsChildToObjectTypes
If set (= not null), then the automatic process of registering the object type in the ChildObjectTypes list is bypassed and the registration is forced to the types specified in this list. Only use if you need to register multiple parent types (if the parent has multiple type info definitions).
Public propertyRegisterAsOtherBindingToObjectTypes
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 propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredProperties
Registered properties
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredPropertiesObject
Registered properties object
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyRelatedTypeInfos
Returns list of related TypeInfos of this TypeInfo (the relationship is made from OriginalTypeInfo property, but reflects the relationship from both sides).
Public propertyRememberUniGridState
Indicates whether listing pages (UniGrids) that display the object type's data remember the listing state for individual users The listing state includes filtering options, page number, page size and item order.
Public propertyRequiredObject
If true, the object is required when imported / synchronized. If false, the object can be skipped when some error occurs. Default is true.
Public propertyResourceIDColumn
The name of the class field (column) that stores ID referencing a module (resource) in Kentico. Intended for object types whose objects have a relationship with a specific module.
Public propertySearchContentColumn
The name of the class field (column) that stores cached content extracted for this Info object to be used in search indexing.
Public propertySensitiveColumns
Specifies a list of class fields (columns) that the system excludes from the macro engine, data retrieved by the REST service and event logging. Can be used to protect fields with sensitive values, for example passwords.
Public propertySerializationSettings
Determines how the system serializes objects of the given type from the database into XML files. Set through the properties of the SerializationSettings class.
Public propertySiteBinding
Gets the object type name of the binding class that stores relationships between the given class and sites (if such a site binding class exists).
Public propertySiteBindingObject
Gets the Info class of the binding class that stores relationships between the given class and sites (if such a site binding class exists).
Public propertySiteIDColumn
The name of the class field (column) that stores site IDs for site-related objects. Only use the site ID column if the object does not have a separate binding object type for the site relationship.
Public propertySizeColumn
Intended for object types that store binary data. Sets the name of the class field (column) that stores the size of the binary data.
Public propertySupportsCloneToOtherSite
Indicates whether objects of the type can be cloned to a different site than the site of the original object. True by default. Applies to object types with a specified SiteIDColumn.
Public propertySupportsCloning
Indicates whether the system allows cloning for objects of the given type. True by default.
Public propertySupportsGlobalObjects
If true, the system allows both site-related objects and global objects whose value in the site ID column is null (for example polls). Applies to object types with a specified SiteIDColumn. False by default. Must be true if you wish to use export or staging for global objects of the given type.
Public propertySupportsInvalidation
If true, the object is automatically invalidated upon it's change. Default is false.
Public propertySupportsLocking
Determines whether the object type supports object locking (check out and check in). The default value is false.
Public propertySupportsSearch
Indicates if object can be searched. Default is true for main objects.
Public propertySupportsVersioning
Determines whether the object type supports object versioning. The default value is false.
Public propertySynchronizationSettings
Defines how Staging features work with the object type's data. Set through the properties of the SynchronizationSettings class.
Public propertyThumbnailGUIDColumn
Name of the column that contains the GUID of the object thumbnail meta file.
Public propertyThumbnailMetaFileGroup
Name of the meta file group of the thumbnail meta file.
Public propertyTimeStampColumn
The name of the class field (column) that stores the last modification date for objects.
Public propertyTouchCacheDependencies
Indicates whether the corresponding dummy cache keys (dependencies) are touched when an object of the type is modified. This causes the cache to delete all items that depend on the given dummy keys. The default value is false.
Public propertyStatic memberTrackObjectInstances
If true, object instances are tracked.
Public propertyTypeCondition
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 the specified object type. If you need to specify a more complex WHERE condition, use the WhereCondition property which has higher priority.
Public propertyUpdateTimeStamp
If true, timestamp of the object is updated when saved.
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyUseUpsert
Indicates whether the object can use upsert. If not set, the value is inferred from IsBinding (only binding objects can use upsert by default). Setting this property to any value overrides the default behavior.
Public propertyVersionGUIDColumn
The name of the class field (column) that stores the GUID identifiers for individual versions of objects. Intended for object types that support versioning.
Public propertyWhereCondition
Default where condition restricting the data of this particular object type.
Top
See Also