Edit

Share via

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

If provided, specifies whether to ignore all punctuation characters between words. The default is false. Corresponds to the _Ignore punctuation characters_ check box in the Find and Replace dialog box.
ignoreSpace

If provided, specifies whether to ignore all whitespace between words. The default is false. Corresponds to the _Ignore white-space characters_ check box in the Find and Replace dialog box.
matchCase

If provided, specifies whether to perform a case sensitive search. The default is false. Corresponds to the _Match case_ check box in the Find and Replace dialog box.
matchPrefix

If provided, specifies whether to match words that begin with the search string. The default is false. Corresponds to the _Match prefix_ check box in the Find and Replace dialog box.
matchSuffix

If provided, specifies whether to match words that end with the search string. The default is false. Corresponds to the _Match suffix_ check box in the Find and Replace dialog box.
matchWholeWord

If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is false. Corresponds to the _Find whole words only_ check box in the Find and Replace dialog box.
matchWildcards

If provided, specifies whether the search will be performed using special search operators. The default is false. 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

If provided, specifies whether to ignore all punctuation characters between words. The default is false. Corresponds to the _Ignore punctuation characters_ check box in the Find and Replace dialog box.

ignorePunct?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

ignoreSpace

If provided, specifies whether to ignore all whitespace between words. The default is false. Corresponds to the _Ignore white-space characters_ check box in the Find and Replace dialog box.

ignoreSpace?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

matchCase

If provided, specifies whether to perform a case sensitive search. The default is false. 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

If provided, specifies whether to match words that begin with the search string. The default is false. 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

If provided, specifies whether to match words that end with the search string. The default is false. 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

If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is false. 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

If provided, specifies whether the search will be performed using special search operators. The default is false. 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 ]