The ObjectTypeInfo type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
ObjectTypeInfo(String, ObjectTypeInfo) |
Constructor.
| |
ObjectTypeInfo(Type, String, String, String, String, String, String, String, String, String, String, String) |
Constructor.
|
Methods
Name | Description | |
---|---|---|
AddDependencies |
Adds object dependencies to the existing ones.
| |
AddNewInstance |
Adds new object instance to the list.
| |
ApplyTypeCondition |
Applies condition defined in TypeCondition property to the given info. Returns info without changes if TypeCondition is null.
| |
Clone |
Returns clone of type info where all the properties are copied.
| |
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 ObjectType .) | |
ContainsColumn |
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainer ParentObjectType .) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetBindingColumns |
Gets the list of columns representing binding
| |
GetBindingWhereCondition |
Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
| |
GetDependencyForColumn |
Gets the dependency settings for the given column or null if the settings is not found or unknown.
| |
GetDependencyWhereCondition |
Gets the where condition to limit the objects to specific dependencies.
| |
GetFirstKnownColumn |
Gets the first known column from the given list of columns
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetInstances |
Gets the list of instances of the objects.
| |
GetNiceObjectTypeName |
Gets the nice objext type name for this type
| |
GetObjectPathWhereCondition |
Gets the where condition to limit the objects to specific path.
| |
GetObjectTypeForColumn |
Gets the object type for the given column or null if the object type is not found or unknown.
| |
GetProperty |
Gets the context property.
(Inherited from AbstractHierarchicalObject ObjectType .) | |
GetPropertyType |
Gets the type of the given property
(Inherited from AbstractHierarchicalObject ObjectType .) | |
GetSiteWhereCondition |
Gets the where condition to limit the objects to specific site.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetTypeColumns |
Returns the column names of specified object type, separated by semicolon.
| |
GetValue |
Gets the object value.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) | |
HasEvents |
Returns true if this type info has some events
| |
HasSetter |
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObject ObjectType .) | |
CheckTypeCondition |
Checks if condition defined in TypeCondition is not violated by the given info.
| |
IncludeToParentDataSet |
Gets value of appropriate include to parent data set property due to operation.
| |
InvalidateAllObjects |
Invalidates all objects of this type.
| |
InvalidateAllObjects(Boolean) |
Invalidates all objects of this type.
| |
InvalidateColumnNames |
Invalidates column names.
| |
InvalidateColumnNames(Boolean) |
Invalidates column names.
| |
IsDynamicDependency |
Indicates if dependency object type id dynamic
| |
IsForeignKey |
Indicates if given column is foreign key.
| |
IsObjectInvalid |
Returns true if the object is invalid.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
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.
| |
ObjectInvalidated(Int32) |
Invalidates specific object.
| |
ObjectInvalidated(Int32, Boolean) |
Invalidates specific object.
| |
RaiseOnLoadRelatedData |
Raises the on load related data event.
| |
RaiseOnLogObjectChange |
Raises the OnLogObjectChange event.
| |
RegisterColumn(String, Func ParentObjectType, Object ) |
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) | |
RegisterColumn(String, Func ParentObjectType, Object , Func ParentObjectType, Object, Object ) |
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) | |
RegisterColumns |
Registers the Columns of this object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) | |
RegisterProperties |
Registers the properties of this object
(Inherited from AbstractHierarchicalObject ObjectType .) | |
RegisterProperty(String, Func ObjectType, Object ) |
Registers the given property to the object
(Inherited from AbstractHierarchicalObject ObjectType .) | |
RegisterProperty(String, Object, Func ObjectType, Object, Object ) |
Registers the given parameterized property to the object.
(Inherited from AbstractHierarchicalObject ObjectType .) | |
SetProperty |
Gets the context property.
(Inherited from AbstractHierarchicalObject ObjectType .) | |
SetValue |
Sets the object value.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) | |
ToJSON |
Returns JSON representation of TypeInfo instance.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
ToXML |
Returns XML representation of TypeInfo instance.
| |
TryGetProperty(String, Object ) |
Gets the context property.
(Inherited from AbstractHierarchicalObject ObjectType .) | |
TryGetProperty(String, Object , Boolean) |
Returns value of property.
(Inherited from AbstractHierarchicalObject ObjectType .) | |
TryGetValue |
Returns value of column.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
Extension Methods
Name | Description | |
---|---|---|
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
Name | Description | |
---|---|---|
COLUMN_NAME_UNKNOWN |
Uknown column name.
| |
VALUE_UNKNOWN |
Uknown value.
|
Properties
Name | Description | |
---|---|---|
AllowDataExport |
Specifies whether the object supports data export. By default the value is true for all objects except binding objects.
| |
AllowObjectRelationships |
If true, object relationships are allowed.
| |
AllowPostProcessing |
Indicates if object allows post-processing during the import and staging process.
| |
AllowRestore |
Indicates if the object supports deleting to recycle bin. By default the value is true for all objects except binding objects.
| |
AllowTouchParent |
Indicates if parent is allowed to be touched, if exists. Default is true.
| |
AssemblyNameColumn |
Name of the column with assembly name.
| |
BinaryColumn |
Binary column name of the info record.
| |
BindingObjectTypes |
Binding object types, list of object types separated by semicolon.
| |
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.
| |
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 |
Code name column name of the info record.
| |
ColumnNames |
Available column names.
(Inherited from AbstractDataContainer ParentObjectType .) | |
ColumnsInvalidated |
Indicates whether column names are invalidated. Default is false.
| |
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.
| |
ContainsMacros |
Indicates if the object may contain some macros in it's values. Default is true.
| |
CSSColumn |
Name of the column that contains CSS of the object.
| |
CustomizedColumnsColumn |
Column name which contains customized columns.
| |
DefaultData |
Default data exported within installation.
| |
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 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).
| |
DisplayNameColumn |
Display name column name of the info record.
| |
EnabledColumn |
Name of the column which determines whether the object is enabled or disabled within the system.
| |
Events |
Events handled by object of this type
| |
Extends |
List of columns which which this object extends other objects as a foreign key.
| |
ExtensionColumn |
File extension column (for objects with binary column - column which specifies extension type of binary data).
| |
Feature |
Get/sets info's feature for license check
| |
GlobalLogSynchronization |
If true, object tasks are logged.
| |
GroupIDColumn |
Community group ID column name of the info record, returns specific column if the object can be also group object.
| |
GUIDColumn |
GUID column.
| |
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
| |
HasObjectRelationships |
If true, the objects can have relationships to other objects. By default no relationships to simplify general processes.
| |
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.
| |
HostedByObjectType |
Defines the object type that this object type extends
| |
HostedObjectTypes |
Defines the objects types that extend this object
| |
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.
| |
CheckPermissions |
Determines whether the permissions should be checked when the object is accessed within the macro engine as an inner object. Default is true.
| |
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 |
Child object types, list of object types separated by semicolon.
| |
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 |
ID column.
| |
ImportExportSettings |
Import/export settings.
| |
IncludeToSynchronizationParentDataSet |
If false, the object is not included in the parent DataSet (for synchronization).
| |
IncludeToVersionParentDataSet |
Indicates if the objects should be included in version data set of it's parent
| |
InfoType |
Info class type
| |
Inherited |
Indicates if the type info is inherited (list info for example).
| |
IsBinding |
Returns true if the object is binding. Set forces the object to behave as binding.
| |
IsCategory |
Returns true if object is category type. Default is false.
| |
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 objecttypes).
| |
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 |
Returns true if the binding is binding to the same object as parent.
| |
IsSiteBinding |
Returns true if the object is site binding.
| |
IsSiteObject |
Returns true if the object is site
| |
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.
| |
IsWrapper |
Returns true if object is wrapper. Object consists of several partial objects.
| |
Item |
Gets the value of particular property
(Inherited from AbstractHierarchicalObject ObjectType .) | |
LastObjectInvalidated |
Last time of the object invalidation.
| |
LogEvents |
If true, Events tasks are logged on the object update. Default is false.
| |
LogIntegration |
If true, integration tasks are being logged. Default is true.
| |
LogSiteBindings |
If true, object tasks are logged when site binding changes.
| |
LogSynchronization |
If true, synchronization tasks are logged on the object update.
| |
MaxCodeNameLength |
Maximum length of the object code name.
| |
MimeTypeColumn |
Mime type column (for objects with binary column - column which specifies mime type of binary data).
| |
ModuleInfo |
Returns ModuleInfo object retrieved by ModuleName.
| |
ModuleName |
Name of the module where the object belongs.
| |
Name |
Object type name, if not set, ObjectClassName is returned.
| |
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.
| |
NestedInfoTypes |
List of nested info object types that contain the data internally
| |
ObjectClassName |
Object class name.
| |
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.
| |
ObjectIDPathColumn |
ID path column name of the info record, returns specific column if the object has hierarchical structure.
| |
ObjectLevelColumn |
Object level column. If the object has hierarchical structure, determines the depth within the tree.
| |
ObjectNamePathColumn |
Name path column name of the info record, returns specific column if the object has hierarchical structure.
| |
ObjectPathColumn |
Path column name of the info record, returns specific column if the object has hierarchical structure.
| |
ObjectType |
Object type.
| |
OrderColumn |
Order column name of the info record.
| |
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 same as object type.
| |
OtherBindingObjectTypes |
Other binding types (ObjectType constants separated by semicolon) - binding types where this object participate but is not parent object of those binding types.
| |
ParentIDColumn |
Parent ID column name of the info record, returns specific column if the object is child object (has parent).
| |
ParentObjectType |
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 AbstractHierarchicalObject ObjectType .) | |
PropertyList |
Used property list
(Inherited from AbstractHierarchicalObject ObjectType .) | |
ProviderIsCustomizable |
Indicates if provider supports methods customization
| |
ProviderObject |
Returns the provider object for this type info.
| |
ProviderType |
Provider type.
| |
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), 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.
| |
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 AbstractSimpleDataContainer ParentObjectType .) | |
RegisteredColumnsObject |
Registered Columns object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) | |
RegisteredProperties |
Registered properties
(Inherited from AbstractHierarchicalObject ObjectType .) | |
RegisteredPropertiesObject |
Registered properties object
(Inherited from AbstractHierarchicalObject ObjectType .) | |
RelatedTypeInfos |
Returns dictionary of related TypeInfos of this TypeInfo (the relationship is made from OriginalTypeInfo property, but reflects the relationship from both sides).
| |
RememberUniGridState |
Indicates whether UniGrids working with objects of this type will remember their state, i.e., filter, page number, page size and sorting 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 |
Resource ID column name of the info record, returns specific column if the object is dependant on a resource.
| |
SearchContentColumn |
Column which stores cached content extracted for this Info object to be used in search indexing. Used by the method EnsureSearchContent.
| |
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.
| |
SiteBinding |
Site binding object type (if exists).
| |
SiteBindingObject |
Site binding object (if exists).
| |
SiteIDColumn |
Site ID column name of the info record.
| |
SizeColumn |
File size column (for objects with binary column - column which specifies size of the binary data).
| |
SupportsCloneToOtherSite |
Indicates if object can be cloned to different site than the site of the original. Default is true.
| |
SupportsCloning |
Indicates if object can be cloned. Default is true.
| |
SupportsGlobalObjects |
If true, object can be either site or global (for example poll). Default is false.
| |
SupportsInvalidation |
If true, the object is automatically invalidated upon it's change. Default is false.
| |
SupportsLocking |
Indicates is the object supports locking (check-in / check-out). Default is false.
| |
SupportsSearch |
Indicates if object can be searched. Default is true for main objects.
| |
SupportsVersioning |
Indicates if the object versioning is supported. Default is false.
| |
SynchronizationObjectTreeLocations |
Object tree locations for synchronization
| |
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 |
Time stamp column.
| |
TouchCacheDependencies |
If true, cache dependencies are touched when the object is changed. Default 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 specified object type.
If you need to specify more complex WHERE condition, use property WhereCondition 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 AbstractSimpleDataContainer ParentObjectType .) | |
UseLocalProperties |
If true, the object uses local properties
(Inherited from AbstractHierarchicalObject ObjectType .) | |
VersionGUIDColumn |
Name of the column that contains the version GUID of the object.
| |
WhereCondition |
Default where condition restricting the data of this particular object type.
| |
WrapperObjectType |
Wrapper object type - type of the object which is is a wrapper for this object type.
|
Events
Name | Description | |
---|---|---|
OnLoadRelatedData |
Fires when the related data should be loaded to the object.
| |
OnLogGlobalObjectChange |
Fires when the object change should be logged - Global handler
| |
OnLogObjectChange |
Fires when the object change should be logged - Handler for particular type info
|
See Also