Class ScriptingProxy

Namespace

Sfrep.AppraiseIt.Model.Scripting

Assembly

cs.temp.dll.dll

ScriptingProxy implements the API used by scripts to interact with Appraise-It Pro.

public class ScriptingProxy

Inheritance

Object

ScriptingProxy

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Properties

CompTypes

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

public string[] CompTypes { get; }

Property Value

String[]

DataFolder

Gets the path to Appraise-It Pro's data folder.

public string DataFolder { get; }

Property Value

String

FieldIsSelected

True if and only if a text, checkbox, or image field is currently selected.

public bool FieldIsSelected { get; }

Property Value

Boolean

HasOverflowingTextFields

True if and only if the currently opened report has overflowing text in one or more text fields.

public bool HasOverflowingTextFields { get; }

Property Value

Boolean

HasValidationWarnings

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

public bool HasValidationWarnings { get; }

Property Value

Boolean

IsNonLenderReport

True if and only if the report's primary form is a non-lender form.

public bool IsNonLenderReport { get; }

Property Value

Boolean

IsUadReport

True if and only if the currently opened report supports UAD.

public bool IsUadReport { get; }

Property Value

Boolean

PrimaryFormId

The report's primary form ID.

public string PrimaryFormId { get; }

Property Value

String

ReportIsReadOnly

True if and only if the currently opened report is readonly.

public bool ReportIsReadOnly { get; }

Property Value

Boolean

ReportPath

The path to the currently opened report. If the report has not been saved to a file, the empty string is returned.

public string ReportPath { get; }

Property Value

String

SelectedCheckBoxField

Gets the currently selected checkbox field information.

public CheckBoxFieldProxy SelectedCheckBoxField { get; }

Property Value

CheckBoxFieldProxy

SelectedCompIndex

Gets the currently selected field's comparable index, if any. If no field is selected, 0 is returned.

public int SelectedCompIndex { get; }

Property Value

Int32

SelectedCompType

Gets the currently selected field's CompType, if any. If no field is selected, "None" is returned.

public string SelectedCompType { get; }

Property Value

String

SelectedFieldId

Gets the currently selected field's ID, if any. If no field is selected, the empty string is returned.

public string SelectedFieldId { get; }

Property Value

String

SelectedFormId

Gets the currently selected form ID, if any. If no form is selected, null is returned.

public string SelectedFormId { get; }

Property Value

String

SelectedFormIndex

Gets the currently selected form's index, if any. If no form is selected, 0 is returned.

public int SelectedFormIndex { get; }

Property Value

Int32

SelectedImageField

Gets the currently selected image field information.

public ImageFieldProxy SelectedImageField { get; }

Property Value

ImageFieldProxy

SelectedSignatureType

Gets the currently selected field's SignatureType, if any. If no field is selected, "None" is returned.

public string SelectedSignatureType { get; }

Property Value

String

SelectedTextField

Gets the currently selected text field information.

public TextFieldProxy SelectedTextField { get; }

Property Value

TextFieldProxy

SelectedUnitIndex

Gets the currently selected field's unit index, if any. If no field is selected or if the selected field does not have a unit index, 0 is returned.

public int SelectedUnitIndex { get; }

Property Value

Int32

SignatureTypes

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

public string[] SignatureTypes { get; }

Property Value

String[]

Methods

AddComparables(String)

Attempts to add an additional comparables addendum to the report.

public bool AddComparables(string compType)

Parameters

compType String

The type of comparables addendum to add.

Returns

Boolean

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

AddForm(String, Boolean)

Adds a form to the report.

public int AddForm(string formId, bool showForm)

Parameters

formId String

The ID of the form to add.

showForm Boolean

True if and only if the form should be shown after it is added.

Returns

Int32

The added form's zero-based index.

CheckBoxField(String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string fieldId)

Parameters

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, Int32, Int32, String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string compType, int compIndex, int unitIndex, string fieldId)

Parameters

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, Int32, String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string compType, int compIndex, string fieldId)

Parameters

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, Int32, String, Int32, Int32, String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string formId, int formIndex, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, Int32, String, Int32, String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string formId, int formIndex, string compType, int compIndex, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, Int32, String, String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

signatureType String

The fields' SignatureType.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, Int32, String, String, Int32, Int32, String)

Gets an object that provides access to all matching checkbox fields.

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

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

signatureType String

The fields' SignatureType.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

CheckBoxField(String, String)

Gets an object that provides access to all matching checkbox fields.

public CheckBoxFieldProxy CheckBoxField(string signatureType, string fieldId)

Parameters

signatureType String

The fields' SignatureType.

fieldId String

The fields' ID.

Returns

CheckBoxFieldProxy

A CheckBoxFieldProxy instance that provides access to all matching checkbox fields.

ClearComparable(String, Int32)

Clears all data associated with the specified comparable.

public void ClearComparable(string compType, int compIndex)

Parameters

compType String

The comparable type.

compIndex Int32

The comparable index.

ClearForm(String, Int32)

Clears the specified form.

public void ClearForm(string formId, int formIndex)

Parameters

formId String

The form's ID.

formIndex Int32

The form's index.

FormIsRepeatable(String)

Checks if the specified form is repeatable.

public bool FormIsRepeatable(string formId)

Parameters

formId String

The form's ID.

Returns

Boolean

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

GetAttachment(String)

Attempts to retrieve the specified attachment from the report.

public string GetAttachment(string id)

Parameters

id String

The attachment ID.

Returns

String

The attachment data, if it exists. If no attachment data exists for the specified ID, null is returned.

GetCompCount(String)

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

public int GetCompCount(string compType)

Parameters

compType String

The comparable type to count.

Returns

Int32

The comparable count.

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

Int32

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

GetFormTitle(String, Int32)

Gets the title for the specified form.

public string GetFormTitle(string formId, int formIndex)

Parameters

formId String

The form ID.

formIndex Int32

The form's index.

Returns

String

The form's title.

GetGeocodeLatitude(String)

Gets the saved latitude for the specified street address, if it has been associated with the report.

public double GetGeocodeLatitude(string street)

Parameters

street String

The street address.

Returns

Double

The saved latitude, if it exists. Otherwise, zero is returned.

GetGeocodeLongitude(String)

Gets the saved longitude for the specified street address, if it has been associated with the report.

public double GetGeocodeLongitude(string street)

Parameters

street String

The street address.

Returns

Double

The saved longitude, if it exists. Otherwise, zero is returned.

GetMaxCompIndex(String)

Gets the maximum index for the specified comparable type in the report.

public int GetMaxCompIndex(string compType)

Parameters

compType String

The comparable type.

Returns

Int32

The maximum comparable index.

HasForm(String, Int32)

Checks if the report contains the specified form.

public bool HasForm(string formId, int index)

Parameters

formId String

The form ID.

index Int32

The form's index.

Returns

Boolean

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

HasGeocode(String)

Checks if longitude and latitude coordinates have been saved for the specified street address.

public bool HasGeocode(string street)

Parameters

street String

The street address.

Returns

Boolean

True if and only if longitude and latitude coordinates have been saved for the specified street address.

ImageField(String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string fieldId)

Parameters

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, Int32, Int32, String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string compType, int compIndex, int unitIndex, string fieldId)

Parameters

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, Int32, String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string compType, int compIndex, string fieldId)

Parameters

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, Int32, String, Int32, Int32, String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string formId, int formIndex, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, Int32, String, Int32, String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string formId, int formIndex, string compType, int compIndex, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, Int32, String, String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

signatureType String

The fields' SignatureType.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, Int32, String, String, Int32, Int32, String)

Gets an object that provides access to all matching image fields.

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

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

signatureType String

The fields' SignatureType.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImageField(String, String)

Gets an object that provides access to all matching image fields.

public ImageFieldProxy ImageField(string signatureType, string fieldId)

Parameters

signatureType String

The fields' SignatureType.

fieldId String

The fields' ID.

Returns

ImageFieldProxy

A ImageFieldProxy instance that provides access to all matching image fields.

ImportMismo(String, Boolean)

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 Boolean

True if and only if adjustments should be imported. Otherwise, false.

InsertPdf(String)

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

public void InsertPdf(string pdfFilePath)

Parameters

pdfFilePath String

The path to the PDF file to insert.

InsertWordProcessingDocument(Boolean, String)

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

public void InsertWordProcessingDocument(bool useFormWithHeader, string filePath)

Parameters

useFormWithHeader Boolean

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.

RemoveAttachment(String)

Removes the specified attachment from the report.

public bool RemoveAttachment(string id)

Parameters

id String

The attachment ID.

Returns

Boolean

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

Boolean

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

SelectDownField()

Selects the field below the currently selected field.

public bool SelectDownField()

Returns

Boolean

True if and only if a new field was selected.

SelectLeftField()

Selects the field to the left of the currently selected field.

public bool SelectLeftField()

Returns

Boolean

True if and only if a new field was selected.

SelectNextField()

Selects the next field in the jump order.

public bool SelectNextField()

Returns

Boolean

True if and only if a new field was selected.

SelectPreviousField()

Selects the previous field in the jump order.

public bool SelectPreviousField()

Returns

Boolean

True if and only if a new field was selected.

SelectRightField()

Selects the field to the right of the currently selected field.

public bool SelectRightField()

Returns

Boolean

True if and only if a new field was selected.

SelectUpField()

Selects the field above the currently selected field.

public bool SelectUpField()

Returns

Boolean

True if and only if a new field was selected.

SetAttachment(String, 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, string data)

Parameters

id String

The attachment ID.

data String

The attachment data.

SetGeocode(String, Double, Double)

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, double longitude, double latitude)

Parameters

street String

The location's street.

longitude Double

The location's longitude.

latitude Double

The location's latitude.

ShowFolderBrowserDialog(String)

Displays a folder browser dialog to the user.

public string ShowFolderBrowserDialog(string selectedPath)

Parameters

selectedPath String

The initially selected folder. To use the default folder, this parameter should be null.

Returns

String

The selected folder. If no folder was selected, null is returned.

ShowForm(String, Int32)

Displays the specified form.

public void ShowForm(string formId, int formIndex)

Parameters

formId String

The form's ID.

formIndex Int32

The form's index.

ShowInputDialog(String, String, String, String)

Shows an input dialog that prompts the user to enter a value into a text box.

public string ShowInputDialog(string windowTitle, string mainInstruction, string content, string input)

Parameters

windowTitle String

The title of the dialog.

mainInstruction String

The dialog's main instruction.

content String

The dialog's primary content.

input String

The dialog's default value.

Returns

String

The value entered by the user. If the dialog was canceled, null is returned.

ShowMessageDialog(String, String)

Shows a dialog that displays a message to the user with a single OK button.

public void ShowMessageDialog(string windowTitle, string content)

Parameters

windowTitle String

The title of the dialog.

content String

The dialog's content.

ShowOpenFileDialog(String, String, Int32, String)

Displays an open file dialog to the user.

public string ShowOpenFileDialog(string defaultFileName, string filter, int filterIndex, string initialDirectory)

Parameters

defaultFileName String

The default file name.

filter String

The file extension filter. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filter for details.

filterIndex Int32

The initial filter index. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filterindex for details.

initialDirectory String

The initially selected folder.

Returns

String

The file path selected by the user. If the user canceled the dialog, null is returned.

ShowSaveFileDialog(String, String, Int32, String)

Displays an save file dialog to the user.

public string ShowSaveFileDialog(string defaultFileName, string filter, int filterIndex, string initialDirectory)

Parameters

defaultFileName String

The default file name.

filter String

The file extension filter. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filter for details.

filterIndex Int32

The initial filter index. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filterindex for details.

initialDirectory String

The initially selected folder.

Returns

String

The file path selected by the user. If the user canceled the dialog, null is returned.

ShowYesOrNoDialog(String, String)

Shows a message dialog that prompts the user to select Yes or No.

public bool ShowYesOrNoDialog(string windowTitle, string content)

Parameters

windowTitle String

The title of the dialog.

content String

The dialog's content.

Returns

Boolean

True if and only if the user clicked the Yes button.

TextField(String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string fieldId)

Parameters

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, Int32, Int32, String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string compType, int compIndex, int unitIndex, string fieldId)

Parameters

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, Int32, String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string compType, int compIndex, string fieldId)

Parameters

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, Int32, String, Int32, Int32, String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string formId, int formIndex, string compType, int compIndex, int unitIndex, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, Int32, String, Int32, String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string formId, int formIndex, string compType, int compIndex, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, Int32, String, String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

signatureType String

The fields' SignatureType.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, Int32, String, String, Int32, Int32, String)

Gets an object that provides access to all matching text fields.

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

Parameters

formId String

The ID of the form on which the field(s) appear. If this value is null or empty, then all matching fields in the report will be referenced.

formIndex Int32

The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.

signatureType String

The fields' SignatureType.

compType String

The fields' CompType.

compIndex Int32

The fields' comparable index.

unitIndex Int32

The fields' unit index. If the field(s) do not have a unit index, this should be 0.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.

TextField(String, String)

Gets an object that provides access to all matching text fields.

public TextFieldProxy TextField(string signatureType, string fieldId)

Parameters

signatureType String

The fields' SignatureType.

fieldId String

The fields' ID.

Returns

TextFieldProxy

A TextFieldProxy instance that provides access to all matching text fields.