FormFieldFacade.h
1 #pragma once
2 // Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.
3 
4 #include <system/array.h>
5 #include <drawing/rectangle.h>
6 #include <drawing/color.h>
7 #include <cstdint>
8 
9 #include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"
10 
11 namespace Aspose
12 {
13 namespace Pdf
14 {
15 namespace Facades
16 {
17 enum class EncodingType;
18 enum class FontStyle;
19 class Form;
20 class FormEditor;
21 } // namespace Facades
22 namespace Forms
23 {
24 enum class BoxStyle;
25 } // namespace Forms
26 } // namespace Pdf
27 } // namespace Aspose
28 
29 namespace Aspose {
30 
31 namespace Pdf {
32 
33 namespace Facades {
34 
38 class ASPOSE_PDF_SHARED_CLASS FormFieldFacade final : public System::Object
39 {
40  typedef FormFieldFacade ThisType;
41  typedef System::Object BaseType;
42 
43  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
44  ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
45 
48 
49 public:
50 
54  ASPOSE_PDF_SHARED_API System::Drawing::Color get_BorderColor() const;
58  ASPOSE_PDF_SHARED_API void set_BorderColor(System::Drawing::Color value);
62  ASPOSE_PDF_SHARED_API int32_t get_BorderStyle() const;
66  ASPOSE_PDF_SHARED_API void set_BorderStyle(int32_t value);
70  ASPOSE_PDF_SHARED_API float get_BorderWidth() const;
74  ASPOSE_PDF_SHARED_API void set_BorderWidth(float value);
78  ASPOSE_PDF_SHARED_API FontStyle get_Font() const;
82  ASPOSE_PDF_SHARED_API void set_Font(FontStyle value);
86  ASPOSE_PDF_SHARED_API System::String get_CustomFont() const;
90  ASPOSE_PDF_SHARED_API void set_CustomFont(System::String value);
94  ASPOSE_PDF_SHARED_API float get_FontSize() const;
98  ASPOSE_PDF_SHARED_API void set_FontSize(float value);
102  ASPOSE_PDF_SHARED_API System::Drawing::Color get_TextColor() const;
106  ASPOSE_PDF_SHARED_API void set_TextColor(System::Drawing::Color value);
110  ASPOSE_PDF_SHARED_API EncodingType get_TextEncoding() const;
114  ASPOSE_PDF_SHARED_API void set_TextEncoding(EncodingType value);
118  ASPOSE_PDF_SHARED_API int32_t get_Alignment() const;
122  ASPOSE_PDF_SHARED_API void set_Alignment(int32_t value);
126  ASPOSE_PDF_SHARED_API int32_t get_Rotation() const;
130  ASPOSE_PDF_SHARED_API void set_Rotation(int32_t value);
134  ASPOSE_PDF_SHARED_API System::String get_Caption() const;
138  ASPOSE_PDF_SHARED_API void set_Caption(System::String value);
142  ASPOSE_PDF_SHARED_API int32_t get_ButtonStyle() const;
146  ASPOSE_PDF_SHARED_API void set_ButtonStyle(int32_t value);
150  ASPOSE_PDF_SHARED_API System::Drawing::Rectangle get_Box() const;
154  ASPOSE_PDF_SHARED_API void set_Box(System::Drawing::Rectangle value);
158  ASPOSE_PDF_SHARED_API System::ArrayPtr<float> get_Position() const;
162  ASPOSE_PDF_SHARED_API void set_Position(System::ArrayPtr<float> value);
166  ASPOSE_PDF_SHARED_API int32_t get_PageNumber() const;
170  ASPOSE_PDF_SHARED_API void set_PageNumber(int32_t value);
174  ASPOSE_PDF_SHARED_API System::ArrayPtr<System::String> get_Items() const;
178  ASPOSE_PDF_SHARED_API void set_Items(System::ArrayPtr<System::String> value);
182  ASPOSE_PDF_SHARED_API void set_ExportItems(System::ArrayPtr<System::ArrayPtr<System::String>> value);
186  ASPOSE_PDF_SHARED_API System::Drawing::Color get_BackgroundColor() const;
190  ASPOSE_PDF_SHARED_API void set_BackgroundColor(System::Drawing::Color value);
191 
195  ASPOSE_PDF_SHARED_API void Reset();
196 
197  ASPOSE_PDF_SHARED_API FormFieldFacade();
198 
199 protected:
200 
203 
204  void setFontStyle(System::String fontName);
210  FontStyle shortNameToStyle(System::String fontName);
211  Aspose::Pdf::Forms::BoxStyle translateCheckBoxStyle();
212 
213 private:
214 
215  System::Drawing::Color borderColor;
216  System::Drawing::Color backgroundColor;
217  int32_t borderStyle;
218  float borderWidth;
219  FontStyle fontStyle;
220  float fontSize;
221  System::Drawing::Color textColor;
222  EncodingType encodingType;
223  int32_t alignment;
224  int32_t rotation;
225  System::String caption;
226  int32_t buttonStyle;
228  System::ArrayPtr<float> position;
229  int32_t pageNumber;
232 
233 public:
234 
238  static constexpr ASPOSE_PDF_SHARED_API float BorderWidthUndefined = -1;
242  static constexpr ASPOSE_PDF_SHARED_API float BorderWidthThin = 1;
246  static constexpr ASPOSE_PDF_SHARED_API float BorderWidthMedium = 2;
250  static constexpr ASPOSE_PDF_SHARED_API float BorderWidthThick = 3;
254  static constexpr ASPOSE_PDF_SHARED_API int32_t BorderStyleSolid = 0;
258  static constexpr ASPOSE_PDF_SHARED_API int32_t BorderStyleDashed = 1;
262  static constexpr ASPOSE_PDF_SHARED_API int32_t BorderStyleBeveled = 2;
266  static constexpr ASPOSE_PDF_SHARED_API int32_t BorderStyleInset = 3;
270  static constexpr ASPOSE_PDF_SHARED_API int32_t BorderStyleUnderline = 4;
274  static constexpr ASPOSE_PDF_SHARED_API int32_t BorderStyleUndefined = 5;
278  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignLeft = 0;
282  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignCenter = 1;
286  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignRight = 2;
290  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignUndefined = 3;
294  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignJustified = 4;
298  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignTop = 0;
302  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignMiddle = 1;
306  static constexpr ASPOSE_PDF_SHARED_API int32_t AlignBottom = 2;
310  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleCircle = u'l';
314  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleCheck = u'4';
318  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleCross = u'8';
322  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleDiamond = u'u';
326  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleStar = u'H';
330  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleSquare = u'n';
334  static constexpr ASPOSE_PDF_SHARED_API int32_t CheckBoxStyleUndefined = u' ';
335 
336 };
337 
338 } // namespace Facades
339 } // namespace Pdf
340 } // namespace Aspose
341 
342 
String class used across the library. Is a substitute for C# System.String when translating code...
Definition: string.h:121
ASPOSE_PDF_SHARED_API void set_ExportItems(System::ArrayPtr< System::ArrayPtr< System::String >> value)
Sets options for combo box with export values.
Class representing Acro form object.
Definition: Form.h:115
Base class that enables using methods available for System.Object class in C#. All non-trivial classe...
Definition: object.h:64
FontStyle
Enumerates 14 types of font.
Definition: FontStyle.h:13
Represents a rectangular area of an image defined as integer X and Y coordinates of its upper left co...
Definition: rectangle.h:18
BoxStyle
Represents styles of check box.
Definition: BoxStyle.h:18
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: fwd.h:22
System::String _customFont
Definition: FormFieldFacade.h:202
EncodingType
Enumerates encoding types of the text using.
Definition: EncodingType.h:13
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::String > get_Items() const
Sets items which will be added t onewly created list box or combo box.
Definition: AFRelationship.h:4
Represents a color. This type should be allocated on stack and passed to functions by value or by ref...
Definition: color.h:23
ASPOSE_PDF_SHARED_API void set_Items(System::ArrayPtr< System::String > value)
Sets items which will be added t onewly created list box or combo box.
Class for representing field properties.
Definition: FormFieldFacade.h:38
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::ArrayPtr< System::String > > get_ExportItems() const
Sets options for combo box with export values.
bool _customFontSpecified
Definition: FormFieldFacade.h:201
Class for editing forms (ading/deleting field etc)
Definition: FormEditor.h:73
Whole PDF file will be submitted.