Base class for acro form fields. More...

Inherits Aspose::Pdf::Annotations::WidgetAnnotation, and System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

Inherited by Aspose::Pdf::Forms::ButtonField, Aspose::Pdf::Forms::CheckboxField, Aspose::Pdf::Forms::ChoiceField, Aspose::Pdf::Forms::RadioButtonOptionField, Aspose::Pdf::Forms::SignatureField, and Aspose::Pdf::Forms::TextBoxField.

Public Member Functions

System::String get_PartialName ()
 Gets partial name of the field. More...
 
void set_PartialName (System::String value)
 Sets partial name of the field. More...
 
System::String 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. More...
 
void set_AlternateName (System::String value)
 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. More...
 
System::String get_MappingName ()
 Gets mapping name of the field that shall be used when exporting interactive form field data from the document. More...
 
void set_MappingName (System::String value)
 Sets mapping name of the field that shall be used when exporting interactive form field data from the document. More...
 
virtual System::String get_Value ()
 Gets value of the field. More...
 
virtual void set_Value (System::String value)
 Sets value of the field. More...
 
bool get_IsSynchronized ()
 Returns true if dictionary is synchronized. More...
 
int32_t get_Count () const
 Gets number of subfields in this field. (For example number of items in radio button field). More...
 
System::SharedPtr< System::Objectget_SyncRoot () const
 Synchronization object. More...
 
bool get_IsGroup () const
 Gets boolean value which indicates is this field non-terminal field i.e. group of fields. More...
 
int32_t get_AnnotationIndex ()
 Gets index of this anotation on the page. More...
 
void set_AnnotationIndex (int32_t value)
 Sets index of this anotation on the page. More...
 
virtual int32_t get_PageIndex ()
 Gets index of page which contains this field. More...
 
virtual System::SharedPtr< Rectangleget_Rect ()
 Gets the field rectangle. More...
 
virtual void set_Rect (System::SharedPtr< Rectangle > value)
 Sets the field rectangle. More...
 
bool 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. More...
 
void set_IsSharedField (bool value)
 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. More...
 
int32_t get_TabOrder ()
 Gets tab order of the field. More...
 
void set_TabOrder (int32_t value)
 Sets tab order of the field. More...
 
bool get_IsReadOnly () const
 
bool Recalculate ()
 Recaculates all calculated fields on the form. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Field >> array, int32_t index)
 Copies subfields of this field into array starting from specified index. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > GetEnumerator ()
 Returns enumerator of contained fields. More...
 
 Field (System::SharedPtr< Document > doc)
 Creates field for use in Generator. More...
 
virtual void Flatten ()
 Removes this field and place its value directly on the page. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationidx_get (System::String name)
 Gets subfield contained in this field by name of the subfield. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationidx_get (int32_t index)
 Gets subfield contained in this field by index. More...
 
virtual void SetPosition (System::SharedPtr< Point > point)
 Set position of the field. More...
 
void Add (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &item)
 
void Clear ()
 Deletes all elements from collection. More...
 
bool Contains (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &item) const
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >> array, int32_t arrayIndex)
 
bool Remove (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &item)
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::WidgetAnnotation
System::SharedPtr< PdfActionget_OnActivated ()
 An action which shall be performed when the annotation is activated. More...
 
void set_OnActivated (System::SharedPtr< PdfAction > value)
 An action which shall be performed when the annotation is activated. More...
 
System::SharedPtr< AnnotationActionCollectionget_Actions () const
 Gets the annotation actions. More...
 
HighlightingMode get_Highlighting ()
 Annotation highlighting mode. More...
 
void set_Highlighting (HighlightingMode value)
 Annotation highlighting mode. More...
 
System::SharedPtr< Aspose::Pdf::Forms::Fieldget_Parent ()
 Gets annotation parent. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::DefaultAppearanceget_DefaultAppearance ()
 Gets default appearance of the field. More...
 
void set_DefaultAppearance (System::SharedPtr< Aspose::Pdf::Annotations::DefaultAppearance > value)
 Sets default appearance of the field. More...
 
bool get_ReadOnly ()
 Gets read only status of the field. More...
 
void set_ReadOnly (bool value)
 Sets read only status of the field. More...
 
bool get_Required ()
 Gets required status of the field. More...
 
void set_Required (bool value)
 Sets required status of the field. More...
 
bool get_Exportable ()
 Gets exportable flag of the field. More...
 
void set_Exportable (bool value)
 Sets exportable flag of the field. More...
 
virtual Aspose::Pdf::Annotations::AnnotationType get_AnnotationType ()
 Gets type of annotation. More...
 
virtual void Accept (System::SharedPtr< AnnotationSelector > visitor)
 Accepts visitor. More...
 
 WidgetAnnotation (System::SharedPtr< Document > doc)
 Create annotation (used for Generator) More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::Annotation
AnnotationFlags get_Flags ()
 Flags of the annotation. More...
 
void set_Flags (AnnotationFlags value)
 Flags of the annotation. More...
 
virtual double get_Width ()
 Gets width of the annotation. More...
 
virtual void set_Width (double value)
 Sets width of the annotation. More...
 
System::SharedPtr< PdfActionCollectionget_Actions ()
 Gets list of annotatation actions. More...
 
virtual double get_Height ()
 Gets height of the annotation. More...
 
virtual void set_Height (double value)
 Sets height of the annotation. More...
 
System::String get_Contents ()
 Gets annotation text. More...
 
void set_Contents (System::String value)
 Sets annotation text. More...
 
System::String get_Name ()
 Gets annotation name on the page. More...
 
void set_Name (System::String value)
 Sets annotation name on the page. More...
 
System::DateTime get_Modified ()
 Gets date and time when annotation was recently modified. More...
 
void set_Modified (System::DateTime value)
 Sets date and time when annotation was recently modified. More...
 
System::SharedPtr< Aspose::Pdf::Colorget_Color ()
 Gets annotation color. More...
 
void set_Color (System::SharedPtr< Aspose::Pdf::Color > value)
 Sets annotation color. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::Borderget_Border () const
 Gets annotation border characteristics. Border More...
 
void set_Border (System::SharedPtr< Aspose::Pdf::Annotations::Border > value)
 Sets annotation border characteristics. Border More...
 
virtual System::String get_ActiveState ()
 Gets current annotation appearance state. More...
 
virtual void set_ActiveState (System::String value)
 Sets current annotation appearance state. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::Characteristicsget_Characteristics ()
 Gets annotation characteristics. More...
 
System::SharedPtr< AppearanceDictionaryget_States ()
 Gets appearance dictionary of annotation. More...
 
TextAlignment get_Alignment ()
 Annotation alignment. This property is obsolete. Use HorizontalAligment instead. More...
 
void set_Alignment (TextAlignment value)
 Annotation alignment. This property is obsolete. Use HorizontalAligment instead. More...
 
Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment ()
 Gets text alignment for annotation. More...
 
void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets text alignment for annotation. More...
 
Aspose::Pdf::HorizontalAlignment get_TextHorizontalAlignment ()
 Gets text alignment for annotation. More...
 
void set_TextHorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets text alignment for annotation. More...
 
System::String get_FullName ()
 Gets full qualified name of the annotation. More...
 
System::SharedPtr< AppearanceDictionaryget_Appearance ()
 Gets appearance dictionary of the annotation. More...
 
System::SharedPtr< RectangleGetRectangle (bool considerRotation)
 Returns rectangle of annotation taking into consideration page rotation. More...
 
- Public Member Functions inherited from Aspose::Pdf::BaseParagraph
virtual Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of paragraph More...
 
virtual void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of paragraph More...
 
System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
bool get_IsFirstParagraphInColumn () const
 Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
void set_IsFirstParagraphInColumn (bool value)
 Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
bool 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) More...
 
void set_IsKeptWithNext (bool value)
 Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
bool get_IsInNewPage () const
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
bool get_IsInLineParagraph () const
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
virtual void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink(for pdf generator). More...
 
int32_t 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. More...
 
void set_ZIndex (int32_t value)
 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. More...
 
virtual System::SharedPtr< System::ObjectClone ()
 Clones this instance. Virtual method. Always return null. More...
 
 BaseParagraph ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > array, int arrayIndex)=0
 
ICollectionoperator= (ICollection &&)
 
ICollectionoperator= (const ICollection &)
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_ElementAt (int index)
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_First ()
 
System::SharedPtr< Collections::Generic::List< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_ToList ()
 
int LINQ_Count ()
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > LINQ_ToArray ()
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 

Static Public Member Functions

static bool get_FitIntoRectangle ()
 If true then font size will reduced to fit text to specified rectangle. More...
 
static void set_FitIntoRectangle (bool value)
 If true then font size will reduced to fit text to specified rectangle. More...
 
static double get_MaxFontSize ()
 Maximail font size which can be used for field contents. -1 to don't check size. More...
 
static void set_MaxFontSize (double value)
 Maximail font size which can be used for field contents. -1 to don't check size. More...
 
- Static Public Member Functions inherited from Aspose::Pdf::Annotations::Annotation
static bool 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. More...
 
static void set_UpdateAppearanceOnConvert (bool value)
 If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. More...
 
static bool get_UseFontSubset ()
 If this property set to true, fonts will be added to document as subsets. Default value is true. More...
 
static void set_UseFontSubset (bool value)
 If this property set to true, fonts will be added to document as subsets. Default value is true. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Protected Member Functions

System::SharedPtr< System::Xml::XmlNamespaceManagerget_NamespaceManager ()
 
virtual bool IsEqualTo (System::String value)
 Operator for comparision field value with given value. More...
 
virtual System::String GetConformXFAValue (System::String value)
 Returns value correctly encoded for placing into XFA dataset. More...
 
bool isCalculated ()
 
 Field (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation, System::SharedPtr< Document > document)
 
virtual void Initialize (System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > trailer, System::SharedPtr< Rectangle > rect)
 Initialize the annotation. More...
 
virtual void Initialize (System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > trailer)
 Initialize the field. More...
 
 Field ()
 
 Field (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 
 Field (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 
System::SharedPtr< FieldfindField (System::String name)
 
void addField (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > field)
 
System::SharedPtr< Fieldremove (System::String name)
 
void setValue (System::String value)
 Set value of the field. More...
 
virtual void UpdateAppearances ()
 
System::String GetFieldReferencePath ()
 
System::SharedPtr< System::Xml::XmlNodeGetFieldTemplate ()
 
void SetFieldImage (System::SharedPtr< System::IO::Stream > image)
 
System::ArrayPtr< uint8_t > GetFieldImage ()
 
void AddNext (System::SharedPtr< Field > field)
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > CreateKidAnnotation (System::SharedPtr< Rectangle > rect)
 
virtual System::SharedPtr< FieldCreateCopy ()
 This method is required for Generator support. This method creates copy of field "template" when generator uses Footer/Header functionality. More...
 
virtual bool AppearanceSupported ()
 This method must be overriden to return true in classes where apperance generation is supported. More...
 
System::String GetCharacteristicsString (System::String entry)
 
void SetCharacteristicsString (System::String entry, System::String value)
 
virtual ~Field ()
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::WidgetAnnotation
 WidgetAnnotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > engineAnnot, System::SharedPtr< Document > document)
 Ititializes Widget annotation with engine annotation object. More...
 
 WidgetAnnotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Creates new Widget annotation on the specified page. More...
 
 WidgetAnnotation (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 
 WidgetAnnotation ()
 
void setFieldFlag (int32_t bit, bool set)
 
virtual System::SharedPtr< XFormPrepareAppearance (System::String key, System::SharedPtr< Annotation > annotation)
 Creates normal appearance for annotation and fills matrix and rectangle for appearance. More...
 
virtual void ClearAppearance (System::SharedPtr< OperatorCollection > appearance)
 Remove operators of old appearance. This may be overriden to remove only required part of appearance (e.g. TextBoxField) More...
 
virtual void UpdateAppearance (System::SharedPtr< Annotation > annotation)
 Updated appearance dictionary of the field. More...
 
virtual System::Drawing::Color GetBackgroundColor ()
 
virtual ~WidgetAnnotation ()
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::Annotation
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > get_EngineObj () const
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_EngineDict ()
 
int32_t get_StructParent ()
 
void set_StructParent (int32_t value)
 
System::SharedPtr< XFormget_NormalAppearance ()
 Gets normal appearance. More...
 
bool get_FlatteningState () const
 
void set_FlatteningState (bool value)
 
System::SharedPtr< Aspose::Pdf::Pageget_Page ()
 Gets the page object with which this annotation is associated. More...
 
void set_Page (System::SharedPtr< Aspose::Pdf::Page > value)
 Gets the page object with which this annotation is associated. More...
 
System::SharedPtr< Rectangleget_RotatedRect ()
 Gets rotated rectangle. More...
 
virtual System::SharedPtr< Rectangleget_InnerRect ()
 Returns internal rectnagle of annotation, i.e. rectangle recalculated according to RD entry of annotation More...
 
double get_TemplateWidth () const
 Property for generator support. This property gets field width originally set by user (width of the "template"). More...
 
double get_TemplateHeight () const
 Property for generator support. This property gets field height originally set by user (height of the "template"). More...
 
virtual void DeleteAllChildElements ()
 
void Initialize (System::SharedPtr< Document > doc)
 
void assertAppearance ()
 
virtual void AfterImport ()
 Method which must be called after annotation import. More...
 
virtual System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > CreateFrame (System::SharedPtr< Annotation::AppearanceParameters > parametes, System::SharedPtr< Annotation > annotation)
 Create frame. More...
 
virtual System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > CreateAppearanceProgram (System::SharedPtr< Annotation::AppearanceParameters > parameters, System::SharedPtr< Annotation > annotation)
 Create program for displaying this annotation. More...
 
virtual void WriteXfdf (System::SharedPtr< System::Xml::XmlWriter > writer)
 
virtual void WriteXfdfAttributes (System::SharedPtr< System::Xml::XmlWriter > writer)
 When overridden in a derived class, exports annotation attributes into XFDF. More...
 
virtual void WriteXfdfElements (System::SharedPtr< System::Xml::XmlWriter > writer)
 When overridden in a derived class, exports annotation elements into XFDF. More...
 
virtual void ReadXfdf (System::SharedPtr< System::Xml::XmlReader > reader)
 
virtual void ReadXfdfAttributes (System::SharedPtr< System::Xml::XmlReader > reader)
 When overridden in a derived class, import annotation attributes from XFDF. More...
 
virtual void ReadXfdfElements (System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> table)
 When overridden in a derived class, import annotation elements from XFDF. More...
 
 Annotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation, System::SharedPtr< Document > document)
 
 Annotation (System::SharedPtr< Document > document)
 Constructor to use in Generator. More...
 
 Annotation ()
 
void Initialize (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Initialize the annotation. More...
 
virtual void AttachToPage (System::SharedPtr< Aspose::Pdf::Page > page)
 
void Initialize (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 Create annotation data structure. More...
 
 Annotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Constructor. More...
 
 Annotation (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 Constructor for Annotation. More...
 
virtual void GeneratorUpdateRectangle (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 This method should be called if annotation requires some additional actions when generator updates its rectangle. More...
 
System::String GetCheckedStateName ()
 Returns name of "checked" state according to existing state names. More...
 
void Initialize (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotEngineObj)
 Initializes this object with internal engine annotation object. More...
 
virtual void InternalFlatten (System::SharedPtr< Resources > resources, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators)
 
virtual System::String InternalFlatten2 (System::SharedPtr< Resources > resources)
 
virtual System::String InternalFlatten3 (System::SharedPtr< Resources > resources)
 
virtual bool IsBackground ()
 true if the annotation must be background. More...
 
int32_t GetPageIndex (System::SharedPtr< Annotation > annotation)
 
System::SharedPtr< System::IO::StreamToImage (System::SharedPtr< System::Drawing::Imaging::ImageFormat > format)
 
virtual ~Annotation ()
 
- Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
System::String get_Id () const
 Gets a paragraph id. More...
 
void set_Id (System::String value)
 Sets a paragraph id. More...
 
System::SharedPtr< Annotations::LinkAnnotationget_ReferencedFrom () const
 Gets the fragment hyperlink(for pdf generator internal use). More...
 
void set_ReferencedFrom (System::SharedPtr< Annotations::LinkAnnotation > value)
 Sets the fragment hyperlink(for pdf generator internal use). More...
 
void ChangePosition (double &curX, double &curY, double newX, double newY, bool isNextParagraphInline)
 
void ProcessHyperlink (System::SharedPtr< Page > page, System::SharedPtr< Rectangle > rect)
 
virtual void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
virtual void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
 ~IEnumerable () override
 Destructor. More...
 

Static Protected Member Functions

static System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationCreateField (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > field, System::SharedPtr< Document > document)
 
static void SetCharacteristicsString (System::SharedPtr< Aspose::Pdf::Annotations::Annotation > annot, System::String entry, System::String value)
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::WidgetAnnotation
static int32_t getFieldFlag (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > field)
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::Annotation
static System::SharedPtr< AnnotationCreateAnnotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotEngineObj, System::SharedPtr< Aspose::Pdf::Page > page)
 Initializes annotation from PDF object which describes the annotation. More...
 
static bool IsEmptyAppearance (System::SharedPtr< System::IO::Stream > s)
 
static System::String InternalFlatten4 (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > annotation, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > resources)
 
- Static Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
static bool get_IsZIndexSet ()
 Gets the fragment hyperlink(for pdf generator performance internal use). More...
 
static void set_IsZIndexSet (bool value)
 Sets the fragment hyperlink(for pdf generator performance internal use). More...
 

Protected Attributes

System::String _value
 
- Protected Attributes inherited from Aspose::Pdf::Annotations::Annotation
System::SharedPtr< System::Globalization::CultureInfoCulture
 
System::WeakPtr< Document_document
 
bool _disableUpdateAppearance
 
bool _flatteningState
 
bool needBaseInitialization
 

Static Protected Attributes

static const int32_t _NoToggleToOff
 
static const int32_t _Radio
 
static const int32_t _Pushbutton
 
static const int32_t _RadiosInUnison
 
static const int32_t _Multiline
 
static const int32_t _Password
 
static const int32_t _FileSelect
 
static const int32_t _DoNotSpellCheck
 
static const int32_t _DoNotScroll
 
static const int32_t _Comb
 
static const int32_t _RichText
 
static const int32_t _Combo
 
static const int32_t _Edit
 
static const int32_t _Sort
 
static const int32_t _MultiSelect
 
static const int32_t _CommitOnSelChange
 
- Static Protected Attributes inherited from Aspose::Pdf::Annotations::WidgetAnnotation
static const int32_t _ReadOnly
 
static const int32_t _Required
 
static const int32_t _NoExport
 
- Static Protected Attributes inherited from Aspose::Pdf::Annotations::Annotation
static System::String message1
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
typedef System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > IEnumeratorType
 Enumerator type. More...
 

Detailed Description

Base class for acro form fields.

Constructor & Destructor Documentation

◆ Field() [1/5]

Aspose::Pdf::Forms::Field::Field ( System::SharedPtr< Document doc)

Creates field for use in Generator.

Parameters
docDocument where field will be created.

◆ Field() [2/5]

Aspose::Pdf::Forms::Field::Field ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  annotation,
System::SharedPtr< Document document 
)
protected

◆ Field() [3/5]

Aspose::Pdf::Forms::Field::Field ( )
protected

◆ Field() [4/5]

Aspose::Pdf::Forms::Field::Field ( System::SharedPtr< Document doc,
System::SharedPtr< Rectangle rect 
)
protected

◆ Field() [5/5]

Aspose::Pdf::Forms::Field::Field ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect 
)
protected

◆ ~Field()

virtual Aspose::Pdf::Forms::Field::~Field ( )
protectedvirtual

Member Function Documentation

◆ Add()

void Aspose::Pdf::Forms::Field::Add ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &  item)
virtual

◆ addField()

void Aspose::Pdf::Forms::Field::addField ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation field)
protected

◆ AddNext()

void Aspose::Pdf::Forms::Field::AddNext ( System::SharedPtr< Field field)
protected

◆ AppearanceSupported()

virtual bool Aspose::Pdf::Forms::Field::AppearanceSupported ( )
protectedvirtual

◆ Clear()

void Aspose::Pdf::Forms::Field::Clear ( )
virtual

◆ Contains()

bool Aspose::Pdf::Forms::Field::Contains ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &  item) const
virtual

Checks if element is present in collection.

Parameters
itemItem to look for.
Returns
True if element is present, false otherwise.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ CopyTo() [1/2]

void Aspose::Pdf::Forms::Field::CopyTo ( System::ArrayPtr< System::SharedPtr< Field >>  array,
int32_t  index 
)

Copies subfields of this field into array starting from specified index.

Parameters
arrayArray where field must be copied.
indexStarting index where fields will be copied.

◆ CopyTo() [2/2]

void Aspose::Pdf::Forms::Field::CopyTo ( System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >>  array,
int32_t  arrayIndex 
)

◆ CreateCopy()

virtual System::SharedPtr<Field> Aspose::Pdf::Forms::Field::CreateCopy ( )
protectedvirtual

◆ CreateField()

static System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> Aspose::Pdf::Forms::Field::CreateField ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  field,
System::SharedPtr< Document document 
)
staticprotected

◆ CreateKidAnnotation()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::Forms::Field::CreateKidAnnotation ( System::SharedPtr< Rectangle rect)
protected

◆ findField()

System::SharedPtr<Field> Aspose::Pdf::Forms::Field::findField ( System::String  name)
protected

◆ Flatten()

virtual void Aspose::Pdf::Forms::Field::Flatten ( )
virtual

Removes this field and place its value directly on the page.

Reimplemented from Aspose::Pdf::Annotations::Annotation.

◆ get_AlternateName()

System::String Aspose::Pdf::Forms::Field::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()

int32_t Aspose::Pdf::Forms::Field::get_AnnotationIndex ( )

Gets index of this anotation on the page.

◆ get_Count()

int32_t Aspose::Pdf::Forms::Field::get_Count ( ) const
virtual

Gets number of subfields in this field. (For example number of items in radio button field).

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ get_FitIntoRectangle()

static bool Aspose::Pdf::Forms::Field::get_FitIntoRectangle ( )
static

If true then font size will reduced to fit text to specified rectangle.

◆ get_IsGroup()

bool Aspose::Pdf::Forms::Field::get_IsGroup ( ) const

Gets boolean value which indicates is this field non-terminal field i.e. group of fields.

◆ get_IsReadOnly()

bool Aspose::Pdf::Forms::Field::get_IsReadOnly ( ) const
virtual

Checks if collection is read only.

Returns
true if collection is read only, false otherwise.

Reimplemented from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ get_IsSharedField()

bool Aspose::Pdf::Forms::Field::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()

bool Aspose::Pdf::Forms::Field::get_IsSynchronized ( )

Returns true if dictionary is synchronized.

◆ get_MappingName()

System::String Aspose::Pdf::Forms::Field::get_MappingName ( )

Gets mapping name of the field that shall be used when exporting interactive form field data from the document.

◆ get_MaxFontSize()

static double Aspose::Pdf::Forms::Field::get_MaxFontSize ( )
static

Maximail font size which can be used for field contents. -1 to don't check size.

◆ get_NamespaceManager()

System::SharedPtr<System::Xml::XmlNamespaceManager> Aspose::Pdf::Forms::Field::get_NamespaceManager ( )
protected

◆ get_PageIndex()

virtual int32_t Aspose::Pdf::Forms::Field::get_PageIndex ( )
virtual

Gets index of page which contains this field.

Reimplemented from Aspose::Pdf::Annotations::Annotation.

Reimplemented in Aspose::Pdf::Forms::RadioButtonField.

◆ get_PartialName()

System::String Aspose::Pdf::Forms::Field::get_PartialName ( )

Gets partial name of the field.

◆ get_Rect()

virtual System::SharedPtr<Rectangle> Aspose::Pdf::Forms::Field::get_Rect ( )
virtual

Gets the field rectangle.

Reimplemented from Aspose::Pdf::Annotations::Annotation.

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Pdf::Forms::Field::get_SyncRoot ( ) const

Synchronization object.

◆ get_TabOrder()

int32_t Aspose::Pdf::Forms::Field::get_TabOrder ( )

Gets tab order of the field.

◆ get_Value()

◆ GetCharacteristicsString()

System::String Aspose::Pdf::Forms::Field::GetCharacteristicsString ( System::String  entry)
protected

◆ GetConformXFAValue()

virtual System::String Aspose::Pdf::Forms::Field::GetConformXFAValue ( System::String  value)
protectedvirtual

Returns value correctly encoded for placing into XFA dataset.

Parameters
valueValue for placing into XFA form.
Returns
Encoded value.

Reimplemented in Aspose::Pdf::Forms::RadioButtonField.

◆ GetEnumerator()

◆ GetFieldImage()

System::ArrayPtr<uint8_t> Aspose::Pdf::Forms::Field::GetFieldImage ( )
protected

◆ GetFieldReferencePath()

System::String Aspose::Pdf::Forms::Field::GetFieldReferencePath ( )
protected

◆ GetFieldTemplate()

System::SharedPtr<System::Xml::XmlNode> Aspose::Pdf::Forms::Field::GetFieldTemplate ( )
protected

◆ idx_get() [1/2]

System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> Aspose::Pdf::Forms::Field::idx_get ( System::String  name)

Gets subfield contained in this field by name of the subfield.

Parameters
nameContained subfield name.
Returns
Field instance.

◆ idx_get() [2/2]

System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> Aspose::Pdf::Forms::Field::idx_get ( int32_t  index)

Gets subfield contained in this field by index.

Parameters
indexIndex of the reuqested subfield.
Returns
Field instance.

◆ Initialize() [1/2]

virtual void Aspose::Pdf::Forms::Field::Initialize ( System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >  trailer,
System::SharedPtr< Rectangle rect 
)
protectedvirtual

Initialize the annotation.

Parameters
pageAspose.Pdf.Page object.
rectThe rectangle of the annotation.

Reimplemented from Aspose::Pdf::Annotations::WidgetAnnotation.

Reimplemented in Aspose::Pdf::Forms::TextBoxField.

◆ Initialize() [2/2]

virtual void Aspose::Pdf::Forms::Field::Initialize ( System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >  trailer)
protectedvirtual

◆ isCalculated()

bool Aspose::Pdf::Forms::Field::isCalculated ( )
protected

◆ IsEqualTo()

virtual bool Aspose::Pdf::Forms::Field::IsEqualTo ( System::String  value)
protectedvirtual

Operator for comparision field value with given value.

Parameters
valueValue to check the field value on.
Returns
True if field value and passed value are equals.

Reimplemented in Aspose::Pdf::Forms::RadioButtonField.

◆ Recalculate()

bool Aspose::Pdf::Forms::Field::Recalculate ( )

Recaculates all calculated fields on the form.

Returns
true if field value was changed during recalculation.

◆ Remove()

bool Aspose::Pdf::Forms::Field::Remove ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &  item)
virtual

Deletes element from collection.

Parameters
itemItem to remove.
Returns
True if element was found and removed, false otherwise.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ remove()

System::SharedPtr<Field> Aspose::Pdf::Forms::Field::remove ( System::String  name)
protected

◆ set_AlternateName()

void Aspose::Pdf::Forms::Field::set_AlternateName ( System::String  value)

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()

void Aspose::Pdf::Forms::Field::set_AnnotationIndex ( int32_t  value)

Sets index of this anotation on the page.

◆ set_FitIntoRectangle()

static void Aspose::Pdf::Forms::Field::set_FitIntoRectangle ( bool  value)
static

If true then font size will reduced to fit text to specified rectangle.

◆ set_IsSharedField()

void Aspose::Pdf::Forms::Field::set_IsSharedField ( bool  value)

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()

void Aspose::Pdf::Forms::Field::set_MappingName ( System::String  value)

Sets mapping name of the field that shall be used when exporting interactive form field data from the document.

◆ set_MaxFontSize()

static void Aspose::Pdf::Forms::Field::set_MaxFontSize ( double  value)
static

Maximail font size which can be used for field contents. -1 to don't check size.

◆ set_PartialName()

void Aspose::Pdf::Forms::Field::set_PartialName ( System::String  value)

Sets partial name of the field.

◆ set_Rect()

virtual void Aspose::Pdf::Forms::Field::set_Rect ( System::SharedPtr< Rectangle value)
virtual

Sets the field rectangle.

Reimplemented from Aspose::Pdf::Annotations::Annotation.

◆ set_TabOrder()

void Aspose::Pdf::Forms::Field::set_TabOrder ( int32_t  value)

Sets tab order of the field.

◆ set_Value()

virtual void Aspose::Pdf::Forms::Field::set_Value ( System::String  value)
virtual

◆ SetCharacteristicsString() [1/2]

static void Aspose::Pdf::Forms::Field::SetCharacteristicsString ( System::SharedPtr< Aspose::Pdf::Annotations::Annotation annot,
System::String  entry,
System::String  value 
)
staticprotected

◆ SetCharacteristicsString() [2/2]

void Aspose::Pdf::Forms::Field::SetCharacteristicsString ( System::String  entry,
System::String  value 
)
protected

◆ SetFieldImage()

void Aspose::Pdf::Forms::Field::SetFieldImage ( System::SharedPtr< System::IO::Stream image)
protected

◆ SetPosition()

virtual void Aspose::Pdf::Forms::Field::SetPosition ( System::SharedPtr< Point point)
virtual

Set position of the field.

Parameters
pointPoint where field should be positioned.

Reimplemented in Aspose::Pdf::Forms::RadioButtonField.

◆ setValue()

void Aspose::Pdf::Forms::Field::setValue ( System::String  value)
protected

Set value of the field.

Parameters
valueNEw value of the field.

◆ UpdateAppearances()

virtual void Aspose::Pdf::Forms::Field::UpdateAppearances ( )
protectedvirtual

Member Data Documentation

◆ _Comb

const int32_t Aspose::Pdf::Forms::Field::_Comb
staticprotected

◆ _Combo

const int32_t Aspose::Pdf::Forms::Field::_Combo
staticprotected

◆ _CommitOnSelChange

const int32_t Aspose::Pdf::Forms::Field::_CommitOnSelChange
staticprotected

◆ _DoNotScroll

const int32_t Aspose::Pdf::Forms::Field::_DoNotScroll
staticprotected

◆ _DoNotSpellCheck

const int32_t Aspose::Pdf::Forms::Field::_DoNotSpellCheck
staticprotected

◆ _Edit

const int32_t Aspose::Pdf::Forms::Field::_Edit
staticprotected

◆ _FileSelect

const int32_t Aspose::Pdf::Forms::Field::_FileSelect
staticprotected

◆ _Multiline

const int32_t Aspose::Pdf::Forms::Field::_Multiline
staticprotected

◆ _MultiSelect

const int32_t Aspose::Pdf::Forms::Field::_MultiSelect
staticprotected

◆ _NoToggleToOff

const int32_t Aspose::Pdf::Forms::Field::_NoToggleToOff
staticprotected

◆ _Password

const int32_t Aspose::Pdf::Forms::Field::_Password
staticprotected

◆ _Pushbutton

const int32_t Aspose::Pdf::Forms::Field::_Pushbutton
staticprotected

◆ _Radio

const int32_t Aspose::Pdf::Forms::Field::_Radio
staticprotected

◆ _RadiosInUnison

const int32_t Aspose::Pdf::Forms::Field::_RadiosInUnison
staticprotected

◆ _RichText

const int32_t Aspose::Pdf::Forms::Field::_RichText
staticprotected

◆ _Sort

const int32_t Aspose::Pdf::Forms::Field::_Sort
staticprotected

◆ _value

System::String Aspose::Pdf::Forms::Field::_value
protected