当該テキストドキュメントに対して、文字列またはパラグラフスタイルを検索し、または正規表現検索を行ない、オプションで置換も行なえるUNOディスパッチコマンド
話題
About: UNO (Universal Network Objects)
About: LibreOffice
About: Apache OpenOffice
About: Writer
この記事の目次
開始コンテキスト
- 読者は、UNOディスパッチコマンドとは何かおよびそれらの呼び方（各コマンドのURLと引数が分かっていれば）を知っている。
ターゲットコンテキスト
- 読者は、当該UNOディスパッチコマンドの仕様を知る。
オリエンテーション
Java、C++、C#、Python、LibreOfficeまたはApache OpenOffice BasicでUNOディスパッチコマンドを実行してその実行から入手可能な全情報を取得する方法を説明する記事があります。
このシリーズでこれまでに挙げたUNOディスパッチコマンドのアプリケーション基盤用一覧、Writer用一覧、Calc用一覧があります。
本体
1: 仕様
URL: .uno:ExecuteSearch
説明: このコマンドは、当該テキストドキュメントに対して、指定された文字列またはパラグラフスタイルを検索、または指定された正規表現で検索を行ないます。検索は、次の出現または全出現に対して行なえます。大文字小文字区別、類似性度合い、等を指定できます。見つかった文字列群、パラグラフスタイル群は、オプションで、指定された置換文字列またはパラグラフスタイルで置換することもできます。
引数（タイプはUNOのデータタイプ）:
| 名前 | タイプ | 値 |
|---|---|---|
| SearchItem.StyleFamily | short | 使用されていない模様 |
| SearchItem.CellType | short | 使用されていない模様 |
| SearchItem.RowDirection | boolean | 使用されていない模様 |
| SearchItem.AllTables | boolean | 使用されていない模様 |
| SearchItem.SearchFiltered | boolean | 使用されていない模様 |
| SearchItem.Backward | boolean | 検索が逆方向に行われるか否か: true -> 逆方向に行われる、false -> 順方向に行われる |
| SearchItem.Pattern | boolean | 検索がパラグラフスタイル検索であるか否か: true -> パラグラフスタイル検索、false -> 文字列検索 |
| SearchItem.Content | boolean | 使用されていない模様 |
| SearchItem.AsianOptions | boolean | 検索で日本語の'類似発音'文字列を見つけるか否か: true -> '類似発音'文字列を見つける、false -> '類似発音'文字列を見つけない |
| SearchItem.AlgorithmType | short | 文字列検索アルゴリズム: 0 -> プレーンテキスト検索、1 -> 正規表現検索、2 -> 類似性検索 |
| SearchItem.SearchFlags | long | 以下のフラグ群の合計: 16 -> 全体が検索表現に一致する単語のみを検索、2048 -> 選択されている単語群のみを検索対象とする、4096 -> 使用されていない模様、65536 -> 類似性検索（Weighted Levenshtein Distance検索）において、類似性基準を緩和する (参考ドキュメントによると「the search is also successful if the combined pool for insertions and deletions is below a doubled calculated limit and replacements are treated differently; additionally, swapped characters are counted as one replacement」、それがどういう意味であろうと)。もっと情報（特に'65536'について）が必要であれば、こちらを参照。 |
| SearchItem.SearchString | string | 検索表現（プレーン文字列、正規表現、パラグラフスタイル名、のいずれか） |
| SearchItem.ReplaceString | string | 置換表現（置換文字列、置換パラグラフスタイル名、のいずれか） |
| SearchItem.Locale | com.sun.star.lang.Locale | 大文字小文字無区別検索で使用されるロケール（こちらを参照） |
| SearchItem.ChangedChars | long | 類似であると判定されるのに許容される最大変更文字数 |
| SearchItem.DeletedChars | long | 類似であると判定されるのに許容される最大削除文字数 |
| SearchItem.InsertedChars | long | 類似であると判定されるのに許容される最大挿入文字数 |
| SearchItem.TransliterateFlags | long | 言語固有フラグ群の合計: 256 -> 大文字小文字を区別しない、1024 -> 半角全角を区別しない、1073741824 -> 発音区別符号の有無を区別しない、等（多すぎてここでは引用できない: 上記以外のものについては、こちらおよびこちらを参照） |
| SearchItem.Command | short | 実行タイプ: 0 -> 次の出現を見つける、1 -> 全ての出現を見つける、2 -> カレントの出現を置換して次の出現を見つける、3 -> 全ての出現を置換する |
| SearchItem.SearchStartPointX | long | 次の出現を見つける検索の開始位置X座標（twips）（'SearchItem.SearchStartPointY'共に値'0'の場合、開始位置が指定されないことを意味し、検索はカレントカーソルから行われることを意味する） |
| SearchItem.SearchStartPointY | long | 次の出現を見つける検索の開始位置Y座標（twips）（'SearchItem.SearchStartPointX'共に値'0'の場合、開始位置が指定されないことを意味し、検索はカレントカーソルから行われることを意味する） |
| SearchItem.SearchFormatted | boolean | 使用されていない模様 |
| SearchItem.AlgorithmType2 | short | 使用されていない模様 |
| Quiet | boolean | 使用されていない模様 |
関連情報（com.sun.star.frame.FeatureStateEvent.Stateの値）（タイプはUNOのデータタイプ）:
| タイプ | 値 |
|---|---|
| N/A | void |
結果情報（com.sun.star.frame.DispatchResultEvent.Resultの値）（タイプはUNOのデータタイプ）:
| 場合 | タイプ | 値 |
|---|---|---|
| 何かが見つかった | boolean | true |
| その他の場合 | N/A | void |
<このシリーズの前の記事 | このシリーズの目次 | このシリーズの次の記事>
