Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: util ::
interface XTextSearch
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XTextSearch
Description enables an object to search in its content.

Methods' Summary
setOptions | set the options for the forward or backward search.
searchForward | search forward in the searchStr, starts at startPos and ends by endpos. The result is returned in the SearchResult.
searchBackward | search backward in the searchStr, starts at startPos and ends by endpos. The endpos must be lower then the startpos, because the function searches backward! The result is returned in the SearchResult.

Methods' Details
setOptions
void setOptions( | [in] SearchOptions | options );
Description set the options for the forward or backward search.
searchForward
SearchResult searchForward( | [in] string [in] long [in] long | searchStr, startPos, endPos );
Description search forward in the searchStr, starts at startPos and ends by endpos. The result is returned in the SearchResult.
searchBackward
SearchResult searchBackward( | [in] string [in] long [in] long | searchStr, startPos, endPos );
Description search backward in the searchStr, starts at startPos and ends by endpos. The endpos must be lower then the startpos, because the function searches backward! The result is returned in the SearchResult.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.