ObjectTypeInfo Properties |
The ObjectTypeInfo type exposes the following members.
Name | Description | |
---|---|---|
AllowDataExport |
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.
| |
AllowRestore |
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.
| |
AllowTouchParent |
Indicates if parent is allowed to be touched, if exists. Default is true.
| |
AssemblyNameColumn |
The name of the class field (column) that stores the assembly name of a related class in the project's code.
| |
BinaryColumn |
The name of the class field (column) that stores binary data for objects.
| |
BindingObjectTypes |
Gets list of binding object types.
| |
CategoryIDColumn |
Category ID column name.
| |
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.
| |
CheckDependenciesOnDelete |
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.
| |
CheckPermissions |
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.
| |
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).
| |
ChildObjectTypes |
Gets list of child object types.
| |
ClassStructureInfo |
Class structure information. If not set explicitly, it is retrieved automatically by class name.
| |
CodeColumn |
Name of the column that contains code of the object (markup).
| |
CodeNameColumn |
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.
| |
ColumnNames |
Available column names.
(Inherited from AbstractDataContainerParentObjectType.) | |
ColumnsInvalidated |
Indicates whether column names are invalidated. Default is false.
| |
CompositeObjectType |
Composite object type - type of the object which is a composite object for this object type.
| |
ConsistsOf |
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.
| |
ContainsMacros |
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.
| |
ContinuousIntegrationSettings |
Determines how the object behaves within continuous integration. Set through the properties of the ContinuousIntegrationSettings class.
| |
CSSColumn |
Name of the column that contains CSS of the object.
| |
CustomizedColumnsColumn |
The name of the class field (column) that contains customized columns.
| |
DefaultData |
Default data exported within installation. Affects default data and web template data export.
| |
DefaultOrderBy |
Default order by clause for getting data.
| |
DeleteAsDependency |
Indicates if object should be deleted when removing dependencies of other object.
| |
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.
| |
DependsOn |
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.
| |
DependsOnIndirectly |
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.
| |
DisplayNameColumn |
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).
| |
EnabledColumn |
The name of the class field (column) that indicates whether objects are enabled or disabled.
| |
Events |
Events handled by object of this type
| |
Extends |
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.
| |
ExtensionColumn |
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.
| |
Feature |
Get/sets info's feature for license check
| |
FormDefinitionColumn |
Form definition column name
| |
GlobalLogSynchronization |
If true, object tasks are logged.
| |
GroupIDColumn |
The name of the class field (column) that stores group IDs for objects related to specific community groups.
| |
GUIDColumn |
The name of the class field (column) that stores the GUID identifiers of objects.
| |
HasAutomaticProperties |
If true, the object of this type has got some automatic properties
| |
HasExternalColumns |
If true, the object has externally stored columns. Default is false.
| |
HasMetaFiles |
If true, the objects can have meta files. By default no metafiles to simplify general processes
| |
HasObjectSettings |
Indicates if the object can have object settings. Default is false.
| |
HasProcesses |
If true, the processes can be run on the objects. By default no processes to simplify general processes.
| |
HasScheduledTasks |
If true, the scheduled tasks can be run on the objects. By default no scheduled tasks to simplify general processes.
| |
IconGUIDColumn |
Name of the column that contains the GUID of the object icon meta file.
| |
IconMetaFileGroup |
Name of the meta file group of the icon meta file.
| |
IDColumn |
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.
| |
ImportExportSettings |
Defines how the object type works with the Export and Import features. Set through the properties of the ImportExportSettings class.
| |
IncludeToVersionParentDataSet |
Determines if objects of the given type are included in the version data of parent objects. True by default.
| |
InstanceCount |
Gets the number of registered isntances.
| |
IsBinding |
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.
| |
IsCategory |
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.
| |
IsComposite |
Returns true if object is a composite object. Object consists of several partial objects.
| |
IsCustomColumn |
Column name of the info record for flag IsCustom.
| |
IsDataObjectType |
Indicates if the object is dynamic based on data in the DB (e.g. custom table item or biz form item object types).
| |
IsListingObjectTypeInfo |
Indicates if the object type info is used as read-only data source for listing controls such as grids or selectors.
| |
IsMainObject |
Indicates if the object is main (= is not child of other objects).
| |
IsMultipleBinding |
Indicates if the object is binding between more than two objects.
| |
IsSelfBinding |
Identifies binding classes that connect two objects of the same type = the binding's parent type is the same as the object dependency type
| |
IsSiteBinding |
Returns true if the object is site binding.
| |
IsSiteObject |
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.
| |
IsTriggerTarget |
If true, the object can be targeted by triggers. Default is false.
| |
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.
| |
Item |
Gets the value of particular property
(Inherited from AbstractHierarchicalObjectTObject.) | |
LastObjectInvalidated |
Last time of the object invalidation.
| |
LogEvents |
Indicates whether the system logs events into the Event log when objects of the type are updated. False by default.
| |
LogIntegration |
Determines whether the system logs integration bus synchronization tasks for objects of the type. True by default.
| |
LogSiteBindings |
If true, object tasks are logged when site binding changes.
| |
MacroCollectionName |
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.
| |
MaxCodeNameLength |
Maximum length of the object code name.
| |
MimeTypeColumn |
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.
| |
ModuleInfo |
Gets the ModuleInfo object based on the value of the ModuleName property.
| |
ModuleName |
The code name of the module under which the object type belongs. Always required for all object type information definitions.
| |
NameGloballyUnique |
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.
| |
NestedInfoTypes |
List of nested info object types that contain the data internally
| |
ObjectClassName |
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.
| |
ObjectDependencies | ||
ObjectIDPathColumn |
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.
| |
ObjectLevelColumn |
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.
| |
ObjectNamePathColumn |
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.
| |
ObjectPathColumn |
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.
| |
ObjectType |
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.
| |
OrderColumn |
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).
| |
OriginalObjectType |
Original object type of virtual object types. For normal object type it's same as object type.
| |
OriginalTypeInfo |
Original object type of virtual object types. For normal object type it's null.
| |
OtherBindingObjectTypes |
Gets list of other binding types - binding types where this object participate but is not parent object of those binding types.
| |
ParentIDColumn |
The name of the class field (column) that stores the IDs of parent objects. Null for object types without a parent object.
| |
ParentObjectType |
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.
| |
ParentTypeInfo |
Gets the ObjectTypeInfo instance representing the parent object type.
| |
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).
| |
Properties |
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.) | |
PropertyList |
Used property list
(Inherited from AbstractHierarchicalObjectTObject.) | |
ProviderIsCustomizable |
Indicates if provider supports methods customization
| |
ProviderObject |
Gets an instance of the provider class set for the object type (specified by the ProviderType property).
| |
ProviderType |
The type of the object's InfoProvider class. Required for all object types.
| |
ReferenceColumnNames |
Names of the columns that reference some object.
| |
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.
| |
RegisterAsChildToObjectTypes |
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).
| |
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.
| |
RegisteredColumns |
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.) | |
RegisteredColumnsObject |
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.) | |
RegisteredProperties |
Registered properties
(Inherited from AbstractHierarchicalObjectTObject.) | |
RegisteredPropertiesObject |
Registered properties object
(Inherited from AbstractHierarchicalObjectTObject.) | |
RelatedTypeInfos |
Returns list of related TypeInfos of this TypeInfo (the relationship is made from OriginalTypeInfo property, but reflects the relationship from both sides).
| |
RememberUniGridState |
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.
| |
RequiredObject |
If true, the object is required when imported / synchronized. If false, the object can be skipped when some error occurs. Default is true.
| |
ResourceIDColumn |
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.
| |
SearchContentColumn |
The name of the class field (column) that stores cached content extracted for this Info object to be used in search indexing.
| |
SensitiveColumns |
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.
| |
SerializationSettings |
Determines how the system serializes objects of the given type from the database into XML files. Set through the properties of the SerializationSettings class.
| |
SiteBinding |
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).
| |
SiteBindingObject |
Gets the Info class of the binding class that stores relationships between the given class and sites (if such a site binding class exists).
| |
SiteIDColumn |
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.
| |
SizeColumn |
Intended for object types that store binary data. Sets the name of the class field (column) that stores the size of the binary data.
| |
SupportsCloneToOtherSite |
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.
| |
SupportsCloning |
Indicates whether the system allows cloning for objects of the given type. True by default.
| |
SupportsGlobalObjects |
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.
| |
SupportsInvalidation |
If true, the object is automatically invalidated upon it's change. Default is false.
| |
SupportsLocking |
Determines whether the object type supports object locking (check out and check in). The default value is false.
| |
SupportsSearch |
Indicates if object can be searched. Default is true for main objects.
| |
SupportsVersioning |
Determines whether the object type supports object versioning. The default value is false.
| |
SynchronizationSettings |
Defines how Staging features work with the object type's data. Set through the properties of the SynchronizationSettings class.
| |
ThumbnailGUIDColumn |
Name of the column that contains the GUID of the object thumbnail meta file.
| |
ThumbnailMetaFileGroup |
Name of the meta file group of the thumbnail meta file.
| |
TimeStampColumn |
The name of the class field (column) that stores the last modification date for objects.
| |
TouchCacheDependencies |
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.
| |
TrackObjectInstances |
If true, object instances are tracked.
| |
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 the specified object type.
If you need to specify a more complex WHERE condition, use the WhereCondition property which has higher priority.
| |
UpdateTimeStamp |
If true, timestamp of the object is updated when saved.
| |
UseLocalColumns |
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.) | |
UseLocalProperties |
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.) | |
UseUpsert |
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.
| |
VersionGUIDColumn |
The name of the class field (column) that stores the GUID identifiers for individual versions of objects.
Intended for object types that support versioning.
| |
WhereCondition |
Default where condition restricting the data of this particular object type.
|