Aspose::Pdf::Forms::ComboBoxField class
Contents
[
Hide
]ComboBoxField class
Class representing Combobox field of the form.
class ComboBoxField : public Aspose::Pdf::Forms::ChoiceField
Methods
| Method | Description |
|---|---|
| Accept(System::SharedPtr<AnnotationSelector>) override | Accepts visitor. |
| virtual AddOption(System::String) | Adds new option with specified name. |
| virtual AddOption(System::String, System::String) | Adds new option with specified export value and name. |
| BaseParagraph() | |
| virtual ChangeAfterResize(System::SharedPtr<Matrix>) | Update parameters and appearance, according to the matrix transform. |
| ChoiceField(System::SharedPtr<Aspose::Pdf::Page>, System::SharedPtr<Rectangle>) | Constructor for ChoiceField. |
| ChoiceField(System::SharedPtr<Document>) | Creates choice field (for Generator) |
| ChoiceField(System::SharedPtr<Document>, System::SharedPtr<Rectangle>) | Constructor for ChoiceField. |
| Clone() override | Clones this instance. Virtual method. Always return null. |
| ComboBoxField() | Constructor for ComboBoxField to be used in Generator. |
| ComboBoxField(System::SharedPtr<Document>) | Creates CombBox field to work with Generator. |
| ComboBoxField(System::SharedPtr<Aspose::Pdf::Page>, System::SharedPtr<Rectangle>) | Constructor for Combobox Field. |
| ComboBoxField(System::SharedPtr<Document>, System::SharedPtr<Rectangle>) | Constructor for Combobox field. |
| 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. |
| virtual DeleteOption(System::String) | Deletes option by its name. |
| 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_Characteristics() | Gets annotation characteristics. |
| get_Color() | Gets annotation color. |
| get_CommitImmediately() | Gets commit on selection change flag. |
| 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_Editable() | Gets editable status of the field. |
| 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_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. |
| 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_MultiSelect() | Gets multiselection flag. |
| get_Name() | Gets annotation name on the page. |
| get_OnActivated() | An action which shall be performed when the annotation is activated. |
| virtual get_Options() | Gets collection of choice options. |
| 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. |
| virtual get_Selected() | Gets index of selected option. This property allows to change selection. |
| virtual get_SelectedItems() | Gets array of selected items. For multiselect list array contains more then one item. For single selection list it contains single item. |
| get_SpellCheck() | Gets spellchaeck activiity status. |
| get_States() | Gets appearance dictionary of annotation. |
| get_SyncRoot() const | Synchronization object. |
| get_TabOrder() | Gets tab order of the field. |
| get_TextHorizontalAlignment() | Gets text 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_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_CommitImmediately(bool) | Sets commit on selection change flag. |
| set_Contents(System::String) | Sets annotation text. |
| set_DefaultAppearance(System::SharedPtr<Aspose::Pdf::Annotations::DefaultAppearance>) | Sets default appearance of the field. |
| set_Editable(bool) | Sets editable status 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. |
| 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. |
| 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_MultiSelect(bool) | Sets multiselection flag. |
| 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. |
| virtual set_Selected(int32_t) | Sets index of selected option. This property allows to change selection. |
| virtual set_SelectedItems(System::ArrayPtr<int32_t>) | Sets array of selected items. For multiselect list array contains more then one item. For single selection list it contains single item. |
| set_SpellCheck(bool) | Sets spellchaeck activiity status. |
| set_TabOrder(int32_t) | Sets tab order of the field. |
| set_TextHorizontalAlignment(Aspose::Pdf::HorizontalAlignment) | Sets text 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. |
| WidgetAnnotation(System::SharedPtr<Document>) | Create annotation (used for Generator) |
See Also
- Class ChoiceField
- Namespace Aspose::Pdf::Forms
- Library Aspose.PDF for C++