Table of Contents

Interface IDataStoreImageListFieldIntegrationCom

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

Encapsulates a image list field in the dynamic data store.

[ComVisible(true)]
[Guid("06DE06D5-22C8-493D-9EE6-C34C67289883")]
public interface IDataStoreImageListFieldIntegrationCom : IDataStoreFieldIntegrationComBase, IDisposable

Methods

AddDataItem(string, string, string, IImageDataIntegrationCom)

Adds an image to this image list.

IImageListFieldDataIntegrationCom AddDataItem(string label, string caption, string printLayout, IImageDataIntegrationCom data)

Parameters

label string

The image's label. This must be one of the list of values returned by SupportedLabels.

Supported values:

  • None
  • AbsorptionRateGraph
  • AssignmentExhibit
  • CompletedConstruction
  • CostApproachExhibit
  • DisasterMitigationExhibit
  • DwellingExteriorExhibit
  • DwellingFront
  • DwellingRear
  • Encroachment
  • EnergyEfficientAndGreenFeaturesExhibit
  • FloorPlan
  • FunctionalObsolescenceExhibit
  • GrossRentMultiplierComparableMap
  • HighestAndBestUseExhibit
  • IncomeApproachExhibit
  • LandComparableMap
  • LegalDescription
  • ManufacturedHomeExhibit
  • ManufacturedHomeFinancingProgramEligibilityCertification
  • ManufacturedHomeHUDCertificationLabel
  • ManufacturedHomeHUDDataPlate
  • MarketAnalysisExhibit
  • MedianDaysOnMarketGraph
  • NoncontinuousArea
  • NonResidentialUse
  • OutbuildingExhibit
  • PercentOfDistressedSalesGraph
  • PermanentWaterfrontFeature
  • PriceTrendGraph
  • PriorSaleAndTransferHistoryExhibit
  • ProjectAmenity
  • ProjectDeficiency
  • ProjectExhibit
  • PropertyAccess
  • PropertyBoundaries
  • YearBuiltOfSalesGraph
  • ReconciliationExhibit
  • RentalComparableMap
  • RentalInformationExhibit
  • SalesComparableMap
  • SalesComparisonApproachExhibit
  • SalesContractExhibit
  • SiteCharacteristic
  • SiteExhibit
  • SiteInfluence
  • SubjectListingExhibit
  • SubjectPropertyAmenitiesExhibit
  • SubjectPropertyExhibit
  • SubjectPropertyImprovementSketch
  • SupplementalExhibit
  • UnitInteriorExhibit
  • ValuationCompletionExhibit
  • ValuationUpdateExhibit
  • VehicleStorageExhibit
  • View
  • WaterFrontage
caption string

The image's caption.

printLayout string

The image frame layout to use to display the image when printing.

Supported values:

  • BestFitAutomatically uses Photos, Graphs, or FullPage based on the image's aspect ratio.
  • Photos8 images per page in a 2x4 grid
  • Graphs3 images vertically stacked per page
  • FullPage1 image filling a legal sized page
data IImageDataIntegrationCom

The image data.

Returns

IImageListFieldDataIntegrationCom

The added image list data item.

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.

Clear()

Clear's the field's data.

void Clear()

DataItemCount()

Gets the number of images in this field's data list.

int DataItemCount()

Returns

int

The number of images in this field's data list.

Dispose()

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

void Dispose()

GetDataItem(int)

Gets the image data item at the specified index.

IImageListFieldDataIntegrationCom GetDataItem(int index)

Parameters

index int

The image data item's index.

Returns

IImageListFieldDataIntegrationCom

The image data item.

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.

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.

RemoveDataItem(int)

Removes the specified image from the image list.

void RemoveDataItem(int index)

Parameters

index int

The image's index.

SupportedLabels()

Gets the list of image label values that are supported by this field.

string[] SupportedLabels()

Returns

string[]

The list of supported image label values.

Remarks

Supported values:

  • None
  • AbsorptionRateGraph
  • AssignmentExhibit
  • CompletedConstruction
  • CostApproachExhibit
  • DisasterMitigationExhibit
  • DwellingExteriorExhibit
  • DwellingFront
  • DwellingRear
  • Encroachment
  • EnergyEfficientAndGreenFeaturesExhibit
  • FloorPlan
  • FunctionalObsolescenceExhibit
  • GrossRentMultiplierComparableMap
  • HighestAndBestUseExhibit
  • IncomeApproachExhibit
  • LandComparableMap
  • LegalDescription
  • ManufacturedHomeExhibit
  • ManufacturedHomeFinancingProgramEligibilityCertification
  • ManufacturedHomeHUDCertificationLabel
  • ManufacturedHomeHUDDataPlate
  • MarketAnalysisExhibit
  • MedianDaysOnMarketGraph
  • NoncontinuousArea
  • NonResidentialUse
  • OutbuildingExhibit
  • PercentOfDistressedSalesGraph
  • PermanentWaterfrontFeature
  • PriceTrendGraph
  • PriorSaleAndTransferHistoryExhibit
  • ProjectAmenity
  • ProjectDeficiency
  • ProjectExhibit
  • PropertyAccess
  • PropertyBoundaries
  • YearBuiltOfSalesGraph
  • ReconciliationExhibit
  • RentalComparableMap
  • RentalInformationExhibit
  • SalesComparableMap
  • SalesComparisonApproachExhibit
  • SalesContractExhibit
  • SiteCharacteristic
  • SiteExhibit
  • SiteInfluence
  • SubjectListingExhibit
  • SubjectPropertyAmenitiesExhibit
  • SubjectPropertyExhibit
  • SubjectPropertyImprovementSketch
  • SupplementalExhibit
  • UnitInteriorExhibit
  • ValuationCompletionExhibit
  • ValuationUpdateExhibit
  • VehicleStorageExhibit
  • View
  • WaterFrontage

SupportedPrintLayouts()

Gets the list of image frame print layouts that are supported by this image list field.

string[] SupportedPrintLayouts()

Returns

string[]

The list of supported image print layouts.

Supported values:

  • BestFitAutomatically uses Photos, Graphs, or FullPage based on the image's aspect ratio.
  • Photos8 images per page in a 2x4 grid
  • Graphs3 images vertically stacked per page
  • FullPage1 image filling a legal sized page

Title()

Gets the field's title.

string Title()

Returns

string

The field's title.