Table of Contents

Class FieldsIndexIntegrationCom

Namespace
Sfrep.AppraiseIt.Client.Integration.Com.DataStore
Assembly
Sfrep.AppraiseIt.Client.Integration.Com.dll

Provides access to a property element's (e.g., property, structure, outbuilding, or unit) field data in the dynamic data store.

[ComVisible(true)]
[Guid("2A8D3FC9-EED3-4B1E-9EEC-EF97CECDE76D")]
[ClassInterface(ClassInterfaceType.None)]
public sealed class FieldsIndexIntegrationCom : IFieldsIndexIntegrationCom, IDisposable
Inheritance
object
FieldsIndexIntegrationCom
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()

Constructors

FieldsIndexIntegrationCom()

This no args constructor is required for COM support and should not be called directly.

public FieldsIndexIntegrationCom()

Methods

Clear(bool)

Clears all field data in this instance.

public void Clear(bool clearImages)

Parameters

clearImages bool

True if and only if image and image list field data will be cleared.

Data for image and image list fields that occur in repeatable row groups or nested repeatable row groups is always cleared.

Dispose()

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

public void Dispose()

GetCheckBoxField(string, string)

Gets the specified checkbox field.

public IDataStoreCheckBoxFieldIntegrationCom GetCheckBoxField(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

IDataStoreCheckBoxFieldIntegrationCom

The specified checkbox field, if it exists. If the field does not exist, null is returned.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetCheckBoxFieldData(string, string)

Gets the specified checkbox field's data.

public bool GetCheckBoxFieldData(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

bool

True if and only if the checkbox field is checked.

GetImageField(string, string)

Gets the specified image field.

public IDataStoreImageFieldIntegrationCom GetImageField(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

IDataStoreImageFieldIntegrationCom

The specified image field, if it exists. If the field does not exist, null is returned.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetImageFieldData(string, string)

Gets the specified image field's data.

public IImageDataIntegrationCom GetImageFieldData(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

IImageDataIntegrationCom

The field's data. If the field does not have any data set, null is returned.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetImageListField(string, string)

Gets the specified image list field.

public IDataStoreImageListFieldIntegrationCom GetImageListField(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

IDataStoreImageListFieldIntegrationCom

The specified image list field, if it exists. If the field does not exist, null is returned.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetRowGroup(string)

Gets the specified repeatable row group.

public IDataStoreRepeatableRowGroupIntegrationCom GetRowGroup(string rowGroupId)

Parameters

rowGroupId string

The row group ID.

Returns

IDataStoreRepeatableRowGroupIntegrationCom

The repeatable row group, if exists. If the repeatable row group does not exist, null is returned.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetTextField(string, string)

Gets the specified text field.

public IDataStoreTextFieldIntegrationCom GetTextField(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

IDataStoreTextFieldIntegrationCom

The specified text field, if it exists. If the field does not exist, null is returned.

Remarks

Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.

GetTextFieldDateValue(string, string)

Gets the value of the specified text field in DateTime format.

public object GetTextFieldDateValue(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

object

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

GetTextFieldNumericValue(string, string)

Gets the value of the specified text field in decimal format.

public decimal GetTextFieldNumericValue(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

decimal

The field's data in decimal format. If the data cannot be parsed into a decimal, 0 is returned.

GetTextFieldStringListValue(string, string)

Gets the specified text field's data as a list of enum string values.

public string[] GetTextFieldStringListValue(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

string[]

The field data.

Remarks

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

GetTextFieldText(string, string)

Gets the value of the specified text field in plain text format.

public string GetTextFieldText(string id, string signatureType)

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

string

The field's data in plain text format.

SetCheckBoxFieldData(string, bool, string)

Sets the specified checkbox field's data.

public void SetCheckBoxFieldData(string id, bool data, string signatureType)

Parameters

id string

The field's ID.

data bool

True if the checkbox field should be checked. False if the checkbox field should be unchecked.

signatureType string

The field's signature section type.

SetImageFieldData(string, IImageDataIntegrationCom, string)

Sets the specified image field's data.

public void SetImageFieldData(string id, IImageDataIntegrationCom data, string signatureType)

Parameters

id string

The field's ID.

data IImageDataIntegrationCom

The field's data.

signatureType string

The field's signature section type.

SetTextFieldDate(string, object, string)

Sets the specified text field's data in DateTime format.

public void SetTextFieldDate(string id, object data, string signatureType)

Parameters

id string

The field's ID.

data object

The field data in DateTime format. Specifying null will clear the field data.

signatureType string

The field's signature section type.

SetTextFieldNumeric(string, decimal, string)

Sets the specified text field's data in decimal format.

public void SetTextFieldNumeric(string id, decimal data, string signatureType)

Parameters

id string

The field's ID.

data decimal

The field data in decimal format.

signatureType string

The field's signature section type.

SetTextFieldStringListValue(string, string[], string)

Sets the specified text field's data as a list of enum string values.

public void SetTextFieldStringListValue(string id, string[] data, string signatureType)

Parameters

id string

The field's ID.

data string[]

The field data.

signatureType string

The field's signature section type.

Remarks

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

SetTextFieldText(string, string, string)

Sets the specified text field's data in plain text format.

public void SetTextFieldText(string id, string data, string signatureType)

Parameters

id string

The field's ID.

data string

The field data in plain text format.

signatureType string

The field's signature section type.