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 ::

interface XSearchable
Description
enables the object to look for specified contents of the object (in particular, for a text range which contains a specific string pattern).
Example
in a ::com::sun::star::text::TextDocument: set all "search for" to bold using findFirst()/findNext():
 xSearchDescr = xDocument.createSearchDescriptor()
 xSearchDescr.SearchString = "search for"
 xSearchDescr.SearchCaseSensitive = true
 xSearchDescr.SearchWords = true
 xFound = xDocument.findFirst( xSearchDescr )
 do while not IsNull(xFound)
 xFound.CharWeight = com.sun.star.awt.FontWeight.BOLD
 xFound = xDocument.findNext( xFound.End, xSearchDescr )
 loop
 
Developers Guide
Text - Navigating - Search and Replace

Methods' Summary
createSearchDescriptor creates a SearchDescriptor which contains properties that specify a search in this container. 
findAll searches the contained texts for all occurrences of whatever is specified. 
findFirst searches the contained texts for the next occurrence of whatever is specified.  
findNext searches the contained texts for the next occurrence of whatever is specified.  
Methods' Details
createSearchDescriptor
XSearchDescriptor
createSearchDescriptor();

Description
creates a SearchDescriptor which contains properties that specify a search in this container.
See also
SearchDescriptor
findAll
::com::sun::star::container::XIndexAccess
findAll( [in] XSearchDescriptor  xDesc );

Description
searches the contained texts for all occurrences of whatever is specified.
See also
SearchDescriptor
findFirst
::com::sun::star::uno::XInterface
findFirst( [in] XSearchDescriptor  xDesc );

Description
searches the contained texts for the next occurrence of whatever is specified.
Returns
the position within the component, e.g. a ::com::sun::star::text::XTextRange which determines the found elements.
See also
SearchDescriptor
findNext
::com::sun::star::uno::XInterface
findNext( [in] ::com::sun::star::uno::XInterface  xStartAt,
[in] XSearchDescriptor  xDesc );

Description
searches the contained texts for the next occurrence of whatever is specified.
Parameter xStartAt
represents a position within the component at which the search continues. This position is returned by XSearchable::findFirst or the previous XSearchable::findNext.
See also
SearchDescriptor
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.