Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

service SearchDescriptor

Description
describes what and how to search within a container.


Exported Interfaces

com::sun::star::util::XSearchDescriptor
Description
specifies a string search operation.
com::sun::star::beans::XPropertySet
Description
provides information about and access to the properties from an implementation.

Properties' Summary

SearchBackwards If true , the search is done backwards in the document.
SearchCaseSensitive If true , the case of the letters is important for the match.
SearchWords If true , only complete words will be found.
SearchRegularExpression If true , the search string is evaluated as a regular expression.
SearchStyles If true , it is searched for positions where the paragraph style with the name of the search pattern is applied.
SearchSimilarity If true , a "similarity search" is performed.
SearchSimilarityRelax If true , all similarity rules are applied together.
SearchSimilarityRemove This property specifies the number of characters that may be ignored to match the search pattern.
SearchSimilarityAdd specifies the number of characters that must be added to match the search pattern.
SearchSimilarityExchange This property specifies the number of characters that must be replaced to match the search pattern.

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