MetadataSearchOptions class

Represents search options for Metadata signatures.

Inheritance: MetadataSearchOptions → SearchOptions

The MetadataSearchOptions type exposes the following members:

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

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
name	Specifies Metadata Signature name if it should be searched and matched.
name_match_type	Gets or sets Metadata name Match Type search. It is used only when Name property is set.
include_builtin_properties	Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. This flag has sense for Presentation, Spreadsheet and Word Processing document file types.
data_encryption	Gets or sets implementation of `IDataEncryption` interface to decrypt all Metadata signatures withing this options collection. If this value is set all found signatures will use this encryption by default or its own DataEncryption if it was assigned.

Learn more | | | |