Aspose::Pdf::Annotations::SubmitFormAction Class Referencefinal

Class which describes submit-form action. More...

Inherits Aspose::Pdf::Annotations::PdfAction.

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Flags ()
 Gets flagas of submit action More...
 
ASPOSE_PDF_SHARED_API void set_Flags (int32_t value)
 Sets flagas of submit action More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< FileSpecificationget_Url ()
 Destination URL. More...
 
ASPOSE_PDF_SHARED_API void set_Url (System::SharedPtr< FileSpecification > value)
 Destination URL. More...
 
ASPOSE_PDF_SHARED_API SubmitFormAction ()
 Initializes SubmitFormAction object. More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
ASPOSE_PDF_SHARED_API System::SharedPtr< ActionCollectionget_Next ()
 Next actions in sequence. More...
 
ASPOSE_PDF_SHARED_API System::String ToString () const override
 Returns string representation of ExplicitDestination object. More...
 
- 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Attributes

static constexpr ASPOSE_PDF_SHARED_API int32_t Exclude = 1
 If clear, the Fields array specifies which fields to include in the submission. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t IncludeNoValueFields = static_cast<int32_t>(1 << 1)
 If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t ExportFormat = static_cast<int32_t>(1 << 2)
 If set, field names and values shall be submitted in HTML Form format. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t GetMethod = static_cast<int32_t>(1 << 3)
 If set, field names and values shall be submitted using an HTTP GET request. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t SubmitCoordinates = static_cast<int32_t>(1 << 4)
 If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t Xfdf = static_cast<int32_t>(1 << 5)
 If set, field names and values shall be submitted as XFDF. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t IncludeAppendSaves = static_cast<int32_t>(1 << 6)
 If set, the submitted FDF file shall include the contents of all incremental updates. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t IncludeAnnotations = static_cast<int32_t>(1 << 7)
 If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t SubmitPdf = static_cast<int32_t>(1 << 8)
 If set, the document shall be submitted as PDF, using the MIME content type application/pdf. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t CanonicalFormat = static_cast<int32_t>(1 << 9)
 If set, any submitted field values representing dates shall be converted to the standard format. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t ExclNonUserAnnots = static_cast<int32_t>(1 << 10)
 If set, it shall include only those markup annotations whose T entry matches the name of the current user. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t ExclFKey = static_cast<int32_t>(1 << 11)
 If set, the submitted FDF shall exclude the F entry. More...
 
static constexpr ASPOSE_PDF_SHARED_API int32_t EmbedForm = static_cast<int32_t>(1 << 13)
 If set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted. More...
 

Protected Member Functions

 SubmitFormAction (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (SubmitFormAction, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action))
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_EngineDict ()
 
void set_EngineDict (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > value)
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > get_EngineObj () const
 
void set_EngineObj (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > value)
 
virtual ASPOSE_PDF_SHARED_API void Execute (const System::SharedPtr< Document > &document)
 
virtual ASPOSE_PDF_SHARED_API ~PdfAction ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 Implements C# typeof(System.Object) construct. More...
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
static System::SharedPtr< PdfActionCreateAction (const System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > &action)
 

Detailed Description

Class which describes submit-form action.

Constructor & Destructor Documentation

◆ SubmitFormAction() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::SubmitFormAction::SubmitFormAction ( )

Initializes SubmitFormAction object.

◆ SubmitFormAction() [2/2]

Aspose::Pdf::Annotations::SubmitFormAction::SubmitFormAction ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  action)
protected

Member Function Documentation

◆ get_Flags()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::get_Flags ( )

Gets flagas of submit action

◆ get_Url()

ASPOSE_PDF_SHARED_API System::SharedPtr<FileSpecification> Aspose::Pdf::Annotations::SubmitFormAction::get_Url ( )

Destination URL.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Annotations::SubmitFormAction::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( SubmitFormAction  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)   
)
protected

◆ set_Flags()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::SubmitFormAction::set_Flags ( int32_t  value)

Sets flagas of submit action

◆ set_Url()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::SubmitFormAction::set_Url ( System::SharedPtr< FileSpecification value)

Destination URL.

Member Data Documentation

◆ CanonicalFormat

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::CanonicalFormat = static_cast<int32_t>(1 << 9)
static

If set, any submitted field values representing dates shall be converted to the standard format.

◆ EmbedForm

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::EmbedForm = static_cast<int32_t>(1 << 13)
static

If set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

◆ ExclFKey

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::ExclFKey = static_cast<int32_t>(1 << 11)
static

If set, the submitted FDF shall exclude the F entry.

◆ ExclNonUserAnnots

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::ExclNonUserAnnots = static_cast<int32_t>(1 << 10)
static

If set, it shall include only those markup annotations whose T entry matches the name of the current user.

◆ Exclude

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::Exclude = 1
static

If clear, the Fields array specifies which fields to include in the submission.

◆ ExportFormat

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::ExportFormat = static_cast<int32_t>(1 << 2)
static

If set, field names and values shall be submitted in HTML Form format.

◆ GetMethod

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::GetMethod = static_cast<int32_t>(1 << 3)
static

If set, field names and values shall be submitted using an HTTP GET request.

◆ IncludeAnnotations

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::IncludeAnnotations = static_cast<int32_t>(1 << 7)
static

If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document.

◆ IncludeAppendSaves

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::IncludeAppendSaves = static_cast<int32_t>(1 << 6)
static

If set, the submitted FDF file shall include the contents of all incremental updates.

◆ IncludeNoValueFields

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::IncludeNoValueFields = static_cast<int32_t>(1 << 1)
static

If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted.

◆ SubmitCoordinates

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::SubmitCoordinates = static_cast<int32_t>(1 << 4)
static

If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data.

◆ SubmitPdf

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::SubmitPdf = static_cast<int32_t>(1 << 8)
static

If set, the document shall be submitted as PDF, using the MIME content type application/pdf.

◆ Xfdf

constexpr ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SubmitFormAction::Xfdf = static_cast<int32_t>(1 << 5)
static

If set, field names and values shall be submitted as XFDF.