Interface IDataStoreTextFieldIntegrationCom

Namespace

Sfrep.AppraiseIt.Client.Integration.Com.DataStore.Fields

Assembly

Sfrep.AppraiseIt.Client.Integration.Com.dll

Encapsulates a text field in the dynamic data store.

[ComVisible(true)]
[Guid("8D3D05DA-6653-43D6-9831-C21D66712D74")]
public interface IDataStoreTextFieldIntegrationCom : IDataStoreExtendedCommentFieldIntegrationComBase, IDataStoreCompFieldIntegrationComBase, IDataStoreFieldIntegrationComBase, IDisposable

Methods

Clear()

Clear's the field's data.

void Clear()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

void Dispose()

GetDateValue()

Gets the field data as a DateTime value.

object GetDateValue()

Returns

object

The field data. If the field data cannot be parsed into a DateTime, null is returned.

GetNumericValue()

Gets the field data as a decimal value.

decimal GetNumericValue()

Returns

decimal

The field data as a decimal value. If the field data is not numeric, 0 is returned.

GetPlaintext()

Gets the field data in plain text format.

string GetPlaintext()

Returns

string

The field data in plain text format.

GetStringListValue()

Gets the field data as a list of enum string values.

string[] GetStringListValue()

Returns

string[]

The field data.

Remarks

This method can be used to get the list of items selected in checked ComboBox fields.

Id()

Gets the field's ID.

string Id()

Returns

string

The field's ID.

IsEmpty()

Checks if the field has a value.

bool IsEmpty()

Returns

bool

True if and only if the field has a value.

IsHidden()

Returns true if and only if all references to this field are hidden.

bool IsHidden()

Returns

bool

True if and only if all references to this field are hidden.

SetDateValue(object)

Sets the field data as a DateTime value.

void SetDateValue(object dateValue)

Parameters

dateValue object

The field data. To clear the field, null should be specified.

SetNumericValue(decimal)

Sets the field data as a decimal value.

void SetNumericValue(decimal numericValue)

Parameters

numericValue decimal

The field data.

SetPlainText(string)

Sets the field data in plain text format.

void SetPlainText(string plainText)

Parameters

plainText string

The field data in plain text format.

SetStringListValue(string[])

Sets the field data as a list of enum string values.

void SetStringListValue(string[] stringListValue)

Parameters

stringListValue string[]

The field data.

Remarks

This method can be used to set the list of items selected in checked ComboBox fields.

Title()

Gets the field's title.

string Title()

Returns

string

The field's title.