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

interface XSearchable
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-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 = "to look for"
 xSearchDescr.SearchCaseSensitive = true
 xSearchDescr.SearchWholeWords = true
 xFound = xDocument.findFirst( xSearchDescr )
 do while xFound
 xFound.CharWeight = CharWeight_BOLD
 xFound = xDocument.findNext( xFound.End, xSearchDescr )
 loop
replace all bold "search for" by "look for" using findAll():
 xSearchDescr = xDocument.createSearchDescriptor()
 xSearchDescr.SearchString = "to look for"
 xSearchDescr.SearchCaseSensitive = true
 xSearchDescr.SearchWholeWords = true
 xStyles = createPropertySet( xSearchDescr.SearchStyles )
 xStyles.CharWeight = CharWeight_BOLD
 xSearchDescr.SearchStyles = xStyles.PropertyValues
 xAllFound = xDocument.findAll( xSearchDescr )
 for n% = lbound(xAllFound) to ubound(xAllFound)
 xAllFound(n%).String = "look for"
 loop
Developers Guide
7.3.3 Text Documents - Working with Text Documents - 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
[in] XSearchDescriptor
 
xStartAt,
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