[This is preliminary documentation and is subject to change.]
The Row type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | Row | Initializes a new instance of the Row class |
Methods
Name | Description | |
---|---|---|
![]() | ApplyDefaultFieldValues |
Writes default values specified in schema into fields.
Pass overwrite=true to force defaults over non-null existing values (false by default)
|
![]() | CheckMinMax | |
![]() | Configure |
In base class applies Config attribute. Useful for typed rows
|
![]() | ConvertFieldValueToDef |
Converts field value to the type specified by Schema.FieldDef. For example converts GDID->ulong or ulong->GDID.
This method can be overridden to perform custom handling of types,
for example one can assign bool field as "Si" that would convert to TRUE.
This method is called by SetFieldValue(...) before assigning actual field buffer
|
![]() | CopyFields |
Copies fields from this row into another row/form.
Note: this is shallow copy, as field values for complex types are just copied over
|
![]() | Equals(Object) |
Object override - sealed. Override Equals(row) instead
(Overrides ![]() |
![]() | Equals(Row) |
Override to perform custom row equality comparison.
Default implementation equates rows using their key fields
|
![]() | FilterJSONSerializerField |
Override to filter-out some fields from serialization to JSON, or change field values.
Return name null to indicate that field should be filtered-out(excluded from serialization to JSON)
|
![]() | ![]() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from ![]() |
![]() | GetClientFieldDef |
Override to perform dynamic substitute of field def for the specified field.
This method is used by client ui/scaffolding to extract dynamic definition for a field
(i.e. field description, requirement, value list etc.) as dictated by business logic.
This method IS NOT used by row validation, only by client that feeds from row's metadata.
The default implementation returns the original field def, you can return a substituted field def
per particular business logic
|
![]() | GetClientFieldValue |
Override to perform dynamic substitute of field value for the specified field.
This method is used by client ui/scaffolding to extract field values for a field as dictated by business logic.
This method IS NOT used by row validation, only by client that feeds from row's metadata.
The default implementation returns the original GetFieldValue(fdef), you can return a substituted field value
per particular business logic
|
![]() | GetClientFieldValueList |
Override to perform dynamic lookup of field value list for the specified field.
This method is used by client ui/scaffolding to extract dynamic lookup values
as dictated by business logic. This method IS NOT used by row validation, only by client
that feeds from row's metadata.
This is a simplified version of GetClientFieldDef
|
![]() | GetDataStoreKey |
Returns values for fields that represent row's primary key
|
![]() | GetDisplayFieldValue(Int32, String, Func Object, Object ) |
Returns field value as string formatted per target DisplayFormat attribute
|
![]() | GetDisplayFieldValue(String, String, Func Object, Object ) |
Returns field value as string formatted per target DisplayFormat attribute
|
![]() | GetEnumerator | |
![]() | GetFieldValue |
Gets value of the field, for typerows it accesses property using reflection; for dynamic rows it reads data from
row buffer array using field index(order)
|
![]() | GetFieldValueDescription(Int32, String, Boolean) |
For fields with ValueList returns value's description per specified targeted schema
|
![]() | GetFieldValueDescription(String, String, Boolean) |
For fields with ValueList returns value's description per specified targeted schema
|
![]() | GetHashCode |
Object override - gets hash code from key fields
(Overrides ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() ![]() | MakeRow |
Factory method that makes an appropriate row type.For performance purposes,
this method does not check passed type for Row-derivation and returns null instead if type was invalid
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | PersistConfiguration |
The base class does not implement this method. Override to persist row fields into config node
|
![]() | SetFieldValue |
Sets value of the field, for typerows it accesses property using reflection; for dynamic rows it sets data into
row buffer array using field index(order)
|
![]() | SimpleFilterPredicate |
Returns true if this row satisfies simple filter - it contains the supplied filter string.
The filter pattern may start or end with "*" char that denotes a wildcard. A wildcard is permitted on both sides of the filter value
|
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() ![]() | TryFillFromJSON |
Tries to fill the row with data returning true if field count matched
|
![]() | Validate |
Performs validation of data in the row returning exception object that provides description
in cases when validation does not pass. Validation is performed not targeting any particular backend
|
![]() | Validate(String) |
Validates row using row schema and supplied field definitions.
Override to perform custom validations,
i.e. TypeRows may directly access properties and write some validation type-safe code
The method is not expected to throw exception in case of failed validation, rather return exception instance because
throwing exception really hampers validation performance when many rows need to be validated
|
![]() | ValidateField(String, Schema FieldDef) |
Validates row field using Schema.FieldDef settings.
This method is invoked by base Validate() implementation.
The method is not expected to throw exception in case of failed validation, rather return exception instance because
throwing exception really hampers validation performance when many rows need to be validated
|
![]() | ValidateField(String, String) |
Validates row field by name.
Shortcut to ValidateField(Schema.FieldDef)
|
![]() | WriteAsJSON |
Writes row as JSON either as an array or map depending on JSONWritingOptions.RowsAsMap setting.
Do not call this method directly, instead call rowset.ToJSON() or use JSONWriter class
|
Extension Methods
Properties
Name | Description | |
---|---|---|
![]() | Item Int32 |
Gets/sets field values by positional index(Order)
|
![]() | Item String |
Gets/sets field values by name
|
![]() | Schema |
References a schema for a table that this row is part of
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IEnumerable GetEnumerator |
See Also