Class IntegrationCom

Namespace: Sfrep.AppraiseIt.Client.Integration.Com

Assembly: Sfrep.AppraiseIt.Client.Integration.Com.dll

Encapsulates a client connection to Appraise-It's integration StreamJsonRpc API.

[ComVisible(true)]
[Guid("83CB43E0-8001-4AA0-A57F-6B8B5FE0ED2A")]
[ClassInterface(ClassInterfaceType.None)]
public sealed class IntegrationCom : IIntegrationCom2, IIntegrationCom, IDisposable

Inheritance: object

IntegrationCom

Implements: IIntegrationCom2

IIntegrationCom

IDisposable

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Constructors

IntegrationCom()

Creates a new IntegrationCom instance.

public IntegrationCom()

Methods

AddComparables(string)

Attempts to add an additional comparables addendum to the report.

public bool AddComparables(string compType)

Parameters

compType string

The comparable type to count.

CompType values are formatted as strings to ensure compatibility between Appraise-It versions.

Returns

bool: True if and only if the requested additional comparables addendum was successfully added to the report. Otherwise, false.

AddForm(string, bool)

Adds a form to the report.

public int AddForm(string formId, bool showForm)

Parameters

formId string: The ID of the form to add.
showForm bool: True if and only if the form should be shown after it is added.

Returns

int: The new form's Form.Index.

BeginTransaction()

Begins an integration transaction session with Appraise-It. This method waits for any other pending transaction to complete before returning.

public void BeginTransaction()

ClearComparable(string, int)

Clears all data associated with the specified comparable.

public void ClearComparable(string compType, int compIndex)

Parameters

compType string: The comparable type.
compIndex int: The comparable index.

ClearForm(string, int)

Clears the specified form.

public void ClearForm(string formId, int formIndex)

Parameters

formId string: The form's ID.
formIndex int: The form's index.

Close()

Releases all resources used by this instance.

public void Close()

CreateNewReport(string)

Creates a new report.

public void CreateNewReport(string primaryFormId)

Parameters

primaryFormId string: The new report's primary form ID.

CreatePdf(string, bool[], int[])

Generates a PDF of the report.

public void CreatePdf(string savePdfPath, bool[] pageSelection, int[] pageOrder)

Parameters

savePdfPath string: The path to save the PDF file.
pageSelection bool[]: A bool array indicating the pages that should be included in the PDF. The array indices correspond with the page names returned by PageNames.
pageOrder int[]: An int array indicating the order of the pages to print. The array indices correspond with the page names returned by PageNames.

Dispose()

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

public void Dispose()

EndTransaction()

Ends the current transaction.

public void EndTransaction()

FormCount()

Gets the number of forms in the report.

public int FormCount()

Returns

int

FormIsRepeatable(string)

Checks if the specified form is repeatable.

public bool FormIsRepeatable(string formId)

Parameters

formId string: The form's ID.

Returns

bool: True if and only if the the specified form is repeatable.

GetCheckBoxFieldValue(string, string, int, int, string)

Retrieves the value for the first matching checkbox field in the report.

public bool GetCheckBoxFieldValue(string signatureType, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.

Returns

bool: The value for the first matching non-repeatable checkbox field in the report, if any. If no matching field is found, false is returned.

Remarks

This method cannot be used to get the value of repeatable fields.

GetCheckBoxFieldValueForForm(string, int, string, string, int, int, string)

Retrieves the value for the first matching checkbox field in the form.

public bool GetCheckBoxFieldValueForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' comparable index.
fieldId string: The fields' ID.

Returns

bool: The value for the first matching checkbox field in the form, if any. If no matching field is found, false is returned.

GetCompCount(string, bool)

Gets the number of comparables of the specified type that appear in the report.

public int GetCompCount(string compType, bool forPhotoAddenda)

Parameters

compType string: The comparable type to count.
forPhotoAddenda bool: True if the comparable photo addenda should be used to determine the comparable count. False if the comparable grid addenda should be used to determine the comparable count.

Returns

int: The comparable count.

GetCompIndexes(string, bool)

Gets the list of comparable indexes of the specified type that appear in the report.

public int[] GetCompIndexes(string compType, bool forPhotoAddenda)

Parameters

compType string: The comparable type to determine indexes for.
forPhotoAddenda bool: True if the comparable photo addenda should be used to determine the comparable indexes. False if the comparable grid addenda should be used to determine the comparable indexes.

Returns

int[]: The comparable indexes.

GetCompTypes(bool)

Gets a list of comparable types that appear in the report.

public string[] GetCompTypes(bool forPhotoAddenda)

Parameters

forPhotoAddenda bool: True if the comparable photo addenda should be used to determine the list of comparable types. False if the comparable grid addenda should be used to determine the list of comparable types.

Returns

string[]: The list of comparable types that appear in the report.

GetDataStore()

Gets a reference to the data store that manages report data on dynamic forms.

public IDataStoreIntegrationCom GetDataStore()

Returns

IDataStoreIntegrationCom: The dynamic data store.

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.

GetFieldTitle(string, int, int, int, int, int, string)

Gets the title for the specified field.

[Obsolete("This method is deprecated.  Use the GetFieldTitle overload that takes signatureType and compType parameters as strings instead.", false)]
public string GetFieldTitle(string formId, int formIndex, int signatureType, int compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId string: The form ID.
formIndex int: The form index.
signatureType int: The field's signature type.
compType int: The field's comparable type.
compIndex int: The field's comparable index.
unitIndex int: The field's unit index. If there is no unit index, this should be 0.
fieldId string: The field's ID.

Returns

string: The field's title.

Remarks

This method is deprecated. Use the GetFieldTitle overload that takes signatureType and compType parameters as strings instead.

GetFieldTitle2(string, int, string, string, int, int, string)

Gets the title for the specified field.

public string GetFieldTitle2(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId string: The form ID.
formIndex int: The form index.
signatureType string: The field's signature type.
compType string: The field's comparable type.
compIndex int: The field's comparable index.
unitIndex int: The field's unit index. If there is no unit index, this should be 0.
fieldId string: The field's ID.

Returns

string: The field's title.

GetFormId(int)

Gets the ID of the form at the specified form position in the report.

public string GetFormId(int formPosition)

Parameters

formPosition int: The position of the form in the report.

Returns

string: The ID of the form at the specified form position in the report.

GetFormIndex(int)

Gets the form index of the form at the specified form position in the report.

public int GetFormIndex(int formPosition)

Parameters

formPosition int: The position of the form in the report.

Returns

int: The form index of the form at the specified form position in the report.

GetFormInstanceCount(string)

Gets the number of times the specified form appears in the report.

public int GetFormInstanceCount(string formId)

Parameters

formId string: The form ID.

Returns

int: The number of times the specified form appears in the report.

GetFormPageCount(int)

Gets the page count of the form at the specified form position in the report.

public int GetFormPageCount(int formPosition)

Parameters

formPosition int: The position of the form in the report.

Returns

int: The page count of the form at the specified form position in the report.

GetFormTitle(string, int)

Gets the title for the specified form.

public string GetFormTitle(string formId, int formIndex)

Parameters

formId string: The form ID.
formIndex int: The form's index.

Returns

string: The form's title.

GetImageFieldValue(string, string, int, int, string, ref byte[], ref string)

Retrieves the value for the first matching image field in the report.

public void GetImageFieldValue(string signatureType, string compType, int compIndex, int unitIndex, string fieldId, ref byte[] data, ref string fileExtension)

Parameters

signatureType string: The field's signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.
data byte[]: Set to the data for the first matching non-repeatable image field in the report, if any. If no matching field is found, null is returned.
fileExtension string: Set to the file extension for the first matching non-repeatable image field in the report, if any. If no matching field is found, null is returned.

Remarks

This method cannot be used to get the value of repeatable fields.

GetImageFieldValueForForm(string, int, string, string, int, int, string, ref byte[], ref string)

Retrieves the value for the first matching image field in the form.

public void GetImageFieldValueForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId, ref byte[] data, ref string fileExtension)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The field's signature type.
compType string: The field's comparable type.
compIndex int: The field's comparable index.
unitIndex int: The field's unit index.
fieldId string: The fields' ID.
data byte[]: Returns the image data for the first matching image field in the form, if any. If no matching field is found, null is returned.
fileExtension string: Returns the file extension for the first matching image field in the form, if any. If no matching field is found, null is returned.

GetLabelTextFieldId(string, int, string)

Gets the ID of the text field that is used to label the specified image field.

public string GetLabelTextFieldId(string formId, int formIndex, string imageFieldId)

Parameters

formId string: The form ID.
formIndex int: The form's index.
imageFieldId string: The image field ID.

Returns

string: The ID of the label text field. If no label text field is associated with the specified image field, null is returned.

Remarks

This method is only supported for fields having CompType = None and SignatureType = None.

GetManagedImageFieldIds(string, int)

Gets the list of image field IDs on the specified form that are supported by Comp Manager, Image Manager, etc.

public string[] GetManagedImageFieldIds(string formId, int formIndex)

Parameters

formId string: The form ID.
formIndex int: The form's index.

Returns

string[]: The list of managed image field IDs on the specified form. If the form contains no managed image fields, an empty array is returned.

Remarks

Only non-comparable fields are included.

GetSignatureFieldImage(string, out byte[], out string)

Gets the signature image for the specified signature field.

public void GetSignatureFieldImage(string signatureType, out byte[] data, out string fileExtension)

Parameters

signatureType string: The signature type.
data byte[]: Returns the image data for the first matching signature field in the report, if any. If no matching field is found, null is returned.
fileExtension string: Returns the file extension for the first matching signature field in the report, if any. If no matching field is found, null is returned.

GetSignatureTypes()

Gets a list of signature types that appear in the report.

public string[] GetSignatureTypes()

Returns

string[]: The list of signature types that appear in the report.

GetTextFieldText(string, string, int, int, string)

Retrieves the value for the first matching text field in the report in plain text format.

public string GetTextFieldText(string signatureType, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.

Returns

string: The plain text value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the empty string is returned.

Remarks

This method cannot be used to get the value of repeatable fields.

GetTextFieldTextForForm(string, int, string, string, int, int, string)

Retrieves the value for the first matching text field in the form in plain text format.

public string GetTextFieldTextForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.

Returns

string: The plain text value for the first matching text field in the form, if any. If no matching field is found, the empty string is returned.

HasForm(string, int)

Checks if the report contains the specified form.

public bool HasForm(string formId, int index)

Parameters

formId string: The form ID.
index int: The form's index.

Returns

bool: True if and only if the report contains the specified form.

HasOverflowingTextFields()

Checks if the report is a non-lender report.

public bool HasOverflowingTextFields()

Returns

bool

HasReport()

Checks if a report is currently opened.

public bool HasReport()

Returns

bool: True if a report is currently opened.

HasValidationWarnings()

Checks report validation to determine whether there are any validation warnings that must be addressed prior to completing the report.

public bool HasValidationWarnings()

Returns

bool: True if and only if there are validation warnings that must be addressed prior to completing the report.

ImportMismo(string, bool)

Imports the specified MISMO document into the report.

public void ImportMismo(string mismo, bool includeAdjustments)

Parameters

mismo string: The MISMO v.2.6 or MISMO v.2.6GSE document to import. MISMO v.2.4 is not supported.
includeAdjustments bool: True if and only if adjustments should be imported. Otherwise, false.

ImportMismo36(byte[], bool)

Imports the specified MISMO v.3.6 document into the report.

public void ImportMismo36(byte[] mismoPackage, bool includeAdjustments)

Parameters

mismoPackage byte[]: The MISMO v.3.6 zip file to import.
includeAdjustments bool: True if and only if adjustments should be imported. Otherwise, false.

InitializeForProcess(string, int)

Initializes an integration connection with the specified Appraise-It Pro instance.

public void InitializeForProcess(string clientName, int processId)

Parameters

clientName string: The name of the integrating application.
processId int: The process ID of the Appraise-It Pro instance to connect to.

InitializeWithPrompt(string)

Prompts the user with a dialog to specify an Appraise-It Pro instance to connect to and then initializes the connection.

public bool InitializeWithPrompt(string clientName)

Parameters

clientName string: The name of the integrating application.

Returns

bool: True if a connection with an Appraise-It Pro was established. False if the user canceled the dialog.

InsertPdfData(byte[])

Inserts the specified PDF data into a PDF addendum in the report.

public void InsertPdfData(byte[] pdfData)

Parameters

pdfData byte[]: The PDF data to insert.

InsertPdfFile(string)

Inserts the specified PDF file into a PDF addendum in the report.

public void InsertPdfFile(string pdfFilePath)

Parameters

pdfFilePath string: The path to the PDF file to insert.

InsertWordProcessingDocument(bool, string)

Inserts the specified word processing document into a word processing addendum in the report.

public void InsertWordProcessingDocument(bool useFormWithHeader, string filePath)

Parameters

useFormWithHeader bool: True if a word processing addendum with a subject header section should be used. False if a word processing addendum without a subject header section should be used.
filePath string: The path to the word processing file to insert.

IsDynamicReport()

Checks if the currently opened report's primary form is a dynamic form.

public bool IsDynamicReport()

Returns

bool: True if and only if the currently opened report's primary form is a dynamic form.

IsNonLenderReport()

Checks if the report is a non-lender report.

public bool IsNonLenderReport()

Returns

bool

IsRunning()

Returns true if and only if the Appraise-It instance is currently running.

public bool IsRunning()

Returns

bool

IsUadReport()

Checks if the currently opened report supports UAD.

public bool IsUadReport()

Returns

bool

PageNames()

Gets the list of page names in the report.

public string[] PageNames()

Returns

string[]

PageOrder()

Gets the report's current page print order.

public int[] PageOrder()

Returns

int[]: A list of ints indicating the order of pages in the report.

PageSelection()

Gets the report's current page selection.

public bool[] PageSelection()

Returns

bool[]

PrimaryFormId()

Gets the report's primary form ID.

public string PrimaryFormId()

Returns

string

ProcessId()

Gets the ID of the Appraise-It Pro process.

public int ProcessId()

Returns

int

RemoveAttachment(string)

Removes the specified attachment from the report.

public bool RemoveAttachment(string id)

Parameters

id string: The attachment ID.

Returns

bool: True if and only if an attachment having the specified ID was found and removed.

RemoveGeocode(string)

Removes geocode data associated with the specified street from the report.

public bool RemoveGeocode(string street)

Parameters

street string: The street address whose geocode data is to be removed.

Returns

bool: True if geocode data associated with the specified street was found and removed.

RenderFormAsJpegs(string, int)

Renders the specified form as a list of JPEG pages.

public string[] RenderFormAsJpegs(string formId, int formIndex)

Parameters

formId string: The ID of the form whose pages are to be rendered.
formIndex int: The index of the form whose pages are to be rendered.

Returns

string[]: A list of JPEGs as base-64 encoded data. Each JPEG is a rasterized page from the specified form.

ReportIsReadOnly()

Checks if the currently opened report is readonly.

public bool ReportIsReadOnly()

Returns

bool

ReportPath()

Gets the ID of the Appraise-It Pro process.

public string ReportPath()

Returns

string

SaveMismo241(string, string, bool[], int[])

Converts the report data to MISMO v.2.4.1 with an embedded PDF.

public void SaveMismo241(string mismoPath, string pdfPath, bool[] pageSelection, int[] pageOrder)

Parameters

mismoPath string: The path to save the MISMO document.
pdfPath string: The path to save the PDF document.
pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.
pageOrder int[]: An int array indicating the order of the pages to print. The array indices correspond with the page names returned by PageNames.

SaveMismo26(string, string, bool[], int[])

Converts the report data to MISMO v.2.6 with an embedded PDF.

public void SaveMismo26(string mismoPath, string pdfPath, bool[] pageSelection, int[] pageOrder)

Parameters

mismoPath string: The path to save the MISMO document.
pdfPath string: The path to save the PDF document.
pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.
pageOrder int[]: An int array indicating the order of the pages to print. The array indices correspond with the page names returned by PageNames.

SaveMismo26Gse(string, string, bool[], int[])

Converts the report data to MISMO v.2.6GSE with an embedded PDF.

public void SaveMismo26Gse(string mismoPath, string pdfPath, bool[] pageSelection, int[] pageOrder)

Parameters

mismoPath string: The path to save the MISMO document.
pdfPath string: The path to save the PDF document.
pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.
pageOrder int[]: An int array indicating the order of the pages to print. The array indices correspond with the page names returned by PageNames.

SaveMismo36(string, bool[], int[])

Converts the report data to a MISMO v.3.6 zip file.

public void SaveMismo36(string mismoPath, bool[] pageSelection, int[] pageOrder)

Parameters

mismoPath string

The path to save the MISMO v.3.6 zip file.

pageSelection bool[]

A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.

pageOrder int[]

An int array indicating the order of the pages to print. The array indices correspond with the page names returned by PageNames.

If this value is null, the default page order will be used.

SetAttachment(string, byte[], string)

Adds the specified attachment data to the report. If the specified attachment ID already exists, its data is replaced.

public void SetAttachment(string id, byte[] data, string description)

Parameters

id string: The attachment ID.
data byte[]: The attachment data.
description string: The attachment description.

SetCheckBoxFieldsValue(string, string, int, int, string, bool)

Sets the value for all matching checkbox fields in the report having the specified identifiers.

public void SetCheckBoxFieldsValue(string signatureType, string compType, int compIndex, int unitIndex, string fieldId, bool fieldData)

Parameters

signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.
fieldData bool: The new checkbox field value.

Remarks

Repeatable fields cannot be set using this method.

SetCheckBoxFieldsValueForForm(string, int, string, string, int, int, string, bool)

Sets the value for all matching checkbox fields in the form having the specified identifiers.

public void SetCheckBoxFieldsValueForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId, bool fieldData)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.
fieldData bool: The new checkbox field value.

SetGeocode(string, string, double, double, string)

Associates the specified geocode data with the report. If geocode data for the specified street already exists, it is replaced.

public void SetGeocode(string street, string source, double longitude, double latitude, string precision)

Parameters

street string: The location's street.
source string: The geocode data source.
longitude double: The location's longitude.
latitude double: The location's latitude.
precision string: The precision of the geocode data.

SetImageFieldsValue(string, string, int, int, string, byte[], string)

Sets the value for all of the image fields in the report having the specified identifiers.

public void SetImageFieldsValue(string signatureType, string compType, int compIndex, int unitIndex, string fieldId, byte[] data, string fileExtension)

Parameters

signatureType string: The field's signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The field's ID.
data byte[]: The binary image data.
fileExtension string: The image file's extension, including the leading '.'.

Remarks

Repeatable fields cannot be set using this method.

When setting an image for a comparable, this method attempts to automatically add the comparable photos addendum if it is missing.

SetImageFieldsValueForForm(string, int, string, string, int, int, string, byte[], string)

Sets the value for all of the image fields in the form having the specified identifiers.

public void SetImageFieldsValueForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId, byte[] data, string fileExtension)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The field's signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.
data byte[]: The binary image data.
fileExtension string: The image file's extension, including the leading '.'.

SetImageFieldsValueFromFile(string, string, int, int, string, string)

Sets the value for all of the image fields in the report having the specified identifiers.

public void SetImageFieldsValueFromFile(string signatureType, string compType, int compIndex, int unitIndex, string fieldId, string filePath)

Parameters

signatureType string: The field's signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The field's ID.
filePath string: The path to the image file.

Remarks

Repeatable fields cannot be set using this method.

When setting an image for a comparable, this method attempts to automatically add the comparable photos addendum if it is missing.

SetImageFieldsValueFromFileForForm(string, int, string, string, int, int, string, string)

Sets the value for all of the image fields in the form having the specified identifiers.

public void SetImageFieldsValueFromFileForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId, string filePath)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The field's signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.
filePath string: The path to the image file.

SetTextFieldsText(string, string, int, int, string, string)

Sets the value for all matching text fields in the report having the specified identifiers.

public void SetTextFieldsText(string signatureType, string compType, int compIndex, int unitIndex, string fieldId, string text)

Parameters

signatureType string: The fields' signature type.
compType string: The fields' comparable index.
compIndex int: The fields' unit index.
unitIndex int: The fields' unit index.
fieldId string: The fields' ID.
text string: The new text field value in plain text format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsTextForForm(string, int, string, string, int, int, string, string)

Sets the value for all matching text fields on the specified form having the specified identifiers.

public void SetTextFieldsTextForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int unitIndex, string fieldId, string text)

Parameters

formId string: The form's ID.
formIndex int: The form's index.
signatureType string: The fields' signature type.
compType string: The fields' comparable type.
compIndex int: The fields' comparable index.
unitIndex int: The fields' unit index.
fieldId string: The field's ID.
text string: The new text field value in plain text format.

ShowForm(string, int)

Displays the specified form.

public void ShowForm(string formId, int formIndex)

Parameters

formId string: The form's ID.
formIndex int: The form's index.

SupportsAIReady()

Checks if the report supports AIReady.

public bool SupportsAIReady()

Returns

bool

SupportsDynamicPropertyEditor()

Checks if the currently opened report supports managing structures, outbuildings, and units in the dynamic data store.

public bool SupportsDynamicPropertyEditor()

Returns

bool: True if and only if the currently opened report supports managing structures, outbuildings, and units in the dynamic data store.

SupportsMismo241()

Checks if the report supports MISMO v.2.4.1.

public bool SupportsMismo241()

Returns

bool

SupportsMismo26()

Checks if the report supports MISMO v.2.6 Errata 1.

public bool SupportsMismo26()

Returns

bool

SupportsMismo26Gse()

Checks if the report supports MISMO v.2.6 GSE.

public bool SupportsMismo26Gse()

Returns

bool

SupportsMismo26GseForAppraiserGenieCloud()

Checks if the report supports the Appraiser Genie Cloud export.

public bool SupportsMismo26GseForAppraiserGenieCloud()

Returns

bool: True if the report supports the Appraiser Genie Cloud export.

SupportsMismo36()

Checks if the report supports MISMO v.3.6.

public bool SupportsMismo36()

Returns

bool

ToMismo241(bool[])

Converts the report data to MISMO v.2.4.1 without an embedded PDF.

public string ToMismo241(bool[] pageSelection)

Parameters

pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.

Returns

string: The MISMO data.

ToMismo26(bool[])

Converts the report data to MISMO v.2.6 without an embedded PDF.

public string ToMismo26(bool[] pageSelection)

Parameters

pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.

Returns

string: The MISMO data.

ToMismo26Gse(bool[])

Converts the report data to MISMO v.2.6GSE without an embedded PDF.

public string ToMismo26Gse(bool[] pageSelection)

Parameters

pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.

Returns

string: The MISMO data.

ToMismo26GseForAppraiserGenieCloud()

Converts the report data to MISMO v.2.6GSE without an embedded PDF.

public string ToMismo26GseForAppraiserGenieCloud()

Returns

string: The MISMO data.

Remarks

This conversion is customized for Appraiser Genie Cloud and can be used with non-UAD report types.
Only the primary form is converted.

ToMismo36(bool[], int[])

Converts the report data to a MISMO v.3.6 zip file.

public byte[] ToMismo36(bool[] pageSelection, int[] pageOrder)

Parameters

pageSelection bool[]

A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.

pageOrder int[]

An int array indicating the order of the pages to print. The array indices correspond with the page names returned by PageNames.

If this value is null, the default page order will be used.

Returns

byte[]: The MISMO v.3.6 zip file as a byte array.

ToOadi(bool[], string)

Converts the report data to a set of OADI XML documents (for AIReady/AppraisalPort).

[Obsolete("Conversion to OADI XML is not supported through COM.")]
public void ToOadi(bool[] pageSelection, string destinationFolder)

Parameters

pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.
destinationFolder string: The folder to save the OADI XML documents to. If this path does not exist, it will be created.

Remarks

This method is not supported by the COM integration and will throw a NotSupportedException.

Exceptions

NotSupportedException: Thrown when invoked as conversion to OADI is not supported by the COM integration.

TransferSketchData(ISketchAndAreaDataCom)

Transfers the specified sketch data to the report.

public void TransferSketchData(ISketchAndAreaDataCom data)

Parameters

data ISketchAndAreaDataCom: The sketch data.

Remarks

This method only supports dynamic / UAD 3.6 report types.

TryGetAttachment(string, ref byte[], ref string)

Attempts to retrieve the specified attachment from the report.

public bool TryGetAttachment(string id, ref byte[] data, ref string description)

Parameters

id string: The attachment ID.
data byte[]: On success, this is set to the attachment data.
description string: On success, this is set to the attachment description.

Returns

bool: True if and only if an attachment was found having the specified ID.

TryGetGeocode(string, ref string, ref double, ref double, ref string)

Attempts to retrieve geocode data for the specified street from the report.

public bool TryGetGeocode(string street, ref string source, ref double longitude, ref double latitude, ref string precision)

Parameters

street string: The location's street.
source string: On success, this is set to the geocode data source.
longitude double: On success, this is set to the location's longitude.
latitude double: On success, this is set to the location's latitude.
precision string: On success, this is set to the precision of the geocode data.

Returns

bool: True if geocode data was found for the specified street. Otherwise, false.

ValidateOadi(bool[])

Validates the report for the OADI conversion (for AIReady/AppraisalPort).
This method is not supported by the COM integration and will throw a NotSupportedException.

[Obsolete("Validation of OADI XML is not supported through COM.")]
public string[] ValidateOadi(bool[] pageSelection)

Parameters

pageSelection bool[]: A bool array indicating the pages that should be included. The array indices correspond with the page names returned by PageNames.

Returns

string[]: A list of validation warnings. If there are no validation warnings, the list will be empty.

Remarks

This method is not supported by the COM integration and will throw a NotSupportedException.

Exceptions

NotSupportedException: Thrown when invoked as conversion to OADI is not supported by the COM integration.

Events

ProcessExited

Raised when Appraise-It is closed.

public event EventHandler ProcessExited

Event Type

EventHandler

ReportClosed

Raised when a report is closed.

public event EventHandler ReportClosed

Event Type

EventHandler

ReportLoaded

Raised when a report is loaded.

public event EventHandler ReportLoaded

Event Type

EventHandler

Table of Contents

Class IntegrationCom

Constructors

IntegrationCom()

Methods

AddComparables(string)

Parameters

Returns

AddForm(string, bool)

Parameters

Returns

BeginTransaction()

ClearComparable(string, int)

Parameters

ClearForm(string, int)

Parameters

Close()

CreateNewReport(string)

Parameters

CreatePdf(string, bool[], int[])

Parameters

Dispose()

EndTransaction()

FormCount()

Returns

FormIsRepeatable(string)

Parameters

Returns

GetCheckBoxFieldValue(string, string, int, int, string)

Parameters

Returns

Remarks

GetCheckBoxFieldValueForForm(string, int, string, string, int, int, string)

Parameters

Returns

GetCompCount(string, bool)

Parameters

Returns

GetCompIndexes(string, bool)

Parameters

Returns

GetCompTypes(bool)

Parameters

Returns

GetDataStore()

Returns

Remarks

GetFieldTitle(string, int, int, int, int, int, string)

Parameters

Returns

Remarks

GetFieldTitle2(string, int, string, string, int, int, string)

Parameters

Returns

GetFormId(int)

Parameters

Returns

GetFormIndex(int)

Parameters

Returns

GetFormInstanceCount(string)

Parameters

Returns

GetFormPageCount(int)

Parameters

Returns

GetFormTitle(string, int)

Parameters

Returns

GetImageFieldValue(string, string, int, int, string, ref byte[], ref string)

Parameters

Remarks

GetImageFieldValueForForm(string, int, string, string, int, int, string, ref byte[], ref string)

Parameters

GetLabelTextFieldId(string, int, string)

Parameters

Returns

Remarks

GetManagedImageFieldIds(string, int)

Parameters