Class DataStoreImageListFieldIntegrationClient
- Namespace
- Sfrep.AppraiseIt.Client.Integration.DataStore.Fields
- Assembly
- Sfrep.AppraiseIt.Client.Integration.dll
Encapsulates a image list field in the dynamic data store.
public sealed class DataStoreImageListFieldIntegrationClient : DataStoreFieldIntegrationClientBase, IDisposable- Inheritance
-
objectDataStoreImageListFieldIntegrationClient
- Implements
- Inherited Members
-
object.Equals(object)object.Equals(object, object)object.GetHashCode()object.GetType()object.ReferenceEquals(object, object)object.ToString()
Properties
DataItemCount
Gets the number of images in this field's data list.
public int DataItemCount { get; }Property Value
- int
SupportedLabels
Gets the list of image label values that are supported by this field.
public IReadOnlyList<string> SupportedLabels { get; }Property Value
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.
public IReadOnlyList<string> SupportedPrintLayouts { get; }Property Value
- IReadOnlyList<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
Methods
AddDataItem(string, string, string, ImageDataIntegrationClient)
Adds an image to this image list.
public ImageListFieldDataIntegrationClient AddDataItem(string label, string caption, string printLayout, ImageDataIntegrationClient data)Parameters
labelstringThe 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
captionstringThe image's caption.
printLayoutstringThe 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
dataImageDataIntegrationClientThe image data.
Returns
- ImageListFieldDataIntegrationClient
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.
Dispose(bool)
Frees resources used by this instance.
protected override void Dispose(bool disposing)Parameters
disposingboolTrue if called by the Dispose() method. False if called by the finalizer.
GetDataItem(int)
Gets the image data item at the specified index.
public ImageListFieldDataIntegrationClient GetDataItem(int index)Parameters
indexintThe image data item's index.
Returns
- ImageListFieldDataIntegrationClient
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.
RemoveDataItem(int)
Removes the specified image from the image list.
public void RemoveDataItem(int index)Parameters
indexintThe image's index.