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

service SearchDescriptor

Exported Interfaces - Summary
XSearchDescriptor
(referenced entity's summary:)
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
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.  
boolean
SearchWildcard
[ OPTIONAL ]
If `TRUE`, the search string is evaluated as a wildcard pattern.  
Exported Interfaces - Details
XSearchDescriptor
(referenced entity's summary:)
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
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.

SearchRegularExpression, SearchWildcard and SearchSimilarity are mutually exclusive, only one can be `TRUE` at the same time.

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

SearchRegularExpression, SearchWildcard and SearchSimilarity are mutually exclusive, only one can be `TRUE` at the same time.

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.
SearchWildcard
boolean SearchWildcard;
Usage Restrictions
optional
Description
If `TRUE`, the search string is evaluated as a wildcard pattern.

Wildcards are '*' (asterisk) for any sequence of characters, including an empty sequence, and '?' (question mark) for exactly one character. Escape character is '\' (U+005C REVERSE SOLIDUS) aka backslash, it escapes the special meaning of a question mark, asterisk or escape character that follows immediately after the escape character.

SearchRegularExpression, SearchWildcard and SearchSimilarity are mutually exclusive, only one can be `TRUE` at the same time.


Since LibreOffice 5.2

 
Top of Page