Interface IPropertyFieldsContainerIntegrationCom
- Namespace
- Sfrep.AppraiseIt.Client.Integration.Com.DataStore
- Assembly
- Sfrep.AppraiseIt.Client.Integration.Com.dll
Encapsulates data for the subject or a comparable (excluding rental comparables) in the dynamic data store.
[ComVisible(true)]
[Guid("3ED98475-ECF8-430B-96AC-A842FC785221")]
public interface IPropertyFieldsContainerIntegrationCom : IFieldsContainerIntegrationComBase, IDisposable
Methods
AddOutbuilding(string, string)
Adds an outbuilding to this property.
IOutbuildingDataIntegrationCom AddOutbuilding(string outbuildingType, string outbuildingTypeOtherDescription)
Parameters
outbuildingTypestringThe outbuilding's type.
Supported values:
- None
- Barn
- Boathouse
- Bunkhouse
- EnclosedKennel
- Greenhouse
- GuestHouse
- IndoorRidingArena
- ManufacturedHome
- Office
- Other
- PoolHouse
- Shed
- Silo
- Stable
- StandaloneAdu
- Studio
- Workshop
outbuildingTypeOtherDescriptionstringThe outbuilding's description when it's outbuildingType is Other.
Returns
- IOutbuildingDataIntegrationCom
The newly added outbuilding.
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.
AddStructure(string, bool)
Adds a structure to this property.
IStructureDataIntegrationCom AddStructure(string name, bool isManufacturedHome)
Parameters
namestringThe structure's name.
isManufacturedHomeboolTrue if the structure is a manufactured home. Otherwise, false.
Returns
- IStructureDataIntegrationCom
The newly added structure.
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(bool)
Clears all field data for this property.
void Clear(bool clearImages)
Parameters
clearImagesboolTrue 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.
CompIndex()
Gets the property's 0-based comparable index.
int CompIndex()
Returns
- int
The comparable index. 0 is returned for the subject.
CompType()
Gets this property's comparable type.
string CompType()
Returns
- string
The comparable type. None is returned for the subject.
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
void Dispose()
GetFields()
Gets the field data for this property.
IFieldsIndexIntegrationCom GetFields()
Returns
- IFieldsIndexIntegrationCom
The field data for this property.
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.
GetOutbuilding(int)
Gets the specified outbuilding from this structure.
IOutbuildingDataIntegrationCom GetOutbuilding(int index)
Parameters
indexintThe outbuilding's index.
Returns
- IOutbuildingDataIntegrationCom
The outbuilding's 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.
GetStructure(int)
Gets the specified structure from this property.
IStructureDataIntegrationCom GetStructure(int index)
Parameters
indexintThe structure's index.
Returns
- IStructureDataIntegrationCom
The structure 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.
OutbuildingCount()
Gets the number of outbuildings in this property.
int OutbuildingCount()
Returns
- int
RemoveOutbuilding(int)
Removes the specified outbuilding from this property.
void RemoveOutbuilding(int index)
Parameters
indexintThe outbuilding's index.
RemoveStructure(int)
Removes the specified structure from this property.
void RemoveStructure(int index)
Parameters
indexintThe structure's index.
StructureCount()
Gets the number of structures in this property.
int StructureCount()
Returns
- int