-
Notifications
You must be signed in to change notification settings - Fork 63
/
word.interfaces.searchoptionsloadoptions.yml
126 lines (126 loc) · 5.15 KB
/
word.interfaces.searchoptionsloadoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
### YamlMime:TSType
name: Word.Interfaces.SearchOptionsLoadOptions
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions:interface'
package: word!
fullName: Word.Interfaces.SearchOptionsLoadOptions
summary: >-
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](https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance)<!-- -->.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
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`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: ignorePunct
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#ignorePunct:member'
package: word!
fullName: ignorePunct
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'ignorePunct?: boolean;'
return:
type: boolean
- name: ignoreSpace
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#ignoreSpace:member'
package: word!
fullName: ignoreSpace
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'ignoreSpace?: boolean;'
return:
type: boolean
- name: matchCase
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#matchCase:member'
package: word!
fullName: matchCase
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'matchCase?: boolean;'
return:
type: boolean
- name: matchPrefix
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#matchPrefix:member'
package: word!
fullName: matchPrefix
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'matchPrefix?: boolean;'
return:
type: boolean
- name: matchSuffix
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#matchSuffix:member'
package: word!
fullName: matchSuffix
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'matchSuffix?: boolean;'
return:
type: boolean
- name: matchWholeWord
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#matchWholeWord:member'
package: word!
fullName: matchWholeWord
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'matchWholeWord?: boolean;'
return:
type: boolean
- name: matchWildcards
uid: 'word!Word.Interfaces.SearchOptionsLoadOptions#matchWildcards:member'
package: word!
fullName: matchWildcards
summary: >-
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.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'matchWildcards?: boolean;'
return:
type: boolean