Class PropEntityImportColDefinition
The standard import column defintion for a property against an entity in the system
This property can be a real property in the database or not and managed by the sql
Inheritance
Inherited Members
Namespace: LemonEdge.API.Descriptors
Assembly: LemonEdge.API.dll
Syntax
public class PropEntityImportColDefinition : EntityImportColDefinition, IHasChildren<EntityImportColDefinition>, IHasChildren, IQueryableFieldInfoConstructors
PropEntityImportColDefinition(bool, ColumnDescriptor, EntityImportColDefinition)
Creates a property entity import column definition for a property
Declaration
public PropEntityImportColDefinition(bool isDirectSQLProp, ColumnDescriptor colInfo, EntityImportColDefinition parent = null)Parameters
| Type | Name | Description |
|---|---|---|
| bool | isDirectSQLProp | Indicates this property can be included in a sql select from query tools, maps to IsSQLProp |
| ColumnDescriptor | colInfo | The column information for this property |
| EntityImportColDefinition | parent | Any parent entity import column definition |
PropEntityImportColDefinition(Guid, bool, ColumnDescriptor, EntityImportColDefinition)
Creates a property entity import column definition for a property that exists against a specified entity
Declaration
public PropEntityImportColDefinition(Guid mapTypeID, bool isDirectSQLProp, ColumnDescriptor colInfo, EntityImportColDefinition parent = null)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | mapTypeID | The global unique id of the entity this type is a property against |
| bool | isDirectSQLProp | Indicates this property can be included in a sql select from query tools, maps to IsSQLProp |
| ColumnDescriptor | colInfo | The column information for this property |
| EntityImportColDefinition | parent | Any parent entity import column definition |
Properties
ColumnInfo
The column information for this property
Declaration
public override ColumnDescriptor ColumnInfo { get; }Property Value
| Type | Description |
|---|---|
| ColumnDescriptor |
Overrides
ColumnMnemonic
The column mnemonic is any parent column mnemonic (if there is one) followed by _ (if there was a parent) and then this property name
Declaration
public override string ColumnMnemonic { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
ColumnType
The type for this column. Used for formatting and parsing string representations of the value correctly
Declaration
public override Type ColumnType { get; }Property Value
| Type | Description |
|---|---|
| Type |
Overrides
FieldMapToDescriptorColumnName
The column name this field is a property of in the LemonEdge platform. Used as an optional mapping if this field is actual data from the system.
Not required, but provides useful contextual information for the query tools to know how to join items, display, and/or open them
Declaration
public override string FieldMapToDescriptorColumnName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
FieldMapToDescriptorTypeID
The unique global id of the type this field is a property of in the LemonEdge platform. Used as an optional mapping if this field is actual data from the system.
Declaration
public override Guid? FieldMapToDescriptorTypeID { get; }Property Value
| Type | Description |
|---|---|
| Guid? |
Overrides
IsKey
Indicates if this column is part of a key property for the entity
Declaration
public override bool IsKey { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
PropertyName
The property name
Declaration
public override string PropertyName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
UserFriendlyName
The name of this parent user friendly name (if there is a parent), followed by this column user friendly name, followed by attributes showing if the column is a key or mandatory
Declaration
public override string UserFriendlyName { get; }Property Value
| Type | Description |
|---|---|
| string |