Summary
The URL, the description, the arguments, the result information, and the related information (which can be gotten from the command execution) of the UNO dispatch command, '.uno:SaveAs', are described.
Topics
About: UNO (Universal Network Objects)
About: LibreOffice
About: Apache OpenOffice
The table of contents of this article
Starting Context
- The reader has knowledge of what 'UNO dispatch command' is and how to call one (if the URL and the arguments of the command are clear).
Target Context
- The reader will know the specifications of the UNO dispatch command.
Introduction
'Orientation' is meant for the passersby who don't stand in 'Starting Context' and/or aren't enthusiastic about 'Target Context'. It doesn't contain any new technical information and can be skipped by anyone who doesn't need any orientation.
Orientation
There are some articles that explain how to execute any UNO dispatch commands and get the whole available information from the execution, in Java, in C++, in C#, in Python, and in LibreOffice or Apache OpenOffice Basic.
There are the list for the application foundations and the list for Calc of the UNO dispatch commands listed so far in this series.
Main Body
1: The Specifications
URL: .uno:SaveAs
Description: This command stores the current document to the specified file URL.
Arguments (the types are UNO datum types):
| Name | Type | Value |
|---|---|---|
| URL | string | The URL to which the document is stored |
| FilterName | string | The document-storing filter name |
| Password | string | The file-opening password for some file types |
| PasswordInteraction | boolean | Ineffective unless this command is invoked from the file storing dialog window |
| FilterOptions | string | The document-storing filter data in string |
| VersionComment | string | Ineffective because any new file (which the file created by this command will inevitably be) cannot have any versions information |
| VersionAuthor | string | Ineffective because any new file (which the file created by this command will inevitably be) cannot have any versions information |
| Overwrite | boolean | Overwrites the existing file (if any) |
| Unpacked | boolean | Unknown |
| SaveTo | boolean | The current document will not represent the stored file hereafter. |
| NoFileSync | boolean | The file is not synchronized to the storage. |
| NoThumbnail | boolean | Does not create any thumbnail |
The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):
| Type | Value |
|---|---|
| string | The literal, 'Save ~As...' |
| N/A | null |
The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):
| If | Type | Value |
|---|---|---|
| The command execution succeeded | boolean | 'true' |
| Otherwise | N/A | void |
<The previous article in this series | The table of contents of this series | The next article in this series>
