<html> <head> <title>Service PathSettings</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="PathSettings-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Path_Settings" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">util</a> :: </p> </td> </tr> <tr> <td class="title">service PathSettings</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Supports read/write access and listener for the paths properties that the Office uses. </dd> <dd><p> 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).<br> This service supports the usage of path variables to define paths that a relative to other office or system directories. See <a href="PathSubstitution.html">PathSubstitution</a> </p> </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2 </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Path_Settings">OfficeDev - Path Settings</a></dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><p>Main interface to have access to the path properties. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XFastPropertySet.html">XFastPropertySet</a></td> <td class="imsum_right"><p>An extension to the ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> interface. The get and set methods use handles to access the property values instead of character strings. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XMultiPropertySet.html">XMultiPropertySet</a></td> <td class="imsum_right"><p>Provides access to multiple properties of this service with a single call. </p> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Addin">Addin</a></td> <td class="imsum_right">Specifies the directory that contains spreadsheet add-ins which use the old add-in API </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#AutoCorrect">AutoCorrect</a></td> <td class="imsum_right">The settings of the AutoCorrect dialog. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#AutoText">AutoText</a></td> <td class="imsum_right">The directory which contains the AutoText modules. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Backup">Backup</a></td> <td class="imsum_right">Automatic backup copies of documents are stored here. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Basic">Basic</a></td> <td class="imsum_right">The Basic files, used by the AutoPilots, can be found here. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Bitmap">Bitmap</a></td> <td class="imsum_right">This directory contains the icons for the toolbars. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Config">Config</a></td> <td class="imsum_right">The configuration files are located here. This entry cannot be changed by the user in Office user interface. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Dictionary">Dictionary</a></td> <td class="imsum_right">The provided dictionaries are stored here. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Favorite">Favorite</a></td> <td class="imsum_right">Path to save folder bookmarks </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Filter">Filter</a></td> <td class="imsum_right">Specifies the directory where all the filters are stored. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Gallery">Gallery</a></td> <td class="imsum_right">Specifies the directories which contains the Gallery database and multimedia files. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Graphic">Graphic</a></td> <td class="imsum_right">This directory is displayed when the dialog for opening a graphic or for saving a new graphic is called. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Help">Help</a></td> <td class="imsum_right">The path to the Office help files. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Linguistic">Linguistic</a></td> <td class="imsum_right">The files that are necessary for the spell check are saved here. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Module">Module</a></td> <td class="imsum_right">This is the path for the modules. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Palette">Palette</a></td> <td class="imsum_right">This is the path to the palette files *.SOB to *.SOF containing user-defined colors and patterns. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Plugin">Plugin</a></td> <td class="imsum_right">Plugins are saved in these directories. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Storage">Storage</a></td> <td class="imsum_right">Mail, News files and other information (for example, about FTP Server) are stored here. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Temp">Temp</a></td> <td class="imsum_right">The base url to the office temp-files </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Template">Template</a></td> <td class="imsum_right">The templates originate from these folders and sub-folders. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UIConfig">UIConfig</a></td> <td class="imsum_right">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 <var>UserConfig</var>. The value can be more than one path separated by a semicolon. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UserConfig">UserConfig</a></td> <td class="imsum_right">Specifies the folder with the user settings. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UserDictionary">UserDictionary</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b>The custom dictionaries are contained here. * </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Work">Work</a></td> <td class="imsum_right">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. </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Main interface to have access to the path properties. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XFastPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XFastPropertySet.html">XFastPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>An extension to the ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> interface. The get and set methods use handles to access the property values instead of character strings. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XMultiPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XMultiPropertySet.html">XMultiPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Provides access to multiple properties of this service with a single call. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Addin" class="membertitle">Addin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Addin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies the directory that contains spreadsheet add-ins which use the old add-in API </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoCorrect" class="membertitle">AutoCorrect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>AutoCorrect</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The settings of the AutoCorrect dialog. The value can be more than one path separated by a semicolon. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoText" class="membertitle">AutoText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>AutoText</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The directory which contains the AutoText modules. The value can be more than one path separated by a semicolon.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Backup" class="membertitle">Backup</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Backup</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Automatic backup copies of documents are stored here. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Basic" class="membertitle">Basic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Basic</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The Basic files, used by the AutoPilots, can be found here. The value can be more than one path separated by a semicolon.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Bitmap" class="membertitle">Bitmap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Bitmap</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This directory contains the icons for the toolbars. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Config" class="membertitle">Config</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Config</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The configuration files are located here. This entry cannot be changed by the user in Office user interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Dictionary" class="membertitle">Dictionary</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Dictionary</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The provided dictionaries are stored here. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Favorite" class="membertitle">Favorite</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Favorite</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Path to save folder bookmarks </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Filter" class="membertitle">Filter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Filter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies the directory where all the filters are stored. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Gallery" class="membertitle">Gallery</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Gallery</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies the directories which contains the Gallery database and multimedia files. The value can be more than one path separated by a semicolon.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Graphic" class="membertitle">Graphic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Graphic</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This directory is displayed when the dialog for opening a graphic or for saving a new graphic is called. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Help" class="membertitle">Help</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Help</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The path to the Office help files. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Linguistic" class="membertitle">Linguistic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Linguistic</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The files that are necessary for the spell check are saved here. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Module" class="membertitle">Module</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Module</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the path for the modules. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Palette" class="membertitle">Palette</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Palette</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the path to the palette files *.SOB to *.SOF containing user-defined colors and patterns. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Plugin" class="membertitle">Plugin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Plugin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Plugins are saved in these directories. The value can be more than one path separated by a semicolon.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Storage" class="membertitle">Storage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Storage</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Mail, News files and other information (for example, about FTP Server) are stored here.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Temp" class="membertitle">Temp</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Temp</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The base url to the office temp-files </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Template" class="membertitle">Template</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Template</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The templates originate from these folders and sub-folders. The value can be more than one path separated by a semicolon.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UIConfig" class="membertitle">UIConfig</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UIConfig</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>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 <var>UserConfig</var>. The value can be more than one path separated by a semicolon.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UserConfig" class="membertitle">UserConfig</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UserConfig</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies the folder with the user settings. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UserDictionary" class="membertitle">UserDictionary</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UserDictionary</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Deprecation Info</b></dt> <dd>* </dd> <dt><b>Description</b></dt> <dd>The custom dictionaries are contained here. * </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Work" class="membertitle">Work</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Work</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
