2019-12-29

98: The UNO Dispatch Command Specifications of '.uno:SaveAs'

<The previous article in this series | The table of contents of this series | The next article in this series>


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):

NameTypeValue
URLstringThe URL to which the document is stored
FilterNamestringThe document-storing filter name
PasswordstringThe file-opening password for some file types
PasswordInteractionbooleanIneffective unless this command is invoked from the file storing dialog window
FilterOptionsstringThe document-storing filter data in string
VersionCommentstringIneffective because any new file (which the file created by this command will inevitably be) cannot have any versions information
VersionAuthorstringIneffective because any new file (which the file created by this command will inevitably be) cannot have any versions information
OverwritebooleanOverwrites the existing file (if any)
UnpackedbooleanUnknown
SaveTobooleanThe current document will not represent the stored file hereafter.
NoFileSyncbooleanThe file is not synchronized to the storage.
NoThumbnailbooleanDoes not create any thumbnail

The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):

TypeValue
stringThe literal, 'Save ~As...'
N/Anull

The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):

IfTypeValue
The command execution succeededboolean'true'
OtherwiseN/Avoid

<The previous article in this series | The table of contents of this series | The next article in this series>