Class EntityExtraFieldsHelper
Forward extra fields to underlying row
Inherited Members
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class EntityExtraFieldsHelperConstructors
EntityExtraFieldsHelper(TableRowBase)
Forward extra fields to underlying row
Declaration
public EntityExtraFieldsHelper(TableRowBase row)Parameters
| Type | Name | Description |
|---|---|---|
| TableRowBase | row |
Fields
_row
Forward extra fields to underlying row
Declaration
protected TableRowBase _rowField Value
| Type | Description |
|---|---|
| TableRowBase |
Properties
EnforceRequiredFields
Allows required field enforcement to be turned off - used for person on user.
Declaration
public bool EnforceRequiredFields { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
this[string]
Forward extra fields to underlying row
Declaration
public object this[string fieldName] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldName |
Property Value
| Type | Description |
|---|---|
| object |
Names
Valid extra field names: ['x_foo', 'x_bar']
Declaration
public string[] Names { get; }Property Value
| Type | Description |
|---|---|
| string[] |
Methods
Encode(string)
Convert field value to a string encoded value: 123 -> "[I:123]"
Declaration
public string Encode(string fieldName)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldName |
Returns
| Type | Description |
|---|---|
| string |
GetExtraInfoAsync(string, TableInfo, object, CancellationToken)
Forward extra fields to underlying row
Declaration
public static Task<(string, string, bool)> GetExtraInfoAsync(string fieldname, TableInfo table, object value, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldname | |
| TableInfo | table | |
| object | value | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<(string, string, bool)> |
GetExtraInfoAsync(string, CancellationToken)
Forward extra fields to underlying row
Declaration
public Task<(string, string, bool)> GetExtraInfoAsync(string fieldname, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldname | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<(string, string, bool)> |
GetFieldRight(string)
Get a FieldRight for the extra field value.
Declaration
public FieldRight GetFieldRight(string fieldName)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldName | name of extra field: 'x_foo' |
Returns
| Type | Description |
|---|---|
| FieldRight | Permissions on the field. |
IsChanged(string)
Has the underlying field been changed?
Declaration
public bool IsChanged(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of extra field |
Returns
| Type | Description |
|---|---|
| bool | True if the field value has been changed |
Parse(string, string)
Update field value. Convert string encoded value back into object
Declaration
public void Parse(string fieldName, string value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldName | |
| string | value |
Validate(RowValidator)
Checks that mandatory extra fields are not NULL. Stricter mandatory checks are handled by entity/service layer.
Declaration
public void Validate(RowValidator rowValidator)Parameters
| Type | Name | Description |
|---|---|---|
| RowValidator | rowValidator | Collection of errors to add to |
Validate(Dictionary<string, string>)
Stricter checks that mandatory extra fields are not NULL, 0 or "". Called by the entity/service classes.
Declaration
public void Validate(Dictionary<string, string> validator)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<string, string> | validator | Collection of errors to add to |