TextSearchOptions.h
1 #pragma once
2 // Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.
3 
4 #include <system/array.h>
5 #include <cstdint>
6 
7 #include "Aspose.PDF.Cpp/Text/TextOptions/TextOptions.h"
8 #include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"
9 
10 namespace Aspose
11 {
12 namespace Pdf
13 {
14 namespace Comparison
15 {
16 namespace SideBySideComparison
17 {
18 class IgnoreSpacesFragmentsProcessor;
19 class NormalFragmentProcessor;
20 } // namespace SideBySideComparison
21 } // namespace Comparison
22 namespace Engine
23 {
24 namespace CommonData
25 {
26 namespace Text
27 {
28 namespace Segmenting
29 {
30 class TextSegmenter;
31 class TextSegmentSettings;
32 } // namespace Segmenting
33 } // namespace Text
34 } // namespace CommonData
35 } // namespace Engine
36 class Rectangle;
37 namespace Tests
38 {
39 class RegressionTests_v24_06;
40 } // namespace Tests
41 namespace Text
42 {
43 class TextAbsorber;
44 class TextFragmentAbsorber;
45 } // namespace Text
46 } // namespace Pdf
47 } // namespace Aspose
48 
49 namespace Aspose {
50 
51 namespace Pdf {
52 
53 namespace Text {
54 
58 class ASPOSE_PDF_SHARED_CLASS TextSearchOptions final : public Aspose::Pdf::Text::TextOptions
59 {
62 
63  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
64  ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
65 
66  friend class Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmentSettings;
67  friend class Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter;
70  friend class Aspose::Pdf::Comparison::SideBySideComparison::IgnoreSpacesFragmentsProcessor;
71  friend class Aspose::Pdf::Comparison::SideBySideComparison::NormalFragmentProcessor;
72  friend class Aspose::Pdf::Tests::RegressionTests_v24_06;
73 
74 public:
75 
79  ASPOSE_PDF_SHARED_API bool get_IsRegularExpressionUsed() const;
83  ASPOSE_PDF_SHARED_API void set_IsRegularExpressionUsed(bool value);
87  ASPOSE_PDF_SHARED_API bool get_LimitToPageBounds() const;
91  ASPOSE_PDF_SHARED_API void set_LimitToPageBounds(bool value);
98  ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> get_Rectangle() const;
105  ASPOSE_PDF_SHARED_API void set_Rectangle(System::SharedPtr<Aspose::Pdf::Rectangle> value);
111  ASPOSE_PDF_SHARED_API bool get_UseFontEngineEncoding() const;
117  ASPOSE_PDF_SHARED_API void set_UseFontEngineEncoding(bool value);
123  ASPOSE_PDF_SHARED_API bool get_IgnoreShadowText() const;
129  ASPOSE_PDF_SHARED_API void set_IgnoreShadowText(bool value);
135  ASPOSE_PDF_SHARED_API bool get_LogTextExtractionErrors() const;
141  ASPOSE_PDF_SHARED_API void set_LogTextExtractionErrors(bool value);
147  ASPOSE_PDF_SHARED_API bool get_IgnoreResourceFontErrors() const;
153  ASPOSE_PDF_SHARED_API void set_IgnoreResourceFontErrors(bool value);
159  ASPOSE_PDF_SHARED_API bool get_SearchForTextRelatedGraphics() const;
165  ASPOSE_PDF_SHARED_API void set_SearchForTextRelatedGraphics(bool value);
170  ASPOSE_PDF_SHARED_API int32_t get_StoredGraphicElementsMaxCount() const;
175  ASPOSE_PDF_SHARED_API void set_StoredGraphicElementsMaxCount(int32_t value);
181  ASPOSE_PDF_SHARED_API bool get_SearchInAnnotations() const;
187  ASPOSE_PDF_SHARED_API void set_SearchInAnnotations(bool value);
188 
194  ASPOSE_PDF_SHARED_API TextSearchOptions(bool isRegularExpressionUsed);
200  ASPOSE_PDF_SHARED_API TextSearchOptions(System::SharedPtr<Aspose::Pdf::Rectangle> rectangle);
207  ASPOSE_PDF_SHARED_API TextSearchOptions(System::SharedPtr<Aspose::Pdf::Rectangle> rectangle, bool isRegularExpressionUsed);
208 
209 protected:
210 
211  static const int32_t StoredGraphicElementsDefault;
212 
216  System::ArrayPtr<System::SharedPtr<Aspose::Pdf::Rectangle>> get_ExcludeRectangles() const;
220  void set_ExcludeRectangles(System::ArrayPtr<System::SharedPtr<Aspose::Pdf::Rectangle>> value);
226  bool get_SearchForClippingPaths() const;
232  void set_SearchForClippingPaths(bool value);
233  int32_t get_ClippingPathsProcessing() const;
234  void set_ClippingPathsProcessing(int32_t value);
238  bool get_IsPerformance() const;
242  void set_IsPerformance(bool value);
243 
244 private:
245 
246  bool isRegularExpressionUsed;
247  bool limitToPageBounds;
250  bool useFontEngineEncoding;
251  bool ignoreShadowText;
252  bool isPerformance;
253  bool logTextExtractionErrors;
254  bool ignoreResourceFontErrors;
255  bool searchForGraphics;
256  bool searchForClippingPaths;
257  bool searchInAnnotations;
258  int32_t pr_StoredGraphicElementsMaxCount;
259  int32_t pr_ClippingPathsProcessing;
260 
261 };
262 
263 } // namespace Text
264 } // namespace Pdf
265 } // namespace Aspose
266 
267 
Represents an absorber object of a text. Performs text extraction and provides access to the result v...
Definition: TextAbsorber.h:72
Base class that enables using methods available for System.Object class in C#. All non-trivial classe...
Definition: object.h:64
Represents an absorber object of text fragments. Performs text search and provides access to search r...
Definition: TextFragmentAbsorber.h:81
static const int32_t StoredGraphicElementsDefault
Definition: TextSearchOptions.h:211
Definition: signed_info.h:13
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: SideBySidePdfComparer.h:24
Represents a text type.
Definition: AFRelationship.h:4
Represents text search options
Definition: TextSearchOptions.h:58
Represents text processing options
Definition: TextOptions.h:17
Whole PDF file will be submitted.