指定された検索、置換操作を実行します。
#include <Word.au3>
_WordDocFindReplace ( ByRef $o_object [, $s_FindText = "" [, $s_ReplaceWith = "" [, $i_Replace = 2 [, $v_SearchRange = 0 [, $b_MatchCase = 0 [, $b_MatchWholeWord = 0 [, $b_MatchWildcards = 0 [, $b_MatchSoundsLike = 0 [, $b_MatchAllWordForms = 0 [, $b_Forward = 1 [, $i_Wrap = 1 [, $b_Format = 0]]]]]]]]]]]] )
パラメータ
| $o_object | ドキュメントオブジェクトまたはWord.Applicationのオブジェクト変数 |
| $s_FindText | [オプション] 検索されるテキスト (注意を参照) "" = (デフォルト) 書式のみを検索するために使用します。 |
| $s_ReplaceWith | [オプション] 置換テキスト (注意を参照) "" = (デフォルト) $s_FindTextで指定されたテキストを削除します。 |
| $i_Replace | [オプション] 何回置換をおこなうかを指定します。 0 = 置換をおこないません。 1 = 最初に一致したものを置換します。 2 = (デフォルト) すべて置換します。 |
| $v_SearchRange | [オプション] 検索をおこなう選択部、範囲を指定します。 -1 = 現在の選択部を指定します 0 = (デフォルト) ドキュメント全体を指定します 任意のRangeオブジェク |
| $b_MatchCase | [オプション] テキスト検索で大文字小文字を区別するかを指定します。 0 = (デフォルト) 大文字小文字を区別しません 1 = 大文字小文字を区別します |
| $b_MatchWholeWord | [オプション] 検索操作を単語単位でおこない単語内の部分テキストにおこなわないようにするかどうかを指定します。 0 = (デフォルト) 単語部分一致 1 = 単語単位での一致のみ |
| $b_MatchWildcards | [オプション] $s_FindTextに対して特別な検索操作をおこなうかどうかを指定します。 0 = (デフォルト) 特別な検索操作をおこなわない 1 = 特別な検索操作をおこなう |
| $b_MatchSoundsLike | [オプション] $s_FindTextに似た音の単語を検索するかどうかを指定します。 0 = (デフォルト) 似た音の単語を検索しません 1 = 似た音の単語を検索します |
| $b_MatchAllWordForms | [オプション]
検索テキストの全ての語形を検索するかどうかを指定します(例えば"sit"で"sitting"、"sat"を検索します)。 0 = (デフォルト) 他の語形を検索しません 1 = 全ての語形を検索します |
| $b_Forward | [オプション] 検索方向を指定します。 0 = 後方検索 (ドキュメント開始方向) 1 = (デフォルト) 前方検索 (ドキュメント終了方向) |
| $i_Wrap | [オプション]
検索をドキュメントの開始位置以外から開始し、ドキュメントの終了位置に到達した場合($b_Forwardが0の場合は逆)の動作を制御します。 0 = 検索範囲の開始位置、終了位置に到達した場合に検索操作を終了 1 = (デフォルト) 検索範囲の開始位置、終了位置に到達した場合に検索操作を継続 |
| $b_Format | [オプション] 検索テキストの代わりに追加書式を検索するかどうかをを指定します。 0 = (デフォルト) 書式を検索しません 1 = 書式を検索します |
返し値
| 成功: | 1を返します |
| 失敗: | 0を返し@ERROR = 1を設定します |
| @Error: | $_WordStatus_Success = 正常終了 |
| $_WordStatus_InvalidDataType = 無効なデータ型 | |
| $_WordStatus_InvalidObjectType = 無効なオブジェクト型 | |
| $_WordStatus_InvalidValue = 無効な値 | |
| $_WordStatus_NoMatch = 一致なし | |
| @Extended: | 無効なパラメータの数を格納 |
注意
適切な文字コードを指定することで特殊文字を検索することができます。例えば "^p"はパラグラフマークを表し、"^t"はタブ文字を表します。
関連
None.
例
; *******************************************************
; 例 1 - Wrodウィンドウを作成。ドキュメントを開き、"this"を検索し
; 全て"THIS"で置換。変更を保存せずに置換
; *******************************************************
;
#include <Word.au3>
$oWordApp = _WordCreate (@ScriptDir & "\Test.doc")
$oDoc = _WordDocGetCollection($oWordApp, 0)
$oFind = _WordDocFindReplace($oDoc, "this", "THIS")
If $oFind Then
MsgBox(0, "FindReplace", "Found and replaced.")
Else
MsgBox(0, "FindReplace", "Not Found")
EndIf
_WordQuit ($oWordApp, 0)