Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: util ::

service PathSettings
Description
Supports read/write access and listener for the paths properties that the Office uses.

The property names of the Office paths/directories are an exactly match to the configuration entries found in the file (org/openoffice/Office/Common.xml).
This service supports the usage of path variables to define paths that a relative to other office or system directories. See PathSubstitution

Since
OOo 1.1.2
Developers Guide
OfficeDev - Path Settings

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet

Main interface to have access to the path properties.

::com::sun::star::beans::XFastPropertySet

An extension to the ::com::sun::star::beans::XPropertySet interface. The get and set methods use handles to access the property values instead of character strings.

::com::sun::star::beans::XMultiPropertySet

Provides access to multiple properties of this service with a single call.

Properties' Summary
string
Addin
Specifies the directory that contains spreadsheet add-ins which use the old add-in API  
string
AutoCorrect
The settings of the AutoCorrect dialog. The value can be more than one path separated by a semicolon.  
string
AutoText
The directory which contains the AutoText modules. The value can be more than one path separated by a semicolon. 
string
Backup
Automatic backup copies of documents are stored here.  
string
Basic
The Basic files, used by the AutoPilots, can be found here. The value can be more than one path separated by a semicolon. 
string
Bitmap
This directory contains the icons for the toolbars.  
string
Config
The configuration files are located here. This entry cannot be changed by the user in Office user interface.  
string
Dictionary
The provided dictionaries are stored here.  
string
Favorite
Path to save folder bookmarks  
string
Filter
Specifies the directory where all the filters are stored.  
string
Gallery
Specifies the directories which contains the Gallery database and multimedia files. The value can be more than one path separated by a semicolon. 
string
Graphic
This directory is displayed when the dialog for opening a graphic or for saving a new graphic is called.  
string
Help
The path to the Office help files.  
string
Linguistic
The files that are necessary for the spellcheck are saved here.  
string
Module
This is the path for the modules.  
string
Palette
This is the path to the palette files *.SOB to *.SOF containing user-defined colors and patterns.  
string
Plugin
Plugins are saved in these directories. The value can be more than one path separated by a semicolon. 
string
Storage
Mail, News files and other information (for example, about FTP Server) are stored here. 
string
Temp
The base url to the office temp-files  
string
Template
The templates originate from these folders and sub-folders. The value can be more than one path separated by a semicolon. 
string
UIConfig
Global directories to look for user interface configuration files. The user interface configuration will be merged with user settings stored in the directory specified by UserConfig. The value can be more than one path separated by a semicolon. 
string
UserConfig
Specifies the folder with the user settings.  
string
UserDictionary
[ DEPRECATED ]
The custom dictionaries are contained here. *  
string
Work
The path of the work folder can be modified according to the user's needs. The path specified here can be seen in the Open or Save dialog.  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
Description
Main interface to have access to the path properties.
::com::sun::star::beans::XFastPropertySet
Description
An extension to the ::com::sun::star::beans::XPropertySet interface. The get and set methods use handles to access the property values instead of character strings.
::com::sun::star::beans::XMultiPropertySet
Description
Provides access to multiple properties of this service with a single call.
Properties' Details
Addin
string Addin;
Description
Specifies the directory that contains spreadsheet add-ins which use the old add-in API
AutoCorrect
string AutoCorrect;
Description
The settings of the AutoCorrect dialog. The value can be more than one path separated by a semicolon.
AutoText
string AutoText;
Description
The directory which contains the AutoText modules. The value can be more than one path separated by a semicolon.
Backup
string Backup;
Description
Automatic backup copies of documents are stored here.
Basic
string Basic;
Description
The Basic files, used by the AutoPilots, can be found here. The value can be more than one path separated by a semicolon.
Bitmap
string Bitmap;
Description
This directory contains the icons for the toolbars.
Config
string Config;
Description
The configuration files are located here. This entry cannot be changed by the user in Office user interface.
Dictionary
string Dictionary;
Description
The provided dictionaries are stored here.
Favorite
string Favorite;
Description
Path to save folder bookmarks
Filter
string Filter;
Description
Specifies the directory where all the filters are stored.
Gallery
string Gallery;
Description
Specifies the directories which contains the Gallery database and multimedia files. The value can be more than one path separated by a semicolon.
Graphic
string Graphic;
Description
This directory is displayed when the dialog for opening a graphic or for saving a new graphic is called.
Help
string Help;
Description
The path to the Office help files.
Linguistic
string Linguistic;
Description
The files that are necessary for the spellcheck are saved here.
Module
string Module;
Description
This is the path for the modules.
Palette
string Palette;
Description
This is the path to the palette files *.SOB to *.SOF containing user-defined colors and patterns.
Plugin
string Plugin;
Description
Plugins are saved in these directories. The value can be more than one path separated by a semicolon.
Storage
string Storage;
Description
Mail, News files and other information (for example, about FTP Server) are stored here.
Temp
string Temp;
Description
The base url to the office temp-files
Template
string Template;
Description
The templates originate from these folders and sub-folders. The value can be more than one path separated by a semicolon.
UIConfig
string UIConfig;
Description
Global directories to look for user interface configuration files. The user interface configuration will be merged with user settings stored in the directory specified by UserConfig. The value can be more than one path separated by a semicolon.
UserConfig
string UserConfig;
Description
Specifies the folder with the user settings.
UserDictionary
string UserDictionary;
Usage Restrictions
deprecated
Deprecation Info
*
Description
The custom dictionaries are contained here. *
Work
string Work;
Description
The path of the work folder can be modified according to the user's needs. The path specified here can be seen in the Open or Save dialog.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.