ooodev.adapter.util.search_descriptor_partial_props module

This class is a partial class for com.sun.star.util.Shape.SearchDescriptor service.

class ooodev.adapter.util.search_descriptor_partial_props.SearchDescriptorPartialProps(component)[source]

Bases: object

Partial Class for Shape Service.

Parameters:: component (SearchDescriptor) –

__init__(component)[source]

Constructor

Parameters:: component (SearchDescriptor) – UNO Component that implements com.sun.star.util.SearchDescriptor service.
Return type:: None

property search_backwards: bool

If True, the search is done backwards in the document.

Return type:: bool

property search_case_sensitive: bool

If True, the case of the letters is important for the match.

Return type:: bool

property search_regular_expression: bool

If True, the search string is evaluated as a regular expression.

search_regular_expression, search_wildcard and search_similarity are mutually exclusive, only one can be True at the same time.

Return type:: bool

property search_similarity: bool

Gets/Sets - If True, a similarity search is performed.

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

search_regular_expression, search_wildcard and search_similarity are mutually exclusive, only one can be True at the same time.

Return type:: bool

property search_similarity_add: int

Gets/Sets the number of characters that must be added to match the search pattern.

Return type:: int

property search_similarity_exchange: int

Gets/Sets - This property specifies the number of characters that must be replaced to match the search pattern.

Return type:: int

property search_similarity_relax: bool

Gets/Sets If True, all similarity rules are applied together.

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

Return type:: bool

property search_similarity_remove: int

Gets/Sets - This property specifies the number of characters that may be ignored to match the search pattern.

Return type:: int

property search_styles: bool

Gets/Sets If True, it is searched for positions where the paragraph style with the name of the search pattern is applied.

Return type:: bool

property search_wildcard: bool | None

Gets/Sets - 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.

search_regular_expression, search_wildcard and search_similarity are mutually exclusive, only one can be True at the same time.

optional

Returns:: True if the search string is evaluated as a wildcard pattern, otherwise False. If the property is not supported, None is returned.
Return type:: bool | None

property search_words: bool

If True, only complete words will be found.

Return type:: bool