Interface IDataStoreIntegrationCom

Namespace

Sfrep.AppraiseIt.Client.Integration.Com.DataStore

Assembly

Sfrep.AppraiseIt.Client.Integration.Com.dll

Provides access to the data store that manages report data on dynamic forms.

[ComVisible(true)]
[Guid("063EA171-ED94-4BCB-A02B-3AFA3440DEDB")]
public interface IDataStoreIntegrationCom : IDisposable

Methods

AddComp(string)

Adds a comparable of the specified type.

IFieldsContainerIntegrationComBase AddComp(string compType)

Parameters

compType string

The comparable type to add.

Returns

IFieldsContainerIntegrationComBase

The new comparable.

If compType is RentalComparables, an instance of IRentalFieldsContainerIntegrationCom is returned. An instance of IPropertyFieldsContainerIntegrationCom is returned for all other CompTypes.

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.

ClearComp(string, int, bool)

Clears the specified comparable.

void ClearComp(string compType, int compIndex, bool clearImages)

Parameters

compType string

The comparable type.

compIndex int

The 0-based comparable index.

clearImages bool

True if and only if the comparables images should also be cleared.

Note that images and image list fields that occur in repeatable row groups will always be cleared.

CompTypes()

Gets the list of comparable types that are available on dynamic forms.

string[] CompTypes()

Returns

string[]

The list of comparable types that are available on dynamic forms.

Dispose()

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

void Dispose()

GetComp(string, int)

Gets the comparable at the specified index.

IFieldsContainerIntegrationComBase GetComp(string compType, int compIndex)

Parameters

compType string

The comparable type.

compIndex int

The 0-based comparable index.

Returns

IFieldsContainerIntegrationComBase

The comparable at the specified index.

If compType is RentalComparables, an instance of IRentalFieldsContainerIntegrationCom is returned. An instance of IPropertyFieldsContainerIntegrationCom is returned for all other CompTypes.

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.

GetCompCount(string)

Gets the number of comparables of the specified type on dynamic forms.

int GetCompCount(string compType)

Parameters

compType string

The comparable type.

Returns

int

The number of comparables of the specified type on dynamic forms.

GetImageData(int)

Gets the image data having the specified ID.

IImageDataIntegrationCom GetImageData(int id)

Parameters

id int

The image ID.

Returns

IImageDataIntegrationCom

The image data, if it exists. If the image data 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.

GetReportFields()

Gets general report and subject data used by dynamic forms.

IPropertyFieldsContainerIntegrationCom GetReportFields()

Returns

IPropertyFieldsContainerIntegrationCom

The general report and subject data used by dynamic forms.

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.

HasCompType(string)

Checks if the specified comparable type is available on dynamic forms.

bool HasCompType(string compType)

Parameters

compType string

The comparable type.

Returns

bool

True if and only if the comparable type is available on dynamic forms.

ImageDataIsUsed(IImageDataIntegrationCom)

Checks if the specified image data is used by an image fields or image list fields in the report.

bool ImageDataIsUsed(IImageDataIntegrationCom imageData)

Parameters

imageData IImageDataIntegrationCom

The image data.

Returns

bool

True if and only if the specified image data is used by any fields.

LoadImageData(byte[], string)

Loads the specified image data.

IImageDataIntegrationCom LoadImageData(byte[] data, string fileExtension)

Parameters

data byte[]

The image file data.

fileExtension string

The image file's extension, with the leading period.

Returns

IImageDataIntegrationCom

The loaded image data.

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.

LoadImageFile(string)

Loads the image data from the specified file.

IImageDataIntegrationCom LoadImageFile(string filePath)

Parameters

filePath string

The path to the image file to load.

Returns

IImageDataIntegrationCom

The loaded image data.

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.

MoveComp(string, int, int)

Moves the specified comparable.

void MoveComp(string compType, int sourceCompIndex, int destinationCompIndex)

Parameters

compType string

The comparable type.

sourceCompIndex int

The 0-based source comparable index.

destinationCompIndex int

The 0-based destination comparable index.

RemoveComp(string, int)

Removes the specified comparable.

void RemoveComp(string compType, int compIndex)

Parameters

compType string

The comparable type.

compIndex int

The 0-based comparable index.

TryRemoveImageData(IImageDataIntegrationCom)

Removes the specified image data from the report data store.

bool TryRemoveImageData(IImageDataIntegrationCom imageData)

Parameters

imageData IImageDataIntegrationCom

The image data to remove.

Returns

bool

True if and only if the image data was successfully removed. False if the image data could not be removed because it is currently used by an image field or image list field.