describes what and how to search within a container.  
 More...
import "SearchDescriptor.idl";
|  | 
| 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 | 
|  | If TRUE, the search string is evaluated as a wildcard pattern.
 | 
|  | 
| long | WildcardEscapeCharacter | 
|  | Specifies the character used to escape special characters in wildcards. 
 | 
|  | 
|  | 
| string | getSearchString () | 
|  | 
| void | setSearchString ([in] string aString) | 
|  | sets the string of characters to look for. 
 | 
|  | 
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () | 
|  | 
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue)  raises ( com::sun::star::beans::UnknownPropertyException,                    com::sun::star::beans::PropertyVetoException,                    com::sun::star::lang::IllegalArgumentException,                    com::sun::star::lang::WrappedTargetException ) | 
|  | sets the value of the property with the specified name. 
 | 
|  | 
| any | getPropertyValue ([in] string PropertyName)  raises ( com::sun::star::beans::UnknownPropertyException,                    com::sun::star::lang::WrappedTargetException ) | 
|  | 
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener)  raises ( com::sun::star::beans::UnknownPropertyException,                    com::sun::star::lang::WrappedTargetException ) | 
|  | adds an XPropertyChangeListener to the specified property. 
 | 
|  | 
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener)  raises ( com::sun::star::beans::UnknownPropertyException,                    com::sun::star::lang::WrappedTargetException ) | 
|  | removes an XPropertyChangeListener from the listener list. 
 | 
|  | 
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener)  raises ( com::sun::star::beans::UnknownPropertyException,                    com::sun::star::lang::WrappedTargetException ) | 
|  | adds an XVetoableChangeListener to the specified property with the name PropertyName. 
 | 
|  | 
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener)  raises ( com::sun::star::beans::UnknownPropertyException,                    com::sun::star::lang::WrappedTargetException ) | 
|  | removes an XVetoableChangeListener from the listener list. 
 | 
|  | 
| any | queryInterface ([in] type aType) | 
|  | queries for a new interface to an existing UNO object. 
 | 
|  | 
| void | acquire () | 
|  | increases the reference counter by one. 
 | 
|  | 
| void | release () | 
|  | decreases the reference counter by one. 
 | 
|  | 
describes what and how to search within a container. 
- Developers Guide
- Text Documents - Navigating - Search and Replace
 
◆ com::sun::star::beans::XPropertySet
◆ com::sun::star::util::XSearchDescriptor
◆ SearchBackwards
If TRUE, the search is done backwards in the document. 
 
 
◆ SearchCaseSensitive
  
  | 
        
          | boolean SearchCaseSensitive |  | property | 
 
If TRUE, the case of the letters is important for the match. 
 
 
◆ SearchRegularExpression
  
  | 
        
          | boolean SearchRegularExpression |  | property | 
 
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. 
 
 
◆ SearchSimilarity
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. 
 
 
◆ SearchSimilarityAdd
  
  | 
        
          | short SearchSimilarityAdd |  | property | 
 
specifies the number of characters that must be added to match the search pattern. 
 
 
◆ SearchSimilarityExchange
  
  | 
        
          | short SearchSimilarityExchange |  | property | 
 
This property specifies the number of characters that must be replaced to match the search pattern. 
 
 
◆ SearchSimilarityRelax
  
  | 
        
          | boolean SearchSimilarityRelax |  | property | 
 
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 |  | property | 
 
This property specifies the number of characters that may be ignored to match the search pattern. 
 
 
◆ SearchStyles
If TRUE, it is searched for positions where the paragraph style with the name of the search pattern is applied. 
 
 
◆ SearchWildcard
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 
 
 
◆ SearchWords
If TRUE, only complete words will be found. 
 
 
◆ WildcardEscapeCharacter
  
  | 
        
          | long WildcardEscapeCharacter |  | optionalproperty | 
 
Specifies the character used to escape special characters in wildcards. 
- Since
- LibreOffice 24.2 
 
 
The documentation for this service was generated from the following file: