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:SetDocumentProperties', 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:SetDocumentProperties
Description: This command sets the properties of the document.
Arguments (the types are UNO datum types):
| Name | Type | Value |
|---|---|---|
| Properties.UseUserData | boolean | Whether the document stores the user data |
| Properties.DeleteUserData | boolean | Whether the user data are deleted from the document |
| Properties.Title | string | The document title |
| Properties.Subject | string | The document subject |
| Properties.KeyWords | string | The document keywords |
| Properties.Description | string | The document description |
| Properties.AutoReload | boolean | Whether the document is reloaded automatically when the document is opened in the read-only mode |
| Properties.AutoReloadTime | long | The automatic reloading interval (seconds) |
| Properties.AutoReloadURL | string | The automatic reloading URL |
| Properties.AutoReloadFrame | string | The name of the automatic reloading frame |
The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):
Nothing.
The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):
| Type | Value |
|---|---|
| N/A | void |
<The previous article in this series | The table of contents of this series | The next article in this series>
