Word.Interfaces.SearchOptionsLoadOptions interface

Package:

word

Specifies the options to be included in a search operation. To learn more about how to use search options in the Word JavaScript APIs, read Use search options to find text in your Word add-in.

Remarks

[ API set: WordApi 1.1 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
ignorePunct	Specifies 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.
ignoreSpace	Specifies 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.
matchCase	Specifies 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.
matchPrefix	Specifies 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.
matchSuffix	Specifies 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.
matchWholeWord	Specifies 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.
matchWildcards	Specifies 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.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

ignorePunct

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

ignorePunct?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

ignoreSpace

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

ignoreSpace?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

matchCase

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

matchCase?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

matchPrefix

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

matchPrefix?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

matchSuffix

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

matchSuffix?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

matchWholeWord

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

matchWholeWord?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

matchWildcards

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

matchWildcards?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]