Word.Interfaces.SearchOptionsLoadOptions interface

パッケージ:

word

検索操作に含めるオプションを指定します。 Word JavaScript API で検索オプションを使用する方法の詳細については、「検索オプションを使用してWord アドイン内のテキストを検索する」を参照してください。

注釈

[ API セット: WordApi 1.1 ]

プロパティ

$all	読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
ignorePunct	単語間のすべての句読点文字を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [句読点を無視する] チェック ボックスに相当します。
ignoreSpace	単語間のすべての空白を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [空白文字チェック無視する] ボックスに対応します。
matchCase	大文字と小文字を区別する検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [大文字と小文字チェック一致] ボックスに対応します。
matchPrefix	検索文字列で始まる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [接頭辞に一致する] チェック ボックスに相当します。
matchSuffix	検索文字列で終わる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [接尾辞に一致する] に相当します。
matchWholeWord	大きな単語の一部であるテキストではなく、単語全体のみを検索するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [完全に一致する単語だけを検索する] チェック ボックスに相当します。
matchWildcards	特殊な検索演算子を使用して検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [ワイルドカードを使用する] チェック ボックスに相当します。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

ignorePunct

単語間のすべての句読点文字を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [句読点を無視する] チェック ボックスに相当します。

ignorePunct?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

ignoreSpace

単語間のすべての空白を無視するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [空白文字チェック無視する] ボックスに対応します。

ignoreSpace?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchCase

大文字と小文字を区別する検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [大文字と小文字チェック一致] ボックスに対応します。

matchCase?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchPrefix

検索文字列で始まる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [接頭辞に一致する] チェック ボックスに相当します。

matchPrefix?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchSuffix

検索文字列で終わる単語と一致するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [接尾辞に一致する] に相当します。

matchSuffix?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchWholeWord

大きな単語の一部であるテキストではなく、単語全体のみを検索するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [完全に一致する単語だけを検索する] チェック ボックスに相当します。

matchWholeWord?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

matchWildcards

特殊な検索演算子を使用して検索を実行するかどうかを示す値を指定します。 [検索と置換] ダイアログ ボックスの [ワイルドカードを使用する] チェック ボックスに相当します。

matchWildcards?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]