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

service SearchDescriptor
Description
describes what and how to search within a container.
Developers Guide
Text - Navigating - Search and Replace

Exported Interfaces - Summary
XSearchDescriptor
(referenced entity's summary:)
specifies a string search operation.
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Summary
boolean
SearchBackwards
If true, the search is done backwards in the document.  
boolean
SearchCaseSensitive
If true, the case of the letters is important for the match.  
boolean
SearchWords
If true, only complete words will be found.  
boolean
SearchRegularExpression
If true, the search string is evaluated as a regular expression.  
boolean
SearchStyles
If true, it is searched for positions where the paragraph style with the name of the search pattern is applied.  
boolean
SearchSimilarity
If true, a "similarity search" is performed.  
boolean
SearchSimilarityRelax
If true, all similarity rules are applied together.  
short
SearchSimilarityRemove
This property specifies the number of characters that may be ignored to match the search pattern.  
short
SearchSimilarityAdd
specifies the number of characters that must be added to match the search pattern.  
short
SearchSimilarityExchange
This property specifies the number of characters that must be replaced to match the search pattern.  
Exported Interfaces - Details
XSearchDescriptor
(referenced entity's summary:)
specifies a string search operation.
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Details
SearchBackwards
boolean SearchBackwards;
Description
If true, the search is done backwards in the document.
SearchCaseSensitive
boolean SearchCaseSensitive;
Description
If true, the case of the letters is important for the match.
SearchWords
boolean SearchWords;
Description
If true, only complete words will be found.
SearchRegularExpression
boolean SearchRegularExpression;
Description
If true, the search string is evaluated as a regular expression.
SearchStyles
boolean SearchStyles;
Description
If true, it is searched for positions where the paragraph style with the name of the search pattern is applied.
SearchSimilarity
boolean SearchSimilarity;
Description
If true, a "similarity search" is performed.

In the case of a similarity search, the following properties specify the kind of similarity:

  • SearchSimilarityRelax
  • SearchSimilarityRemove
  • SearchSimilarityAdd
  • SearchSimilarityExchange
SearchSimilarityRelax
boolean SearchSimilarityRelax;
Description
If true, all similarity rules are applied together.

In the case of a relaxed similarity search, the following properties are applied together:

  • SearchSimilarityRemove
  • SearchSimilarityAdd
  • SearchSimilarityExchange
SearchSimilarityRemove
short SearchSimilarityRemove;
Description
This property specifies the number of characters that may be ignored to match the search pattern.
SearchSimilarityAdd
short SearchSimilarityAdd;
Description
specifies the number of characters that must be added to match the search pattern.
SearchSimilarityExchange
short SearchSimilarityExchange;
Description
This property specifies the number of characters that must be replaced to match the search pattern.

 
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.