Field attributes are used to control overall behaviour of an
IField via its
Attributes property.
Attributes may be combined by ORing values together.
Namespace:
NetQuarry.Data
Assembly:
EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax [FlagsAttribute]
public enum FieldAttrs
<FlagsAttribute>
Public Enumeration FieldAttrs
Members
| Member name | Value | Description |
---|
| Required | 1 |
The field cannot be null.
Note that if the field is currently marked Required, but was not originally so marked, you can set the
RequiredExceptLegacy option which will allow changes to the mapper to be saved
even when this field is null, provided that it was already null.
|
| Locked | 2 | The field is readonly in the UI (but can still be set programmatically). |
| PK | 4 | The field is a primary key for its table. |
| ExcludeFromSelect | 8 | The field should not be queried. Generally used when there is no corresponding column in the underlying table or view. |
| QuickCreate | 16 | The field should be part of a minimal record creator. |
| AutoAssign | 32 | The field's value should be set automatically on create. (Applies to GUID columns only -- either varchar or binary(16)). |
| Identity | 64 | The field is a database identity or autoincrement column. |
| Search | 128 | The field should be used when searching using this Mapper. |
| Sensitive | 256 | The field's data is sensitive and, when not visible, must not be allowed in page source. This will prevent javascript access. |
| UseDefaultOnUpdate | 512 | The field's default value should also be used on updates (in addition to inserts). This is most commonly used to automatically track last modified date and/or user. |
| HtmlContent | 1024 | The field's content is HTML and should not be encoded. |
| HtmlCaption | 2048 | The field's caption is HTML and should not be encoded. |
| SubformKey | 4096 | This field's value is required by subforms. |
| DefaultFromParent | 8192 | This field's DefaultValue should be set from its mapper's parent mapper. Assumes parent key name is the same. If not, set ParentField. |
| ReservedWord | 16384 | This field's column name is a reserved word in the DBMS and should be escaped accordingly. |
| EditInList | 32768 | The field should be editable by the user in list views. |
| NoClientValidation | 65536 | No client-side validation should be performed on the field's value. |
| UniqueKey | 131072 |
This field uniquely identifies a row in this mapper.
If no field is marked as the UniqueKey, then the key will be formed from the set of fields marked as PK (primary key).
You should generally identify a UniqueKey if the mapper has multiple PK fields (or none).
|
| FreezeColumn | 262144 | Freeze this field's column in the datasheet. |
| Filterer | 524288 | This field is used as a filtering element within the mapper. |
| Audit | 1048576 | This field should be audited by the mapper's audit extension. |
| NonNullable | 2097152 | This field's underlying data column does not support null values. |
| DupeCheck | 4194304 | On insert, verify that no record exists having values matching those of all fields marked as DupeCheck fields. |
| InitOnly | 8388608 | This field should be locked on existing records. |
| AlternateKey | 16777216 | This field is an alternate primary key. |
| SchemaOptional | 33554432 |
On mapper load, the field should be omitted if its underlying column does not exist in the schema.
This option can be helpful in the case of new schema where use of the field Version/MinVersion/MaxVersion is not desirable.
Note that any such omitted fields will not be added to the Fields collection (this is similar to how field
IncludeFlavor/ExcludeFlavor and Version/MinVersion/MaxVersion are handled).
Note that ColumnName and AliasName are ignored when testing the schema for existence.
Ignored if ExcludeFromSelect is also set.
|
| ForceCodeGen | 67108864 | This field MUST be included in code generation even if it would otherwise be versioned and/or flavored out. |
| Custom1 | 536870912 | Reserved for custom application use. |
| Custom2 | 1073741824 | Reserved for custom application use. |
See Also