CustomProperty Class |
User-defined properties, which can supplement the system properties of almost all entities in the system. Entity: Gen_Properties
Inheritance HierarchySystemObject
Aloe.SystemFrameworks.DomainDomainObject
Aloe.SystemFrameworks.DomainEditableDomainObject
Aloe.SystemFrameworks.DomainEntityObject
Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
Aloe.EnterpriseOne.Model.GeneralCustomProperty
Aloe.SystemFrameworks.DomainDomainObject
Aloe.SystemFrameworks.DomainEditableDomainObject
Aloe.SystemFrameworks.DomainEntityObject
Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
Aloe.EnterpriseOne.Model.GeneralCustomProperty
Namespace: Aloe.EnterpriseOne.Model.General
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5
SyntaxThe CustomProperty type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CustomProperty | Initializes a new instance of the CustomProperty class with specific ObjectTransaction |
Properties| Name | Description | |
|---|---|---|
 | AllowedValues | List of CustomPropertyAllowedValue child objects, based on the General.CustomPropertyAllowedValue.Property back reference |
| AllowedValuesEntityName | When not null, specifies that the allowed values are retrieved from the specified entity. [Filter(eq)] |
| AllowedValuesFilterXML | When not null specifies the filter to apply when extracting allowed values from entity. |
| AllowedValuesParentProperty | Specifies the user defined property, which is used for filtering the allowed values by value of the parent property. [Filter(multi eq)] |
| AllowedValuesProperty | When not null, specifies that the current property can have the same allowed values as the specified property. Also, this makes the current and the specified property copy-compatible. [Filter(multi eq)] |
| AllowedValuesRootProperty |
Gets the root allowed values property of the current property.
|
| ChangingAttributes |
Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.
(Inherited from EditableDomainObject.) |
| Code | Unique property code. [Required] [Filter(multi eq;like)] [ORD] |
| CustomProperties |
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.) |
| Empty |
Gets an empty property value.
|
| EnterpriseCompanyFilters | List of PropertyEnterpriseCompanyFilter child objects, based on the General.PropertyEnterpriseCompanyFilter.Property back reference |
| EntityName | The entity for which the property is applicable. [Required] [Filter(eq)] [ORD] |
| ExtendedProperties |
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.) |
| Hint | The hint, which is displayed alongside the property. [Filter(multi eq;like)] |
| Id |
The unique Id of the entity object
(Inherited from EntityObject.) |
| IsGhost |
Returns true when the object is a ghost object
(Inherited from EntityObject.) |
| IsLoaded | Gets a value indicating whether the associated data for this domain object is loaded. (Overrides EntityObjectIsLoaded.) |
| ItemString |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) |
| ItemIDataAttribute |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) |
| KeyOrder | When not null, indicates, that the property is a key property and contains the property consequtive position withing the entity. Used for BI and other analysis. |
| LimitToAllowedValues | When true, allows the property to be set only to allowed value. When false, the property can have any value. [Required] [Default(false)] [Filter(eq)] |
| MaskLength | Limits te length of the property value to the specified number of characters. Null means no limitation. |
| Name | The name of this CustomProperty. [Required] [Filter(like)] [ORD] |
| NoEvents |
Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.
(Inherited from DomainObject.) |
| Notes | Notes for this CustomProperty. |
| ObjectState | Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.) |
| PropertiesCategory | When not null, categorizes the property under a category. [Filter(multi eq)] |
| PropertyType | Type of property values. 'T' - text; 'P' - picture; 'N' - number; 'D' - date. [Required] [Default("T")] |
| Repository | Provides access to CustomPropertiesRepository repository methods |
| Transaction |
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.) |
Methods| Name | Description | |
|---|---|---|
| CreateLocalValue |
Returns a new property value, searching through the local allowed values of the property.
|
| Delete | Deletes the domain object. (Overrides EntityObjectDelete.) |
| DuplicateObject |
Creates a copy of the object.
(Inherited from EntityObject.) |
| Equals(Object) |
Determines whether the specified Object, is equal to this instance.
(Inherited from EntityObject.) |
| Equals(EntityObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from EntityObject.) |
| ExecuteBusinessRules |
Executes all business rules for the object for the specified BusinessEvent.
The validation fails are saved in the event.
(Inherited from EditableDomainObject.) |
| FindPreferredCopyPartner |
Finds the preferred copy partner for the current property.
|
| GetAggregateParent |
Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null.
(Inherited from EntityObject.) |
| GetAggregateRoot |
Gets the aggregate root entity object.
If the entity does not have aggregate parent reference aggregate root is this entity object.
(Inherited from EntityObject.) |
| GetEntityRepository |
Gets the entity repository represented by EntityName.
|
| GetHashCode |
Returns a hash code for this instance.
(Inherited from EntityObject.) |
| GetRelatedObjectsForValidation |
Gets the related objects which would need validation upon validation of this object.
(Inherited from EntityObject.) |
| IssueWarning(String) |
Issues a warning with the specified message.
(Inherited from EditableDomainObject.) |
| IssueWarning(ExpressionFuncString, Object) |
Issues a warning with the specified message. The message can contain standard string placeholders.
(Inherited from EditableDomainObject.) |
| MatchesFilter(DataAccessFilter) |
Returns true if this entity object matches the specified filter.
(Inherited from EnterpriseOneEntityObject.) |
| MatchesFilter(DataAccessFilter, IBufferRow) |
Matches the filter against the specified row and returns the result of the match.
(Inherited from EnterpriseOneEntityObject.) |
| Refresh |
Refreshes this instance with data from data source.
Only objects with ObjectState equal to Unchanged are refreshed.
(Inherited from EntityObject.) |
| ToString |
Returns a String that represents this instance.
(Inherited from EntityObject.) |
| ToString(String) |
Returns a String that represents this instance.
(Inherited from EntityObject.) |
| TryGet |
Tries to get the specified attribute and returns it or null, when it is not found.
(Inherited from DomainObject.) |
Extension Methods| Name | Description | |
|---|---|---|
 | FillAggregateMissingDefaults |
Recalculates the default values for all objects in the aggregate.
(Defined by EntityObjectExtensions.) |
| FillMissingDefaults |
Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default.
(Defined by EntityObjectExtensions.) |
| FormatString |
Converts the object to string based on the format specified.
(Defined by FormatStringExtensions.) |
| GetExtensibleDataObject |
Gets the extensible data object related to the entity object.
Can return null if such ExtensibleDataObject doesn't exist.
(Defined by ExtensibleDataObjectExtensions.) |
| GetOrCreateExtensibleDataObject |
Returns an ExtensibleDataObject related to the entity object.
If such object doesn't exist the object is created in the same transaction.
(Defined by ExtensibleDataObjectExtensions.) |
| RecalculateMasterAttributes |
Recalculates the values of a master attributes in a master-detail relationship.
(Defined by EntityObjectExtensions.) |
| RecalculateMissingValues |
Recalculates the missing values using the first reactive expression of the attributes.
(Defined by EntityObjectExtensions.) |
See Also