Word.Interfaces.SearchOptionsData interface

An interface describing the data returned by calling "searchOptions.toJSON()".

Properties

ignorePunct

Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

ignoreSpace

Gets or sets a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchCase

Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchPrefix

Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchSuffix

Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchWholeWord

Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchWildcards

Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

Property Details

ignorePunct

Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

ignorePunct?: boolean;

Property Value

boolean

ignoreSpace

Gets or sets a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

ignoreSpace?: boolean;

Property Value

boolean

matchCase

Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchCase?: boolean;

Property Value

boolean

matchPrefix

Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchPrefix?: boolean;

Property Value

boolean

matchSuffix

Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchSuffix?: boolean;

Property Value

boolean

matchWholeWord

Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchWholeWord?: boolean;

Property Value

boolean

matchWildcards

Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box.

[ API set: WordApi 1.1 ]

matchWildcards?: boolean;

Property Value

boolean