<html> <head> <title>Interface XSearchable</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="XSearchable-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</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">interface XSearchable</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>enables the object to look for specified contents of the object (in particular, for a text range which contains a specific string pattern). </dd> <dt><b>Example</b></dt> <dd>in a ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/TextDocument.html">TextDocument</a>: set all "search for" to bold using findFirst()/findNext(): <pre> xSearchDescr = xDocument.createSearchDescriptor() xSearchDescr.SearchString = "search for" xSearchDescr.SearchCaseSensitive = <b>true</b> xSearchDescr.SearchWords = <b>true</b> xFound = xDocument.findFirst( xSearchDescr ) do while not IsNull(xFound) xFound.CharWeight = com.sun.star.awt.FontWeight.BOLD xFound = xDocument.findNext( xFound.End, xSearchDescr ) loop </pre> </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="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#createSearchDescriptor">createSearchDescriptor</a></td> <td class="imsum_right">creates a <a href="SearchDescriptor.html">SearchDescriptor</a> which contains properties that specify a search in this container. </td> </tr> <tr> <td class="imsum_left"><a href="#findAll">findAll</a></td> <td class="imsum_right">searches the contained texts for all occurrences of whatever is specified. </td> </tr> <tr> <td class="imsum_left"><a href="#findFirst">findFirst</a></td> <td class="imsum_right">searches the contained texts for the next occurrence of whatever is specified. </td> </tr> <tr> <td class="imsum_left"><a href="#findNext">findNext</a></td> <td class="imsum_right">searches the contained texts for the next occurrence of whatever is specified. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="createSearchDescriptor" class="membertitle">createSearchDescriptor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XSearchDescriptor.html">XSearchDescriptor</a></td> </tr> <tr> <td valign="top"><b>createSearchDescriptor</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a <a href="SearchDescriptor.html">SearchDescriptor</a> which contains properties that specify a search in this container.</dd> <dt><b>See also</b></dt> <dd><a href="SearchDescriptor.html">SearchDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="findAll" class="membertitle">findAll</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>findAll</b>(</td> <td valign="top">[in] <a href="XSearchDescriptor.html">XSearchDescriptor</a></td> <td valign="bottom"> xDesc );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches the contained texts for all occurrences of whatever is specified.</dd> <dt><b>See also</b></dt> <dd><a href="SearchDescriptor.html">SearchDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="findFirst" class="membertitle">findFirst</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>findFirst</b>(</td> <td valign="top">[in] <a href="XSearchDescriptor.html">XSearchDescriptor</a></td> <td valign="bottom"> xDesc );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches the contained texts for the next occurrence of whatever is specified. </dd> <dt><b>Returns</b></dt> <dd>the position within the component, e.g. a ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/XTextRange.html">XTextRange</a> which determines the found elements. </dd> <dt><b>See also</b></dt> <dd><a href="SearchDescriptor.html">SearchDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="findNext" class="membertitle">findNext</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>findNext</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xStartAt,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XSearchDescriptor.html">XSearchDescriptor</a></td> <td valign="bottom"> xDesc );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches the contained texts for the next occurrence of whatever is specified. </dd> <dt><b>Parameter xStartAt</b></dt> <dd>represents a position within the component at which the search continues. This position is returned by <method>XSearchable::findFirst</method> or the previous <method>XSearchable::findNext</method>. </dd> <dt><b>See also</b></dt> <dd><a href="SearchDescriptor.html">SearchDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>