FormFieldSearchOptions class

FormFieldSearchOptions class

Represents search options for Form-field signatures.

Inheritance: FormFieldSearchOptionsSearchOptions

The FormFieldSearchOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the FormFieldSearchOptions class with default values.

Properties

Property Description
page_number Gets or sets Document page number for searching.
Value is optional.
pages_setup Options to specify pages for Signature searching.
all_pages Flag to search on each Document page. By default this value is set to true.
skip_external Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
shape_position Flag to return specify shape position in the document layout. Avaliable only for Word documents
type Specifies type of form field signature if it should be searched. Default value is null.
name Specifies regular expression pattern of form field signature name if it should be searched.
You can use it simple as “text” or regular expression like “abc\d+”. Default value is empty string.
value Specifies value of form field signature if it should be searched. Default value is null.

Remarks

Learn more | | | |

See Also