An abstract class which represents signature object in the pdf document. Signatures are fields with values of signature objects, the last contain data which is used to verify the document validity. More...
#include "Signature.h"
Inherits System::Object.
Inherited by Aspose::Pdf::Forms::ExternalSignature, Aspose::Pdf::Forms::PKCS1, Aspose::Pdf::Forms::PKCS7, and Aspose::Pdf::Forms::PKCS7Detached.
Public Member Functions | |
ASPOSE_PDF_SHARED_API System::SharedPtr< SignatureCustomAppearance > | get_CustomAppearance () const |
Gets/sets the custom appearance. More... | |
ASPOSE_PDF_SHARED_API void | set_CustomAppearance (System::SharedPtr< SignatureCustomAppearance > value) |
Gets/sets the custom appearance. More... | |
ASPOSE_PDF_SHARED_API System::String | get_Authority () const |
The name of the person or authority signing the document. More... | |
ASPOSE_PDF_SHARED_API void | set_Authority (System::String value) |
The name of the person or authority signing the document. More... | |
ASPOSE_PDF_SHARED_API System::DateTime | get_Date () const |
The time of signing. More... | |
ASPOSE_PDF_SHARED_API void | set_Date (System::DateTime value) |
The time of signing. More... | |
ASPOSE_PDF_SHARED_API System::String | get_Location () const |
The CPU host name or physical location of the signing. More... | |
ASPOSE_PDF_SHARED_API void | set_Location (System::String value) |
The CPU host name or physical location of the signing. More... | |
ASPOSE_PDF_SHARED_API System::String | get_Reason () const |
The reason for the signing, such as (I agree…). More... | |
ASPOSE_PDF_SHARED_API void | set_Reason (System::String value) |
The reason for the signing, such as (I agree…). More... | |
ASPOSE_PDF_SHARED_API System::String | get_ContactInfo () const |
Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number. More... | |
ASPOSE_PDF_SHARED_API void | set_ContactInfo (System::String value) |
Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number. More... | |
ASPOSE_PDF_SHARED_API System::ArrayPtr< int32_t > | get_ByteRange () const |
An array of pairs of integers (starting byte offset, length in bytes) that shall describe the exact byte range for the digest calculation. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::TimestampSettings > | get_TimestampSettings () const |
Gets/sets timestamp settings. More... | |
ASPOSE_PDF_SHARED_API void | set_TimestampSettings (System::SharedPtr< Aspose::Pdf::TimestampSettings > value) |
Gets/sets timestamp settings. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::OcspSettings > | get_OcspSettings () const |
Gets/sets ocsp settings. More... | |
ASPOSE_PDF_SHARED_API void | set_OcspSettings (System::SharedPtr< Aspose::Pdf::OcspSettings > value) |
Gets/sets ocsp settings. More... | |
ASPOSE_PDF_SHARED_API bool | get_UseLtv () const |
Gets/sets ltv validation flag. More... | |
ASPOSE_PDF_SHARED_API void | set_UseLtv (bool value) |
Gets/sets ltv validation flag. More... | |
ASPOSE_PDF_SHARED_API SignHash | get_CustomSignHash () const |
The delegate for custom sign the document hash (Beta). More... | |
ASPOSE_PDF_SHARED_API void | set_CustomSignHash (SignHash value) |
The delegate for custom sign the document hash (Beta). More... | |
ASPOSE_PDF_SHARED_API bool | get_ShowProperties () const |
Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance (strings to represent):Digitally signed by {certificate subject} Date: {signature.Date} Reason: {signature.Reason}Location: {signature.Location}where {X} is placeholder for X value. Also signature can have image, in this case listed strings are placed over image. ShowProperties is true by default. More... | |
ASPOSE_PDF_SHARED_API void | set_ShowProperties (bool value) |
Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance (strings to represent):Digitally signed by {certificate subject} Date: {signature.Date} Reason: {signature.Reason}Location: {signature.Location}where {X} is placeholder for X value. Also signature can have image, in this case listed strings are placed over image. ShowProperties is true by default. More... | |
ASPOSE_PDF_SHARED_API bool | Verify () |
Verify the document regarding this signature and return true if document is valid or otherwise false. More... | |
ASPOSE_PDF_SHARED_API | Signature () |
Inititalizes new instance of the Signature class. More... | |
ASPOSE_PDF_SHARED_API | Signature (System::String pfx, System::String password) |
Inititalizes new instance of the Signature class. More... | |
ASPOSE_PDF_SHARED_API | Signature (System::SharedPtr< System::IO::Stream > pfx, System::String password) |
Inititalizes new instance of the Signature class. 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... | |
Object & | operator= (Object const &x) |
Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
Object * | SharedRefAdded () |
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 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 TypeInfo & | GetType () 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... | |
Protected Member Functions | |
System::SharedPtr< System::IO::Stream > | get_Image () const |
Gets image stream. More... | |
void | set_Image (System::SharedPtr< System::IO::Stream > value) |
Gets image stream. More... | |
System::SharedPtr< System::IO::Stream > | get_Pfx () const |
Gets the pfx container value. More... | |
System::SharedPtr< Aspose::Pdf::Engine::Security::ISignature > | get_Value () const |
Gets the signature value. More... | |
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > | get_Reference () const |
void | set_Reference (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > value) |
System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Pdf::Engine::Security::Impl::Signatures::SignatureReference > > > | get_SignatureReferences () const |
void | set_SignatureReferences (System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Pdf::Engine::Security::Impl::Signatures::SignatureReference >>> value) |
System::SharedPtr< Aspose::Pdf::Engine::Security::Impl::Signatures::FieldLockDictionary > | get_FieldsLock () const |
void | set_FieldsLock (System::SharedPtr< Aspose::Pdf::Engine::Security::Impl::Signatures::FieldLockDictionary > value) |
void | Sign (System::String sigName, System::SharedPtr< System::IO::Stream > pfx, System::String pass) |
Sign the document using data in this sugnature object. More... | |
void | Clear () |
Removes signature value, but keeps the field from document. More... | |
Signature (System::SharedPtr< System::IO::Stream > image) | |
Initializes signature object with image. More... | |
Signature (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > signature, System::SharedPtr< Aspose::Pdf::Engine::IPdfDocument > document) | |
Initialize signature object from signature dictionary. Then this object will be used for verifying the document. More... | |
virtual ASPOSE_PDF_SHARED_API | ~Signature () |
Protected Attributes | |
System::SharedPtr< System::IO::Stream > | _pfx |
System::String | _password |
System::SharedPtr< System::IO::Stream > | _image |
System::SharedPtr< Aspose::Pdf::Engine::IPdfDocument > | _document |
System::SharedPtr< Aspose::Pdf::Engine::Security::ISignature > | _signature |
System::String | _name |
System::ArrayPtr< int32_t > | _byteRange |
Additional Inherited Members | |
Public Types inherited from System::Object | |
typedef SmartPtr< Object > | ptr |
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 TypeInfo & | Type () |
Implements C# typeof(System.Object) construct. More... | |
An abstract class which represents signature object in the pdf document. Signatures are fields with values of signature objects, the last contain data which is used to verify the document validity.
ASPOSE_PDF_SHARED_API Aspose::Pdf::Forms::Signature::Signature | ( | ) |
Inititalizes new instance of the Signature class.
ASPOSE_PDF_SHARED_API Aspose::Pdf::Forms::Signature::Signature | ( | System::String | pfx, |
System::String | password | ||
) |
Inititalizes new instance of the Signature class.
pfx | Pfx file which contains certificate for signing. |
password | Password to get access to the private key in the certificate. |
ASPOSE_PDF_SHARED_API Aspose::Pdf::Forms::Signature::Signature | ( | System::SharedPtr< System::IO::Stream > | pfx, |
System::String | password | ||
) |
Inititalizes new instance of the Signature class.
pfx | Stream with certificate data organized as pfx. |
password | Password to get access to the private key in the certificate. |
|
protected |
Initializes signature object with image.
image | Image data. |
|
protected |
Initialize signature object from signature dictionary. Then this object will be used for verifying the document.
signature | Signature dictionary. |
document | The document, it is used then to get file data in order to verify signature. |
|
protectedvirtual |
|
protected |
Removes signature value, but keeps the field from document.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Forms::Signature::get_Authority | ( | ) | const |
The name of the person or authority signing the document.
ASPOSE_PDF_SHARED_API System::ArrayPtr<int32_t> Aspose::Pdf::Forms::Signature::get_ByteRange | ( | ) | const |
An array of pairs of integers (starting byte offset, length in bytes) that shall describe the exact byte range for the digest calculation.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Forms::Signature::get_ContactInfo | ( | ) | const |
Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number.
ASPOSE_PDF_SHARED_API System::SharedPtr<SignatureCustomAppearance> Aspose::Pdf::Forms::Signature::get_CustomAppearance | ( | ) | const |
Gets/sets the custom appearance.
ASPOSE_PDF_SHARED_API SignHash Aspose::Pdf::Forms::Signature::get_CustomSignHash | ( | ) | const |
The delegate for custom sign the document hash (Beta).
ASPOSE_PDF_SHARED_API System::DateTime Aspose::Pdf::Forms::Signature::get_Date | ( | ) | const |
The time of signing.
|
protected |
|
protected |
Gets image stream.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Forms::Signature::get_Location | ( | ) | const |
The CPU host name or physical location of the signing.
ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::OcspSettings> Aspose::Pdf::Forms::Signature::get_OcspSettings | ( | ) | const |
Gets/sets ocsp settings.
|
protected |
Gets the pfx container value.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Forms::Signature::get_Reason | ( | ) | const |
The reason for the signing, such as (I agree…).
|
protected |
ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Forms::Signature::get_ShowProperties | ( | ) | const |
Force to show/hide signature properties.
|
protected |
ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::TimestampSettings> Aspose::Pdf::Forms::Signature::get_TimestampSettings | ( | ) | const |
Gets/sets timestamp settings.
ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Forms::Signature::get_UseLtv | ( | ) | const |
Gets/sets ltv validation flag.
|
protected |
Gets the signature value.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_Authority | ( | System::String | value | ) |
The name of the person or authority signing the document.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_ContactInfo | ( | System::String | value | ) |
Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_CustomAppearance | ( | System::SharedPtr< SignatureCustomAppearance > | value | ) |
Gets/sets the custom appearance.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_CustomSignHash | ( | SignHash | value | ) |
The delegate for custom sign the document hash (Beta).
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_Date | ( | System::DateTime | value | ) |
The time of signing.
|
protected |
|
protected |
Gets image stream.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_Location | ( | System::String | value | ) |
The CPU host name or physical location of the signing.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_OcspSettings | ( | System::SharedPtr< Aspose::Pdf::OcspSettings > | value | ) |
Gets/sets ocsp settings.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_Reason | ( | System::String | value | ) |
The reason for the signing, such as (I agree…).
|
protected |
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_ShowProperties | ( | bool | value | ) |
Force to show/hide signature properties.
|
protected |
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_TimestampSettings | ( | System::SharedPtr< Aspose::Pdf::TimestampSettings > | value | ) |
Gets/sets timestamp settings.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Signature::set_UseLtv | ( | bool | value | ) |
Gets/sets ltv validation flag.
|
protected |
Sign the document using data in this sugnature object.
sigName | Represents the name of the signature field which will contain this signature object. |
pfx | Stream with certificate data organized as pfx. |
pass | Password to get access to the private key in the certificate. |
ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Forms::Signature::Verify | ( | ) |
Verify the document regarding this signature and return true if document is valid or otherwise false.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |