Class IntegrationClient

Namespace

Sfrep.AppraiseIt.Client.Integration

Assembly

Sfrep.AppraiseIt.Client.Integration.dll

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

public sealed class IntegrationClient : IDisposable

Inheritance

object

IntegrationClient

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

IntegrationClient(string, SynchronizationContext, int?)

Initializes an integration connection with the specified Appraise-It Pro instance. A SynchronizationContext can be provided to bring raised events to the UI thread. If no SynchronizationContext is provided (null), then events will be raised on a background thread.

public IntegrationClient(string clientName, SynchronizationContext synchronizationContext, int? processId = null)

Parameters

clientName string

The name of the integrating application.

synchronizationContext SynchronizationContext

Synchronization context for bringing background thread events to another thread, for instance the UI thread. If null, events will be raised on a background thread from the thread pool.

processId int?

The process ID of the Appraise-It Pro instance to connect to. If this value is null, the user will be prompted with a dialog to specify the Appraise-It Pro instance to connect to.

Exceptions

OperationCanceledException

Thrown if the user cancels the dialog when prompted to connect to an instance of Appraise-It Pro.

Properties

FormCount

Gets the number of forms in the report.

public int FormCount { get; }

Property Value

int

HasOverflowingTextFields

Checks if the currently opened report has overflowing text in one or more text fields.

public bool HasOverflowingTextFields { get; }

Property Value

bool

HasReport

Checks if a report is currently opened.

public bool HasReport { get; }

Property Value

bool

HasValidationWarnings

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

public bool HasValidationWarnings { get; }

Property Value

bool

IsDynamicReport

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

public bool IsDynamicReport { get; }

Property Value

bool

IsNonLenderReport

Checks if the report is a non-lender report.

public bool IsNonLenderReport { get; }

Property Value

bool

IsRunning

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

public bool IsRunning { get; }

Property Value

bool

IsUadReport

Checks if the currently opened report supports UAD.

public bool IsUadReport { get; }

Property Value

bool

PageNames

Gets the list of page names in the report.

public string[] PageNames { get; }

Property Value

string[]

PageOrder

Gets the report's current page print order.

public int[] PageOrder { get; }

Property Value

int[]

PageSelection

Gets the report's current page selection.

public bool[] PageSelection { get; }

Property Value

bool[]

PrimaryFormId

Gets the report's primary form ID.

public string PrimaryFormId { get; }

Property Value

string

ProcessId

Gets the ID of the Appraise-It Pro process.

public int ProcessId { get; }

Property Value

int

ReportIsReadOnly

Checks if the currently opened report is readonly.

public bool ReportIsReadOnly { get; }

Property Value

bool

ReportPath

Gets the full path to the currently opened report.

public string ReportPath { get; }

Property Value

string

Remarks

If the report has not been saved to a file, null is returned.

SupportsAIReady

Checks if the report supports AIReady.

public bool SupportsAIReady { get; }

Property Value

bool

SupportsDynamicPropertyEditor

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

public bool SupportsDynamicPropertyEditor { get; }

Property Value

bool

SupportsMismo241

Checks if the report supports MISMO v.2.4.1.

public bool SupportsMismo241 { get; }

Property Value

bool

SupportsMismo26

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

public bool SupportsMismo26 { get; }

Property Value

bool

SupportsMismo26Gse

Checks if the report supports MISMO v.2.6 GSE.

public bool SupportsMismo26Gse { get; }

Property Value

bool

SupportsMismo26GseForAppraiserGenieCloud

Checks if the report supports the Appraiser Genie Cloud export.

public bool SupportsMismo26GseForAppraiserGenieCloud { get; }

Property Value

bool

SupportsMismo36

Checks if the report supports MISMO v.3.6.

public bool SupportsMismo36 { get; }

Property Value

bool

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 = false)

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(CancellationToken)

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

public void BeginTransaction(CancellationToken cancelToken = default)

Parameters

cancelToken CancellationToken

A CancellationToken that can be used to cancel while waiting for a transaction to complete.

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.

ClearComparableData(string, int)

Clears all data, except images, associated with the specified comparable.

public void ClearComparableData(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 = 0)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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 = null, int[] pageOrder = null)

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()

Releases resources used by this instance.

public void Dispose()

EndTransaction()

Ends the current transaction.

public void EndTransaction()

~IntegrationClient()

Releases resources used by this instance.

protected ~IntegrationClient()

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)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public bool GetCheckBoxFieldValue(string fieldId)

Parameters

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.

GetCheckBoxFieldValue(string, int, int?, string)

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

GetCheckBoxFieldValue(string, int, string)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable 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.

GetCheckBoxFieldValue(string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public bool GetCheckBoxFieldValue(string signatureType, string fieldId)

Parameters

signatureType string

The fields' signature type.

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.

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)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public bool GetCheckBoxFieldValueForForm(string formId, int formIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's 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.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex 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.

GetCheckBoxFieldValueForForm(string, int, string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

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.

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 = false)

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 = false)

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 = false)

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 the data store that manages report data on dynamic forms.

public DataStoreIntegrationClient GetDataStore()

Returns

DataStoreIntegrationClient

The data store that manages report data on dynamic forms.

Remarks

Each call to this member returns a new instance that, to prevent resource leaks, must be disposed 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.

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.

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

Gets the title for the specified field.

[Obsolete("This method is deprecated.  Use the GetFieldTitle overloads that take the compType parameter as a string instead.", false)]
public string GetFieldTitle(string formId, int formIndex, int compType, int compIndex, int? unitIndex, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

compType int

The field's comparable type.

compIndex int

The field's comparable index.

unitIndex int?

The field's unit index.

fieldId string

The field's ID.

Returns

string

The field's title.

Remarks

This method is deprecated. Use the GetFieldTitle overloads that take the compType parameter as a string instead.

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

Gets the title for the specified field.

[Obsolete("This method is deprecated.  Use the GetFieldTitle overloads that take the compType parameter as a string instead.", false)]
public string GetFieldTitle(string formId, int formIndex, int compType, int compIndex, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

compType int

The field's comparable type.

compIndex int

The field's comparable index.

fieldId string

The field's ID.

Returns

string

The field's title.

Remarks

This method is deprecated. Use the GetFieldTitle overloads that take the compType parameter as a string instead.

GetFieldTitle(string, int, int, string)

Gets the title for the specified field.

[Obsolete("This method is deprecated.  Use the GetFieldTitle overloads that take the signatureType parameter as a string instead.", false)]
public string GetFieldTitle(string formId, int formIndex, int signatureType, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

signatureType int

The field's signature type.

fieldId string

The field's ID.

Returns

string

The field's title.

Remarks

This method is deprecated. Use the GetFieldTitle overloads that take the signatureType parameter as a string instead.

GetFieldTitle(string, int, string)

Gets the title for the specified field.

public string GetFieldTitle(string formId, int formIndex, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

fieldId string

The field's ID.

Returns

string

The field's title.

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

Gets the title for the specified field.

public string GetFieldTitle(string formId, int formIndex, string compType, int compIndex, int? unitIndex, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

compType string

The field's comparable type.

compIndex int

The field's comparable index.

unitIndex int?

The field's unit index.

fieldId string

The field's ID.

Returns

string

The field's title.

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

Gets the title for the specified field.

public string GetFieldTitle(string formId, int formIndex, string compType, int compIndex, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

compType string

The field's comparable type.

compIndex int

The field's comparable index.

fieldId string

The field's ID.

Returns

string

The field's title.

GetFieldTitle(string, int, string, string)

Gets the title for the specified field.

public string GetFieldTitle(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId string

The form ID.

formIndex int

The form index.

signatureType string

The field's signature type.

fieldId string

The field's ID.

Returns

string

The field's title.

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

Gets the title for the specified field.

public string GetFieldTitle(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.

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, out byte[], out string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void GetImageFieldValue(string fieldId, out byte[] data, out string fileExtension)

Parameters

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.

GetImageFieldValue(string, int, int?, string, out byte[], out string)

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable 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.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

signatureType string

The fields' signature type.

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.

GetImageFieldValue(string, string, int, int?, string, out byte[], out 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, out byte[] data, out string fileExtension)

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.

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, out byte[], out string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void GetImageFieldValueForForm(string formId, int formIndex, string fieldId, out byte[] data, out string fileExtension)

Parameters

formId string

The form's ID.

formIndex int

The form's 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.

GetImageFieldValueForForm(string, int, string, int, int?, string, out byte[], out string)

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

The signature type is assumed to be SignatureType.None.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The field's comparable type.

compIndex int

The field's comparable 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.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void GetImageFieldValueForForm(string formId, int formIndex, string signatureType, string fieldId, out byte[] data, out string fileExtension)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

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.

GetImageFieldValueForForm(string, int, string, string, int, int?, string, out byte[], out 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, out byte[] data, out 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.

GetTextFieldDateTime(string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public DateTime? GetTextFieldDateTime(string fieldId)

Parameters

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldDateTime(string, int, int?, string)

Retrieves the value for the first matching non-repeatable text field in the report in DateTime format.

The signature type is assumed to be SignatureType.None.

public DateTime? GetTextFieldDateTime(string compType, int compIndex, int? unitIndex, string fieldId)

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

unitIndex int?

The fields' unit index.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldDateTime(string, int, string)

Retrieves the value for the first matching non-repeatable text field in the report in DateTime format.

The unit index is assumed to be null.

The signature type is assumed to be SignatureType.None.

public DateTime? GetTextFieldDateTime(string compType, int compIndex, string fieldId)

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldDateTime(string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public DateTime? GetTextFieldDateTime(string signatureType, string fieldId)

Parameters

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldDateTime(string, string, int, int?, string)

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

public DateTime? GetTextFieldDateTime(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

DateTime?

The DateTime value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldDateTimeForForm(string, int, string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public DateTime? GetTextFieldDateTimeForForm(string formId, int formIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldDateTimeForForm(string, int, string, int, int?, string)

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

The signature type is assumed to be SignatureType.None.

public DateTime? GetTextFieldDateTimeForForm(string formId, int formIndex, string compType, int compIndex, int? unitIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

unitIndex int?

The fields' unit index.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldDateTimeForForm(string, int, string, int, string)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

public DateTime? GetTextFieldDateTimeForForm(string formId, int formIndex, string compType, int compIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldDateTimeForForm(string, int, string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public DateTime? GetTextFieldDateTimeForForm(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

Returns

DateTime?

The DateTime value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldDateTimeForForm(string, int, string, string, int, int?, string)

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

public DateTime? GetTextFieldDateTimeForForm(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

DateTime?

The DateTime value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldNumeric(string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public decimal? GetTextFieldNumeric(string fieldId)

Parameters

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldNumeric(string, int, int?, string)

Retrieves the value for the first matching non-repeatable text field in the report in numeric format.

The signature type is assumed to be SignatureType.None.

public decimal? GetTextFieldNumeric(string compType, int compIndex, int? unitIndex, string fieldId)

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

unitIndex int?

The fields' unit index.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldNumeric(string, int, string)

Retrieves the value for the first matching non-repeatable text field in the report in numeric format.

The unit index is assumed to be null.

The signature type is assumed to be SignatureType.None.

public decimal? GetTextFieldNumeric(string compType, int compIndex, string fieldId)

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldNumeric(string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public decimal? GetTextFieldNumeric(string signatureType, string fieldId)

Parameters

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldNumeric(string, string, int, int?, string)

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

public decimal? GetTextFieldNumeric(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

decimal?

The numeric value for the first matching non-repeatable text field in the report, if any. If no matching field is found, the null is returned.

Remarks

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

GetTextFieldNumericForForm(string, int, string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public decimal? GetTextFieldNumericForForm(string formId, int formIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldNumericForForm(string, int, string, int, int?, string)

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

The signature type is assumed to be SignatureType.None.

public decimal? GetTextFieldNumericForForm(string formId, int formIndex, string compType, int compIndex, int? unitIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

unitIndex int?

The fields' unit index.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldNumericForForm(string, int, string, int, string)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

public decimal? GetTextFieldNumericForForm(string formId, int formIndex, string compType, int compIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldNumericForForm(string, int, string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public decimal? GetTextFieldNumericForForm(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

Returns

decimal?

The numeric value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldNumericForForm(string, int, string, string, int, int?, string)

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

public decimal? GetTextFieldNumericForForm(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

decimal?

The numeric value for the first matching text field in the form, if any. If no matching field is found, the null is returned.

GetTextFieldText(string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public string GetTextFieldText(string fieldId)

Parameters

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.

GetTextFieldText(string, int, int?, string)

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

GetTextFieldText(string, int, string)

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

The unit index is assumed to be null.

The signature type is assumed to be SignatureType.None.

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

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable 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.

GetTextFieldText(string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public string GetTextFieldText(string signatureType, string fieldId)

Parameters

signatureType string

The fields' signature type.

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.

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)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public string GetTextFieldTextForForm(string formId, int formIndex, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's 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.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable 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.

GetTextFieldTextForForm(string, int, string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public string GetTextFieldTextForForm(string formId, int formIndex, string signatureType, string fieldId)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

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.

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 = 0)

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.

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.

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.

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 IList<byte[]> 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

IList<byte[]>

A list of JPEGs as byte arrays. Each JPEG is a rasterized page from the specified form.

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 = null, int[] pageOrder = null)

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 = null, int[] pageOrder = null)

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 = null, int[] pageOrder = null)

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, bool)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetCheckBoxFieldsValue(string fieldId, bool fieldData)

Parameters

fieldId string

The fields' ID.

fieldData bool

The new checkbox field value.

Remarks

Repeatable fields cannot be set using this method.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

SetCheckBoxFieldsValue(string, int, string, bool)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

fieldData bool

The new checkbox field value.

Remarks

Repeatable fields cannot be set using this method.

SetCheckBoxFieldsValue(string, string, bool)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetCheckBoxFieldsValue(string signatureType, string fieldId, bool fieldData)

Parameters

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

fieldData bool

The new checkbox field value.

Remarks

Repeatable fields cannot be set using this method.

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, bool)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetCheckBoxFieldsValueForForm(string formId, int formIndex, string fieldId, bool fieldData)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The fields' ID.

fieldData bool

The new checkbox field value.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

fieldData bool

The new checkbox field value.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

fieldData bool

The new checkbox field value.

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, byte[], string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetImageFieldsValue(string fieldId, byte[] data, string fileExtension)

Parameters

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.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable 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.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetImageFieldsValue(string signatureType, string fieldId, byte[] data, string fileExtension)

Parameters

signatureType string

The fields' signature type.

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

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.

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

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, byte[], string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The fields' ID.

data byte[]

The binary image data.

fileExtension string

The image file's extension, including the leading '.'.

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

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

The signature type is assumed to be SignatureType.None.

public void SetImageFieldsValueForForm(string formId, int formIndex, 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.

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 '.'.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

data byte[]

The binary image data.

fileExtension string

The image file's extension, including the leading '.'.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

data byte[]

The binary image data.

fileExtension string

The image file's extension, including the leading '.'.

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

data byte[]

The binary image data.

fileExtension string

The image file's extension, including the leading '.'.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

SetImageFieldsValueFromFile(string, int, string, string)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

compType string

The fields' comparable type.

compIndex int

The fields' comparable 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.

SetImageFieldsValueFromFile(string, string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetImageFieldsValueFromFile(string fieldId, string filePath)

Parameters

fieldId string

The fields' 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.

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

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.

SetImageFieldsValueFromFile(string, string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetImageFieldsValueFromFile(string signatureType, string fieldId, string filePath)

Parameters

signatureType string

The fields' signature type.

fieldId string

The fields' 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, int, int?, string, string)

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

The signature type is assumed to be SignatureType.None.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The fields' ID.

filePath string

The path to the image file.

SetImageFieldsValueFromFileForForm(string, int, string, string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetImageFieldsValueFromFileForForm(string formId, int formIndex, string fieldId, string filePath)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The fields' ID.

filePath string

The path to the image file.

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

filePath string

The path to the image file.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

filePath string

The path to the image file.

SetTextFieldsDateTime(string, DateTime)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsDateTime(string fieldId, DateTime dateTimeValue)

Parameters

fieldId string

The fields' ID.

dateTimeValue DateTime

The new text field value in DateTime format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsDateTime(string, int, int?, string, DateTime)

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

The signature type is assumed to be SignatureType.None.

public void SetTextFieldsDateTime(string compType, int compIndex, int? unitIndex, string fieldId, DateTime dateTimeValue)

Parameters

compType string

The fields' comparable index.

compIndex int

The fields' unit index.

unitIndex int?

The fields' unit index.

fieldId string

The fields' ID.

dateTimeValue DateTime

The new text field value in DateTime format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsDateTime(string, int, string, DateTime)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

public void SetTextFieldsDateTime(string compType, int compIndex, string fieldId, DateTime dateTimeValue)

Parameters

compType string

The fields' comparable index.

compIndex int

The fields' unit index.

fieldId string

The fields' ID.

dateTimeValue DateTime

The new text field value in DateTime format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsDateTime(string, string, DateTime)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsDateTime(string signatureType, string fieldId, DateTime dateTimeValue)

Parameters

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

dateTimeValue DateTime

The new text field value in DateTime format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsDateTime(string, string, int, int?, string, DateTime)

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

public void SetTextFieldsDateTime(string signatureType, string compType, int compIndex, int? unitIndex, string fieldId, DateTime dateTimeValue)

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.

dateTimeValue DateTime

The new text field value in DateTime format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsDateTimeForForm(string, int, string, DateTime)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsDateTimeForForm(string formId, int formIndex, string fieldId, DateTime dateTimeValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The field's ID.

dateTimeValue DateTime

The new text field value in DateTime format.

SetTextFieldsDateTimeForForm(string, int, string, int, int?, string, DateTime)

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

The signature type is assumed to be SignatureType.None.

public void SetTextFieldsDateTimeForForm(string formId, int formIndex, string compType, int compIndex, int? unitIndex, string fieldId, DateTime dateTimeValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

unitIndex int?

The fields' unit index.

fieldId string

The field's ID.

dateTimeValue DateTime

The new text field value in DateTime format.

SetTextFieldsDateTimeForForm(string, int, string, int, string, DateTime)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

public void SetTextFieldsDateTimeForForm(string formId, int formIndex, string compType, int compIndex, string fieldId, DateTime dateTimeValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The field's ID.

dateTimeValue DateTime

The new text field value in DateTime format.

SetTextFieldsDateTimeForForm(string, int, string, string, DateTime)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsDateTimeForForm(string formId, int formIndex, string signatureType, string fieldId, DateTime dateTimeValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The field's ID.

dateTimeValue DateTime

The new text field value in DateTime format.

SetTextFieldsDateTimeForForm(string, int, string, string, int, int?, string, DateTime)

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

public void SetTextFieldsDateTimeForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int? unitIndex, string fieldId, DateTime dateTimeValue)

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.

dateTimeValue DateTime

The new text field value in DateTime format.

SetTextFieldsNumeric(string, decimal)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsNumeric(string fieldId, decimal numericValue)

Parameters

fieldId string

The fields' ID.

numericValue decimal

The new text field value in numeric format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsNumeric(string, int, int?, string, decimal)

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

The signature type is assumed to be SignatureType.None.

public void SetTextFieldsNumeric(string compType, int compIndex, int? unitIndex, string fieldId, decimal numericValue)

Parameters

compType string

The fields' comparable index.

compIndex int

The fields' unit index.

unitIndex int?

The fields' unit index.

fieldId string

The fields' ID.

numericValue decimal

The new text field value in numeric format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsNumeric(string, int, string, decimal)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

public void SetTextFieldsNumeric(string compType, int compIndex, string fieldId, decimal numericValue)

Parameters

compType string

The fields' comparable index.

compIndex int

The fields' unit index.

fieldId string

The fields' ID.

numericValue decimal

The new text field value in numeric format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsNumeric(string, string, decimal)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsNumeric(string signatureType, string fieldId, decimal numericValue)

Parameters

signatureType string

The fields' signature type.

fieldId string

The fields' ID.

numericValue decimal

The new text field value in numeric format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsNumeric(string, string, int, int?, string, decimal)

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

public void SetTextFieldsNumeric(string signatureType, string compType, int compIndex, int? unitIndex, string fieldId, decimal numericValue)

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.

numericValue decimal

The new text field value in numeric format.

Remarks

Repeatable fields cannot be set using this method.

SetTextFieldsNumericForForm(string, int, string, decimal)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsNumericForForm(string formId, int formIndex, string fieldId, decimal numericValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The field's ID.

numericValue decimal

The new text field value in numeric format.

SetTextFieldsNumericForForm(string, int, string, int, int?, string, decimal)

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

The signature type is assumed to be SignatureType.None.

public void SetTextFieldsNumericForForm(string formId, int formIndex, string compType, int compIndex, int? unitIndex, string fieldId, decimal numericValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

unitIndex int?

The fields' unit index.

fieldId string

The field's ID.

numericValue decimal

The new text field value in numeric format.

SetTextFieldsNumericForForm(string, int, string, int, string, decimal)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

public void SetTextFieldsNumericForForm(string formId, int formIndex, string compType, int compIndex, string fieldId, decimal numericValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The field's ID.

numericValue decimal

The new text field value in numeric format.

SetTextFieldsNumericForForm(string, int, string, string, decimal)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsNumericForForm(string formId, int formIndex, string signatureType, string fieldId, decimal numericValue)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

fieldId string

The field's ID.

numericValue decimal

The new text field value in numeric format.

SetTextFieldsNumericForForm(string, int, string, string, int, int?, string, decimal)

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

public void SetTextFieldsNumericForForm(string formId, int formIndex, string signatureType, string compType, int compIndex, int? unitIndex, string fieldId, decimal numericValue)

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.

numericValue decimal

The new text field value in numeric format.

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

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

The signature type is assumed to be SignatureType.None.

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

Parameters

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.

SetTextFieldsText(string, int, string, string)

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

compType string

The fields' comparable index.

compIndex 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.

SetTextFieldsText(string, string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsText(string fieldId, string text)

Parameters

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.

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.

SetTextFieldsText(string, string, string)

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsText(string signatureType, string fieldId, string text)

Parameters

signatureType string

The fields' signature type.

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, int, int?, string, string)

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

The signature type is assumed to be SignatureType.None.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

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.

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

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

The signature type is assumed to be SignatureType.None.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

compType string

The fields' comparable type.

compIndex int

The fields' comparable index.

fieldId string

The field's ID.

text string

The new text field value in plain text format.

SetTextFieldsTextForForm(string, int, string, string)

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

The signature type is assumed to be SignatureType.None.

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

public void SetTextFieldsTextForForm(string formId, int formIndex, string fieldId, string text)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

fieldId string

The field's ID.

text string

The new text field value in plain text format.

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.

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

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

The comparable type is assumed to be ComparableType.None.

The comparable index is assumed to be 0.

The unit index is assumed to be null.

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

Parameters

formId string

The form's ID.

formIndex int

The form's index.

signatureType string

The fields' signature type.

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 = 0)

Parameters

formId string

The form's ID.

formIndex int

The form's index.

ToMismo241(bool[])

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

public string ToMismo241(bool[] pageSelection = null)

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 = null)

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 = null)

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 = null, int[] pageOrder = null)

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.

TransferSketchData(SketchAndAreaDataClient)

Transfers the specified sketch data to the report.

public void TransferSketchData(SketchAndAreaDataClient data)

Parameters

data SketchAndAreaDataClient

The sketch data.

Remarks

This method only supports dynamic / UAD 3.6 report types.

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

Attempts to retrieve the specified attachment from the report.

public bool TryGetAttachment(string id, out byte[] data, out 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, out string, out double, out double, out string)

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

public bool TryGetGeocode(string street, out string source, out double longitude, out double latitude, out 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.

Events

ProcessExited

Raised when Appraise-It is closed. If a SynchronizationContext was provided to the constructor, then it will be used to raise the event on the thread of the context, for instance the UI thread. Otherwise, the event is raised on a background thread from the thread pool.

public event EventHandler ProcessExited

Event Type

EventHandler

ReportClosed

Raised when a report is closed. If a SynchronizationContext was provided to the constructor, then it will be used to raise the event on the thread of the context, for instance the UI thread. Otherwise, the event is raised on a background thread from the thread pool.

public event EventHandler ReportClosed

Event Type

EventHandler

ReportLoaded

Raised when a report is loaded. If a SynchronizationContext was provided to the constructor, then it will be used to raise the event on the thread of the context, for instance the UI thread. Otherwise, the event is raised on a background thread from the thread pool.

public event EventHandler ReportLoaded

Event Type

EventHandler