2019年12月29日日曜日

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

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


要約


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

話題


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

この記事の目次


開始コンテキスト


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

ターゲットコンテキスト



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

イントロダクション


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



オリエンテーション


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

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


本体


1: 仕様


URL: .uno:SaveAs

説明: このコマンドは、カレントドキュメントを、指定したファイルURLへ保存します。

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

名前タイプ
URLstringドキュメントが保存される先のURL
FilterNamestringドキュメント保存フィルター名
Passwordstring一部のファイルタイプ用のファイルオープンパスワード
PasswordInteractionboolean本コマンドがファイル保存ダイアログウィンドウから呼ばれない限り無効
FilterOptionsstring文字列形式のドキュメント保存フィルターデータ
VersionCommentstring新規ファイル(本コマンドで作成されるファイルは必ずそうなる)はバージョン情報を持てないため無効
VersionAuthorstring新規ファイル(本コマンドで作成されるファイルは必ずそうなる)はバージョン情報を持てないため無効
Overwriteboolean既存ファイル(もしあれば)を上書きする
Unpackedboolean不明
SaveToboolean以後、カレントドキュメントは保存されたファイルを代表しない
NoFileSyncbooleanファイルはストレージへ同期されない
NoThumbnailbooleanサムネイルを作成しない

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

タイプ
string'Save ~As...'というリテラル
N/Anull

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

場合タイプ
コマンド実行が成功したboolean'true'
その他N/Avoid

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