<html> <head> <title>Service SearchDescriptor</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="SearchDescriptor-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Navigating#Search_and_Replace" 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 SearchDescriptor</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>describes what and how to search within a container. </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Navigating#Search_and_Replace">Text - Navigating - Search and Replace</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"><a href="XSearchDescriptor.html">XSearchDescriptor</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a string search operation. </dd> </dl> </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"><dl> <dt>(referenced entity's summary:)</dt> <dd>provides information about and access to the properties from an implementation. </dd> </dl> </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">boolean<br> <a href="#SearchBackwards">SearchBackwards</a></td> <td class="imsum_right">If <b>true</b>, the search is done backwards in the document. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SearchCaseSensitive">SearchCaseSensitive</a></td> <td class="imsum_right">If <b>true</b>, the case of the letters is important for the match. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SearchWords">SearchWords</a></td> <td class="imsum_right">If <b>true</b>, only complete words will be found. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SearchRegularExpression">SearchRegularExpression</a></td> <td class="imsum_right">If <b>true</b>, the search string is evaluated as a regular expression. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SearchStyles">SearchStyles</a></td> <td class="imsum_right">If <b>true</b>, it is searched for positions where the paragraph style with the name of the search pattern is applied. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SearchSimilarity">SearchSimilarity</a></td> <td class="imsum_right">If <b>true</b>, a "similarity search" is performed. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SearchSimilarityRelax">SearchSimilarityRelax</a></td> <td class="imsum_right">If <b>true</b>, all similarity rules are applied together. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#SearchSimilarityRemove">SearchSimilarityRemove</a></td> <td class="imsum_right">This property specifies the number of characters that may be ignored to match the search pattern. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#SearchSimilarityAdd">SearchSimilarityAdd</a></td> <td class="imsum_right">specifies the number of characters that must be added to match the search pattern. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#SearchSimilarityExchange">SearchSimilarityExchange</a></td> <td class="imsum_right">This property specifies the number of characters that must be replaced to match the search pattern. </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="XSearchDescriptor" class="membertitle"><a href="XSearchDescriptor.html">XSearchDescriptor</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a string search operation. </dd> </dl> </td> </tr> </table> </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>(referenced entity's summary:)</dt> <dd>provides information about and access to the properties from an implementation. </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="SearchBackwards" class="membertitle">SearchBackwards</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchBackwards</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, the search is done backwards in the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchCaseSensitive" class="membertitle">SearchCaseSensitive</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchCaseSensitive</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, the case of the letters is important for the match. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchWords" class="membertitle">SearchWords</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchWords</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, only complete words will be found. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchRegularExpression" class="membertitle">SearchRegularExpression</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchRegularExpression</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, the search string is evaluated as a regular expression. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchStyles" class="membertitle">SearchStyles</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchStyles</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, it is searched for positions where the paragraph style with the name of the search pattern is applied. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchSimilarity" class="membertitle">SearchSimilarity</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchSimilarity</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, a "similarity search" is performed. </dd> <dd><p>In the case of a similarity search, the following properties specify the kind of similarity: </p> <ul> <li>SearchSimilarityRelax </li> <li>SearchSimilarityRemove </li> <li>SearchSimilarityAdd </li> <li>SearchSimilarityExchange </li> </ul> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchSimilarityRelax" class="membertitle">SearchSimilarityRelax</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SearchSimilarityRelax</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, all similarity rules are applied together. </dd> <dd><p>In the case of a relaxed similarity search, the following properties are applied together: </p> <ul> <li>SearchSimilarityRemove </li> <li>SearchSimilarityAdd </li> <li>SearchSimilarityExchange </li> </ul> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchSimilarityRemove" class="membertitle">SearchSimilarityRemove</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>SearchSimilarityRemove</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the number of characters that may be ignored to match the search pattern. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchSimilarityAdd" class="membertitle">SearchSimilarityAdd</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>SearchSimilarityAdd</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the number of characters that must be added to match the search pattern. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SearchSimilarityExchange" class="membertitle">SearchSimilarityExchange</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>SearchSimilarityExchange</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the number of characters that must be replaced to match the search pattern. </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>
