Show / Hide Table of Contents

Class EntityCustomFieldsHelper

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Inheritance
object
EntityCustomFieldsHelper
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class EntityCustomFieldsHelper

Constructors

EntityCustomFieldsHelper(TableRowBase, EntityExtraFieldsHelper, EntityUdefHelper)

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
public EntityCustomFieldsHelper(TableRowBase row, EntityExtraFieldsHelper extraHelper, EntityUdefHelper udefHelper = null)
Parameters
Type Name Description
TableRowBase row
EntityExtraFieldsHelper extraHelper
EntityUdefHelper udefHelper

Fields

_extraHelper

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
protected EntityExtraFieldsHelper _extraHelper
Field Value
Type Description
EntityExtraFieldsHelper

_row

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
protected TableRowBase _row
Field Value
Type Description
TableRowBase

_udefHelper

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
protected EntityUdefHelper _udefHelper
Field Value
Type Description
EntityUdefHelper

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

GetNamesAsync(CancellationToken)

List of extra + udef field names and progids: ['x_foo', 'Superoffice:1']

Declaration
public Task<string[]> GetNamesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<string[]>

GetValue(string)

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
public object GetValue(string fieldName)
Parameters
Type Name Description
string fieldName
Returns
Type Description
object

ParseAsync(StringDictionary, string)

Update field value. Convert string encoded value back into object. Check for xxx:org value, and update only if xxx:org is different, or missing.

Declaration
public Task ParseAsync(StringDictionary values, string fieldName)
Parameters
Type Name Description
StringDictionary values
string fieldName
Returns
Type Description
Task

SetValueAsync(string, object, bool)

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
public Task SetValueAsync(string fieldName, object value, bool ifChanged = true)
Parameters
Type Name Description
string fieldName
object value
bool ifChanged
Returns
Type Description
Task

ToStringDictionary()

Forward extra fields to extra fields helper, udef to udef helper (if any), if the underlying helpers do not have any changes at the start of modifications.

Declaration
public StringDictionary ToStringDictionary()
Returns
Type Description
StringDictionary

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top