2018年12月9日日曜日

16: UNOディスパッチコマンド'.uno:CompareDocuments'の仕様

<このシリーズの前の記事 | このシリーズの目次 | このシリーズの次の記事>


要約


UNOディスパッチコマンド'.uno:CompareDocuments'のURL、説明、引数、結果情報、関連情報(コマンド実行から取得できる)が記述されています。

話題


About: UNO (Universal Network Objects)
About: LibreOffice
About: Apache OpenOffice

この記事の目次


開始コンテキスト


  • 読者は、UNOディスパッチコマンドとは何かおよびそれらの呼び方(各コマンドのURLと引数が分かっていれば)を知っている。

ターゲットコンテキスト



  • 読者は、当該UNOディスパッチコマンドの仕様を知る。

イントロダクション


'オリエンテーション'は、'開始コンテキスト'内に立っていないか、'ターゲットコンテキスト'に乗り気でないか、またはその両方の通りすがりの人のために意図されたものです。そこには新たな技術情報はなにも含まれておらず、オリエンテーションなど要らない人は、これを読みとばしても、記事の理解に支障はありません。



オリエンテーション


JavaでUNOディスパッチコマンドを実行してその実行から入手可能な全情報を取得する方法を説明する記事があります(いくつかの他のプログラミング言語用の記事は将来公開されます)。

このシリーズでこれまでに挙げたUNOディスパッチコマンドのCalc用一覧があります。


本体


1: 仕様


URL: .uno:CompareDocuments

説明: このコマンドは、カレントドキュメントを、指定したドキュメントファイルと比較し、その後、カレントドキュメントへの変更を記録し続けます。カレントドキュメントが既に追跡されている状態であったなら、既存の追跡をまず終了してから処理を継続するか、既存の追跡を継続して処理をキャンセルするかを、ユーザーは問われます。

引数(タイプはUNOのデータタイプ):

名前タイプ
URLstringカレントドキュメントと比較するドキュメントファイルのURL
FilterNamestringカレントドキュメントと比較するドキュメントファイル用フィルタの名前: "DIF"、"HTML (StarCalc)"、"OpenDocument Spreadsheet Flat XML"、"MS Excel 97"、"MS Excel 97 Vorlage/Template"、"SYLK"、"Text - txt - csv (StarCalc)"、"dBase"、"calc8"、"calc8_template"、"Calc MS Excel 2007 XML"、"Calc MS Excel 2007 VBA XML"、"Calc Office Open XML"。この引数は通常、指定する必要がない(フィルターは自動的に検出されるため)。
Passwordstringカレントドキュメントと比較するドキュメントファイル用パスワード。しかし、パスワード付きファイルは、バグのため(たぶん)、LibreOffice 6.0.6.2において使用できない。
FilterOptionsstring指定したフィルター用オプション群。この引数は、多くのフィルター("calc8"、"Calc MS Excel 2007 XML"、"MS Excel 97"を含む)では指定する必要がない。どのフィルターがオプション群を必要するか、また、そうしたフィルターに指定すべき具体的なデータは調査されていない。
Versionshortカレントドキュメントと比較するドキュメントファイル内バージョン。そうしたバージョンは、一部のドキュメントフォーマット('ODF Spreadsheet'を含む)において、LibreOfficeの'File' -> 'Versions...'メニュー項目で作成できる。
NoAcceptDialogbooleanこの引数は無視される。

関連情報(com.sun.star.frame.FeatureStateEvent.Stateの値)(タイプはUNOのデータタイプ):

なし。

結果情報(com.sun.star.frame.DispatchResultEvent.Resultの値)(タイプはUNOのデータタイプ):

場合タイプ
コマンド実行が成功したlong結果ステータス(常に0)
その他N/Avoid

<このシリーズの前の記事 | このシリーズの目次 | このシリーズの次の記事>