Class ScriptingProxy

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

Inheritance

System.Object

ScriptingProxy

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Sfrep.AppraiseIt.Model.Scripting

Assembly: cs.temp.dll.dll

Syntax

public class ScriptingProxy

Properties

CompTypes

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

Declaration

public string[] CompTypes { get; }

Property Value

Type	Description
System.String[]

DataFolder

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

Declaration

public string DataFolder { get; }

Property Value

Type	Description
System.String

FieldIsSelected

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

Declaration

public bool FieldIsSelected { get; }

Property Value

Type	Description
System.Boolean

HasOverflowingTextFields

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

Declaration

public bool HasOverflowingTextFields { get; }

Property Value

Type	Description
System.Boolean

HasValidationWarnings

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

Declaration

public bool HasValidationWarnings { get; }

Property Value

Type	Description
System.Boolean

IsNonLenderReport

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

Declaration

public bool IsNonLenderReport { get; }

Property Value

Type	Description
System.Boolean

IsUadReport

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

Declaration

public bool IsUadReport { get; }

Property Value

Type	Description
System.Boolean

PrimaryFormId

The report's primary form ID.

Declaration

public string PrimaryFormId { get; }

Property Value

Type	Description
System.String

ReportIsReadOnly

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

Declaration

public bool ReportIsReadOnly { get; }

Property Value

Type	Description
System.Boolean

ReportPath

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

Declaration

public string ReportPath { get; }

Property Value

Type	Description
System.String

SelectedCheckBoxField

Gets the currently selected checkbox field information.

Declaration

public CheckBoxFieldProxy SelectedCheckBoxField { get; }

Property Value

Type	Description
CheckBoxFieldProxy

SelectedCompIndex

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

Declaration

public int SelectedCompIndex { get; }

Property Value

Type	Description
System.Int32

SelectedCompType

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

Declaration

public string SelectedCompType { get; }

Property Value

Type	Description
System.String

SelectedFieldId

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

Declaration

public string SelectedFieldId { get; }

Property Value

Type	Description
System.String

SelectedFormId

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

Declaration

public string SelectedFormId { get; }

Property Value

Type	Description
System.String

SelectedFormIndex

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

Declaration

public int SelectedFormIndex { get; }

Property Value

Type	Description
System.Int32

SelectedImageField

Gets the currently selected image field information.

Declaration

public ImageFieldProxy SelectedImageField { get; }

Property Value

Type	Description
ImageFieldProxy

SelectedSignatureType

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

Declaration

public string SelectedSignatureType { get; }

Property Value

Type	Description
System.String

SelectedTextField

Gets the currently selected text field information.

Declaration

public TextFieldProxy SelectedTextField { get; }

Property Value

Type	Description
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.

Declaration

public int SelectedUnitIndex { get; }

Property Value

Type	Description
System.Int32

SignatureTypes

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

Declaration

public string[] SignatureTypes { get; }

Property Value

Type	Description
System.String[]

Methods

AddComparables(String)

Attempts to add an additional comparables addendum to the report.

Declaration

public bool AddComparables(string compType)

Parameters

Type	Name	Description
System.String	compType	The type of comparables addendum to add.

Returns

Type	Description
System.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.

Declaration

public int AddForm(string formId, bool showForm)

Parameters

Type	Name	Description
System.String	formId	The ID of the form to add.
System.Boolean	showForm	True if and only if the form should be shown after it is added.

Returns

Type	Description
System.Int32	The added form's zero-based index.

CheckBoxField(String)

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

Declaration

public CheckBoxFieldProxy CheckBoxField(string fieldId)

Parameters

Type	Name	Description
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	signatureType	The fields' SignatureType.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	signatureType	The fields' SignatureType.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

public CheckBoxFieldProxy CheckBoxField(string signatureType, string fieldId)

Parameters

Type	Name	Description
System.String	signatureType	The fields' SignatureType.
System.String	fieldId	The fields' ID.

Returns

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

ClearComparable(String, Int32)

Clears all data associated with the specified comparable.

Declaration

public void ClearComparable(string compType, int compIndex)

Parameters

Type	Name	Description
System.String	compType	The comparable type.
System.Int32	compIndex	The comparable index.

ClearForm(String, Int32)

Clears the specified form.

Declaration

public void ClearForm(string formId, int formIndex)

Parameters

Type	Name	Description
System.String	formId	The form's ID.
System.Int32	formIndex	The form's index.

FormIsRepeatable(String)

Checks if the specified form is repeatable.

Declaration

public bool FormIsRepeatable(string formId)

Parameters

Type	Name	Description
System.String	formId	The form's ID.

Returns

Type	Description
System.Boolean	True if and only if the the specified form is repeatable.

GetAttachment(String)

Attempts to retrieve the specified attachment from the report.

Declaration

public string GetAttachment(string id)

Parameters

Type	Name	Description
System.String	id	The attachment ID.

Returns

Type	Description
System.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.

Declaration

public int GetCompCount(string compType)

Parameters

Type	Name	Description
System.String	compType	The comparable type to count.

Returns

Type	Description
System.Int32	The comparable count.

GetFormInstanceCount(String)

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

Declaration

public int GetFormInstanceCount(string formId)

Parameters

Type	Name	Description
System.String	formId	The form ID.

Returns

Type	Description
System.Int32	The number of times the specified form appears in the report.

GetFormTitle(String, Int32)

Gets the title for the specified form.

Declaration

public string GetFormTitle(string formId, int formIndex)

Parameters

Type	Name	Description
System.String	formId	The form ID.
System.Int32	formIndex	The form's index.

Returns

Type	Description
System.String	The form's title.

GetGeocodeLatitude(String)

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

Declaration

public double GetGeocodeLatitude(string street)

Parameters

Type	Name	Description
System.String	street	The street address.

Returns

Type	Description
System.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.

Declaration

public double GetGeocodeLongitude(string street)

Parameters

Type	Name	Description
System.String	street	The street address.

Returns

Type	Description
System.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.

Declaration

public int GetMaxCompIndex(string compType)

Parameters

Type	Name	Description
System.String	compType	The comparable type.

Returns

Type	Description
System.Int32	The maximum comparable index.

HasForm(String, Int32)

Checks if the report contains the specified form.

Declaration

public bool HasForm(string formId, int index)

Parameters

Type	Name	Description
System.String	formId	The form ID.
System.Int32	index	The form's index.

Returns

Type	Description
System.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.

Declaration

public bool HasGeocode(string street)

Parameters

Type	Name	Description
System.String	street	The street address.

Returns

Type	Description
System.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.

Declaration

public ImageFieldProxy ImageField(string fieldId)

Parameters

Type	Name	Description
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	signatureType	The fields' SignatureType.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	signatureType	The fields' SignatureType.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

public ImageFieldProxy ImageField(string signatureType, string fieldId)

Parameters

Type	Name	Description
System.String	signatureType	The fields' SignatureType.
System.String	fieldId	The fields' ID.

Returns

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

ImportMismo(String, Boolean)

Imports the specified MISMO document into the report.

Declaration

public void ImportMismo(string mismo, bool includeAdjustments)

Parameters

Type	Name	Description
System.String	mismo	The MISMO v.2.6 or MISMO v.2.6GSE document to import. MISMO v.2.4 is not supported.
System.Boolean	includeAdjustments	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.

Declaration

public void InsertPdf(string pdfFilePath)

Parameters

Type	Name	Description
System.String	pdfFilePath	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.

Declaration

public void InsertWordProcessingDocument(bool useFormWithHeader, string filePath)

Parameters

Type	Name	Description
System.Boolean	useFormWithHeader	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.
System.String	filePath	The path to the word processing file to insert.

RemoveAttachment(String)

Removes the specified attachment from the report.

Declaration

public bool RemoveAttachment(string id)

Parameters

Type	Name	Description
System.String	id	The attachment ID.

Returns

Type	Description
System.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.

Declaration

public bool RemoveGeocode(string street)

Parameters

Type	Name	Description
System.String	street	The street address whose geocode data is to be removed.

Returns

Type	Description
System.Boolean	True if geocode data associated with the specified street was found and removed.

SelectDownField()

Selects the field below the currently selected field.

Declaration

public bool SelectDownField()

Returns

Type	Description
System.Boolean	True if and only if a new field was selected.

SelectLeftField()

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

Declaration

public bool SelectLeftField()

Returns

Type	Description
System.Boolean	True if and only if a new field was selected.

SelectNextField()

Selects the next field in the jump order.

Declaration

public bool SelectNextField()

Returns

Type	Description
System.Boolean	True if and only if a new field was selected.

SelectPreviousField()

Selects the previous field in the jump order.

Declaration

public bool SelectPreviousField()

Returns

Type	Description
System.Boolean	True if and only if a new field was selected.

SelectRightField()

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

Declaration

public bool SelectRightField()

Returns

Type	Description
System.Boolean	True if and only if a new field was selected.

SelectUpField()

Selects the field above the currently selected field.

Declaration

public bool SelectUpField()

Returns

Type	Description
System.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.

Declaration

public void SetAttachment(string id, string data)

Parameters

Type	Name	Description
System.String	id	The attachment ID.
System.String	data	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.

Declaration

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

Parameters

Type	Name	Description
System.String	street	The location's street.
System.Double	longitude	The location's longitude.
System.Double	latitude	The location's latitude.

ShowFolderBrowserDialog(String)

Displays a folder browser dialog to the user.

Declaration

public string ShowFolderBrowserDialog(string selectedPath)

Parameters

Type	Name	Description
System.String	selectedPath	The initially selected folder. To use the default folder, this parameter should be null.

Returns

Type	Description
System.String	The selected folder. If no folder was selected, null is returned.

ShowForm(String, Int32)

Displays the specified form.

Declaration

public void ShowForm(string formId, int formIndex)

Parameters

Type	Name	Description
System.String	formId	The form's ID.
System.Int32	formIndex	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.

Declaration

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

Parameters

Type	Name	Description
System.String	windowTitle	The title of the dialog.
System.String	mainInstruction	The dialog's main instruction.
System.String	content	The dialog's primary content.
System.String	input	The dialog's default value.

Returns

Type	Description
System.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.

Declaration

public void ShowMessageDialog(string windowTitle, string content)

Parameters

Type	Name	Description
System.String	windowTitle	The title of the dialog.
System.String	content	The dialog's content.

ShowOpenFileDialog(String, String, Int32, String)

Displays an open file dialog to the user.

Declaration

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

Parameters

Type	Name	Description
System.String	defaultFileName	The default file name.
System.String	filter	The file extension filter. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filter for details.
System.Int32	filterIndex	The initial filter index. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filterindex for details.
System.String	initialDirectory	The initially selected folder.

Returns

Type	Description
System.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.

Declaration

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

Parameters

Type	Name	Description
System.String	defaultFileName	The default file name.
System.String	filter	The file extension filter. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filter for details.
System.Int32	filterIndex	The initial filter index. See https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.filedialog.filterindex for details.
System.String	initialDirectory	The initially selected folder.

Returns

Type	Description
System.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.

Declaration

public bool ShowYesOrNoDialog(string windowTitle, string content)

Parameters

Type	Name	Description
System.String	windowTitle	The title of the dialog.
System.String	content	The dialog's content.

Returns

Type	Description
System.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.

Declaration

public TextFieldProxy TextField(string fieldId)

Parameters

Type	Name	Description
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	signatureType	The fields' SignatureType.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	formId	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.
System.Int32	formIndex	The index of the form on which the field(s) appear. When matching all fields in the report, this value should be 0.
System.String	signatureType	The fields' SignatureType.
System.String	compType	The fields' CompType.
System.Int32	compIndex	The fields' comparable index.
System.Int32	unitIndex	The fields' unit index. If the field(s) do not have a unit index, this should be 0.
System.String	fieldId	The fields' ID.

Returns

Type	Description
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.

Declaration

public TextFieldProxy TextField(string signatureType, string fieldId)

Parameters

Type	Name	Description
System.String	signatureType	The fields' SignatureType.
System.String	fieldId	The fields' ID.

Returns

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