Aspose::Pdf::Forms::BarcodeField class
Contents
[
Hide
]BarcodeField class
Class represents barcode field.
class BarcodeField : public Aspose::Pdf::Forms::TextBoxField
Methods
| Method | Description |
|---|---|
| Accept(System::SharedPtr<AnnotationSelector>) override | Accepts visitor. |
| AddBarcode(System::String) | Adds barcode 128 into the field. Field value will be changed onto the code and field become read only. |
| AddImage(System::SharedPtr<System::Drawing::Image>) | Adds image into the field resources and draws it. |
| BarcodeField(System::SharedPtr<Aspose::Pdf::Page>, System::SharedPtr<Rectangle>) | Initializes new instance of the BarcodeField class. |
| BarcodeField(System::SharedPtr<Document>, System::SharedPtr<Rectangle>) | Initializes new instance of the BarcodeField class. |
| BaseParagraph() | |
| virtual ChangeAfterResize(System::SharedPtr<Matrix>) | Update parameters and appearance, according to the matrix transform. |
| Clone() override | Clones this instance. Virtual method. Always return null. |
| CopyTo(System::ArrayPtr<System::SharedPtr<Field>>, int32_t) | Copies subfields of this field into array starting from specified index. |
| CopyToWidgetArray(System::ArrayPtr<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>, int32_t) | Copies subfields of this field into array starting from specified index. |
| ExecuteFieldJavaScript(System::SharedPtr<Aspose::Pdf::Annotations::JavascriptAction>) | Executes a specified JavaScript action for the field. |
| Field(System::SharedPtr<Document>) | Creates field for use in Generator. |
| Flatten() | Places annotation contents directly on the page, annotation object will be removed. |
| get_Actions() const | Gets the annotation actions. |
| get_Actions() | Gets list of annotatation actions. |
| virtual get_ActiveState() | Gets current annotation appearance state. |
| get_Alignment() | Annotation alignment. This property is obsolete. Use HorizontalAligment instead. |
| get_AlternateName() | Gets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat. |
| get_AnnotationIndex() | Gets index of this anotation on the page. |
| get_AnnotationType() override | Gets type of annotation. |
| get_Appearance() | Gets appearance dictionary of the annotation. |
| get_Border() const | Gets annotation border characteristics. Border |
| get_Caption() | Gets the caption of the barcode object. |
| get_Characteristics() | Gets annotation characteristics. |
| get_Color() | Gets annotation color. |
| get_Contents() | Gets annotation text. |
| get_Count() const override | Gets number of subfields in this field. (For example number of items in radio button field). |
| get_DefaultAppearance() | Gets default appearance of the field. |
| get_ECC() | Gets an integer value representing the error correction coefficient. For PDF417, shall be from 0 to 8. For QRCode, shall be from 0 to 3 (0 for ‘L’, 1 for ‘M’, 2 for ‘Q’, and 3 for ‘H’). |
| get_Exportable() | Gets exportable flag of the field. |
| static get_FitIntoRectangle() | If true then font size will reduced to fit text to specified rectangle. |
| get_Flags() | Flags of the annotation. |
| get_ForceCombs() | Gets flag which indicates is field divided into spaced positions. |
| get_FullName() | Gets full qualified name of the annotation. |
| virtual get_Height() | Gets height of the annotation. |
| get_Highlighting() | Annotation highlighting mode. |
| get_HorizontalAlignment() override | Gets text alignment for annotation. |
| virtual get_Hyperlink() | Gets the fragment hyperlink(for pdf generator). |
| get_IsFirstParagraphInColumn() const | Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) |
| get_IsGroup() const | Gets boolean value which indicates is this field non-terminal field i.e. group of fields. |
| get_IsInLineParagraph() const | Gets a paragraph is inline. Default is false.(for pdf generation) |
| get_IsInNewPage() const | Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) |
| get_IsKeptWithNext() const | Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) |
| get_IsSharedField() const | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it’s appearance will be visible on all pages of the document. If false, separated field will be created for every document page. |
| get_IsSynchronized() | Returns true if dictionary is synchronized. |
| get_MappingName() | Gets mapping name of the field that shall be used when exporting interactive form field data from the document. |
| get_Margin() | Gets a outer margin for paragraph (for pdf generation) |
| static get_MaxFontSize() | Maximail font size which can be used for field contents. -1 to don’t check size. |
| get_MaxLen() | Gets maximum length of text in the field. |
| static get_MinFontSize() | Minimal font size which can be used for field contents. -1 to don’t check size. |
| get_Modified() | Gets date and time when annotation was recently modified. |
| get_Multiline() | Gets multiline flag of the field. If Multiline is true field can contain multiple lines of text. |
| get_Name() | Gets annotation name on the page. |
| get_OnActivated() | An action which shall be performed when the annotation is activated. |
| get_PageIndex() override | Gets index of page which contains this field. |
| get_Parent() | Gets annotation parent. |
| get_PartialName() | Gets partial name of the field. |
| get_ReadOnly() | Gets read only status of the field. |
| get_Rect() override | Gets the field rectangle. |
| get_Required() | Gets required status of the field. |
| get_Resolution() | Gets the resolution, in dots-per-inch (dpi), at which the barcode object is rendered. |
| get_Scrollable() | Gets scrollable flag of field. If true field can be scrolled. |
| get_SpellCheck() | Gets spellcheck flag for field. If true field shall be spell checked. |
| get_States() | Gets appearance dictionary of annotation. |
| get_Symbology() | Specifies which barcode or glyph technology is to be used on this annotation, see Symbology for details. |
| get_SyncRoot() const | Synchronization object. |
| get_TabOrder() | Gets tab order of the field. |
| get_TextHorizontalAlignment() | Gets text alignment for annotation. |
| get_TextVerticalAlignment() const | Gets text vertical alignment for annotation. |
| static get_UpdateAppearanceOnConvert() | If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. |
| static get_UseFontSubset() | If this property set to true, fonts will be added to document as subsets. Default value is true. |
| get_Value() override | Gets value of the field. |
| virtual get_VerticalAlignment() | Gets a vertical alignment of paragraph. |
| virtual get_Width() | Gets width of the annotation. |
| get_XSymHeight() | Gets the the vertical distance between two barcode modules, measured in pixels. The ratio XSymHeight/XSymWidth shall be an integer value. For PDF417, the acceptable ratio range is from 1 to 4. For QRCode and DataMatrix, this ratio shall always be 1. |
| get_XSymWidth() | Gets The horizontal distance, in pixels, between two barcode modules. |
| get_ZIndex() const | Gets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. |
| GetCheckedStateName() | Returns name of “checked” state according to existing state names. |
| GetEnumerator() override | Returns enumerator of contained fields. |
| GetRectangle(bool) | Returns rectangle of annotation taking into consideration page rotation. |
| idx_get(System::String) | Gets subfield contained in this field by name of the subfield. |
| idx_get(int32_t) | Gets subfield contained in this field by index. |
| Recalculate() | Recaculates all calculated fields on the form. |
| virtual set_ActiveState(System::String) | Sets current annotation appearance state. |
| set_Alignment(TextAlignment) | Annotation alignment. This property is obsolete. Use HorizontalAligment instead. |
| set_AlternateName(System::String) | Sets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat. |
| set_AnnotationIndex(int32_t) | Sets index of this anotation on the page. |
| set_Border(System::SharedPtr<Aspose::Pdf::Annotations::Border>) | Sets annotation border characteristics. Border |
| set_Color(System::SharedPtr<Aspose::Pdf::Color>) | Sets annotation color. |
| set_Contents(System::String) | Sets annotation text. |
| set_DefaultAppearance(System::SharedPtr<Aspose::Pdf::Annotations::DefaultAppearance>) | Sets default appearance of the field. |
| set_Exportable(bool) | Sets exportable flag of the field. |
| static set_FitIntoRectangle(bool) | If true then font size will reduced to fit text to specified rectangle. |
| set_Flags(AnnotationFlags) | Flags of the annotation. |
| set_ForceCombs(bool) | Sets flag which indicates is field divided into spaced positions. |
| virtual set_Height(double) | Sets height of the annotation. |
| set_Highlighting(HighlightingMode) | Annotation highlighting mode. |
| set_HorizontalAlignment(Aspose::Pdf::HorizontalAlignment) override | Sets text alignment for annotation. |
| virtual set_Hyperlink(System::SharedPtr<Aspose::Pdf::Hyperlink>) | Sets the fragment hyperlink(for pdf generator). |
| set_IsFirstParagraphInColumn(bool) | Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) |
| set_IsInLineParagraph(bool) | Sets a paragraph is inline. Default is false.(for pdf generation) |
| set_IsInNewPage(bool) | Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) |
| set_IsKeptWithNext(bool) | Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) |
| set_IsSharedField(bool) | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it’s appearance will be visible on all pages of the document. If false, separated field will be created for every document page. |
| set_MappingName(System::String) | Sets mapping name of the field that shall be used when exporting interactive form field data from the document. |
| set_Margin(System::SharedPtr<MarginInfo>) | Sets a outer margin for paragraph (for pdf generation) |
| static set_MaxFontSize(double) | Maximail font size which can be used for field contents. -1 to don’t check size. |
| set_MaxLen(int32_t) | Sets maximum length of text in the field. |
| static set_MinFontSize(double) | Minimal font size which can be used for field contents. -1 to don’t check size. |
| set_Modified(System::DateTime) | Sets date and time when annotation was recently modified. |
| set_Multiline(bool) | Sets multiline flag of the field. If Multiline is true field can contain multiple lines of text. |
| set_Name(System::String) | Sets annotation name on the page. |
| set_OnActivated(System::SharedPtr<PdfAction>) | An action which shall be performed when the annotation is activated. |
| set_PartialName(System::String) | Sets partial name of the field. |
| set_ReadOnly(bool) | Sets read only status of the field. |
| set_Rect(System::SharedPtr<Rectangle>) override | Sets the field rectangle. |
| set_Required(bool) | Sets required status of the field. |
| set_Scrollable(bool) | Sets scrollable flag of field. If true field can be scrolled. |
| set_SpellCheck(bool) | Sets spellcheck flag for field. If true field shall be spell checked. |
| set_TabOrder(int32_t) | Sets tab order of the field. |
| set_TextHorizontalAlignment(Aspose::Pdf::HorizontalAlignment) | Sets text alignment for annotation. |
| set_TextVerticalAlignment(Aspose::Pdf::VerticalAlignment) | Sets text vertical alignment for annotation. |
| static set_UpdateAppearanceOnConvert(bool) | If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. |
| static set_UseFontSubset(bool) | If this property set to true, fonts will be added to document as subsets. Default value is true. |
| set_Value(System::String) override | Sets value of the field. |
| virtual set_VerticalAlignment(Aspose::Pdf::VerticalAlignment) | Sets a vertical alignment of paragraph. |
| virtual set_Width(double) | Sets width of the annotation. |
| set_ZIndex(int32_t) | Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. |
| virtual SetPosition(System::SharedPtr<Point>) | Set position of the field. |
| SetTemplateWeakPtr(uint32_t) override | Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. |
| TextBoxField(System::SharedPtr<Document>) | Constructor which should be used with Generator. |
| TextBoxField() | Create instance of TextBoxField. |
| TextBoxField(System::SharedPtr<Aspose::Pdf::Page>, System::SharedPtr<Rectangle>) | Constructor of TextBox field. |
| TextBoxField(System::SharedPtr<Document>, System::SharedPtr<Rectangle>) | Constructor of TextBox field. |
| WidgetAnnotation(System::SharedPtr<Document>) | Create annotation (used for Generator) |
See Also
- Class TextBoxField
- Namespace Aspose::Pdf::Forms
- Library Aspose.PDF for C++