Table of Contents

Class DataStoreNestedRepeatableRowGroupItemIntegrationClient

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

A nested repeatable row group item in the dynamic data store.

public sealed class DataStoreNestedRepeatableRowGroupItemIntegrationClient : DataStoreIntegrationClientBase, IDisposable
Inheritance
object
DataStoreNestedRepeatableRowGroupItemIntegrationClient
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()

Properties

NestedRowGroupIndex

Gets the index of this item in its parent nested repeatable row group.

public int NestedRowGroupIndex { get; }

Property Value

int

Methods

Clear()

Clears all field data in this nested repeatable row group item.

public void Clear()

Dispose(bool)

Frees resources used by this instance.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if called by the Dispose() method. False if called by the finalizer.

GetCheckBoxField(string, string)

Gets the specified checkbox field.

public DataStoreCheckBoxFieldIntegrationClient GetCheckBoxField(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

DataStoreCheckBoxFieldIntegrationClient

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 = "None")

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 DataStoreImageFieldIntegrationClient GetImageField(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

DataStoreImageFieldIntegrationClient

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 ImageDataIntegrationClient GetImageFieldData(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

ImageDataIntegrationClient

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 DataStoreImageListFieldIntegrationClient GetImageListField(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

DataStoreImageListFieldIntegrationClient

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.

GetTextField(string, string)

Gets the specified text field.

public DataStoreTextFieldIntegrationClient GetTextField(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

DataStoreTextFieldIntegrationClient

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 DateTime? GetTextFieldDateValue(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

DateTime?

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 = "None")

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 IReadOnlyList<string> GetTextFieldStringListValue(string id, string signatureType = "None")

Parameters

id string

The field's ID.

signatureType string

The field's signature section type.

Returns

IReadOnlyList<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 = "None")

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 = "None")

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, ImageDataIntegrationClient, string)

Sets the specified image field's data.

public void SetImageFieldData(string id, ImageDataIntegrationClient data, string signatureType = "None")

Parameters

id string

The field's ID.

data ImageDataIntegrationClient

The field's data.

signatureType string

The field's signature section type.

SetTextFieldDate(string, DateTime?, string)

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

public void SetTextFieldDate(string id, DateTime? data, string signatureType = "None")

Parameters

id string

The field's ID.

data DateTime?

The field data in DateTime format.

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 = "None")

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, IReadOnlyList<string>, string)

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

public void SetTextFieldStringListValue(string id, IReadOnlyList<string> data, string signatureType = "None")

Parameters

id string

The field's ID.

data IReadOnlyList<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 = "None")

Parameters

id string

The field's ID.

data string

The field data in plain text format.

signatureType string

The field's signature section type.