Represents a class to sign a pdf file with a certificate. More...

#include "PdfFileSignature.h"

Inherits Aspose::Pdf::Facades::SaveableFacade.

Public Member Functions
ASPOSE_PDF_SHARED_API System::String	get_SignatureAppearance () const
	Sets or gets a graphic appearance for the signature. Property value represents image file name. More...

ASPOSE_PDF_SHARED_API void	set_SignatureAppearance (System::String value)
	Sets or gets a graphic appearance for the signature. Property value represents image file name. More...

ASPOSE_PDF_SHARED_API bool	get_IsLtvEnabled ()
	Gets the LTV enabled flag. More...

ASPOSE_PDF_SHARED_API bool	get_IsCertified ()
	Gets the flag determining whether a document is certified or not. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Stream >	get_SignatureAppearanceStream () const
	Sets or gets a graphic appearance for the signature. Property value represents image stream. More...

ASPOSE_PDF_SHARED_API void	set_SignatureAppearanceStream (System::SharedPtr< System::IO::Stream > value)
	Sets or gets a graphic appearance for the signature. Property value represents image stream. More...

ASPOSE_PDF_SHARED_API	PdfFileSignature ()
	The constructor of PdfFileSignature class. More...

ASPOSE_PDF_SHARED_API	PdfFileSignature (System::String inputFile)
	The constructor of PdfFileSignature class. More...

ASPOSE_PDF_SHARED_API	PdfFileSignature (System::String inputFile, System::String outputFile)
	The constructor of PdfFileSignature class. More...

ASPOSE_PDF_SHARED_API void	BindPdf (System::String inputFile) override
	Binds a Pdf file for editing. More...

ASPOSE_PDF_SHARED_API void	BindPdf (System::SharedPtr< System::IO::Stream > inputStream) override
	Binds a Pdf stream for editing. More...

ASPOSE_PDF_SHARED_API void	Save (System::String outputFile) override
	Saves the result PDF to file. More...

ASPOSE_PDF_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > outputStream) override
	Saves the result PDF to stream. More...

ASPOSE_PDF_SHARED_API void	Sign (int32_t page, System::String SigReason, System::String SigContact, System::String SigLocation, bool visible, System::Drawing::Rectangle annotRect)
	Make a signature on the pdf document. More...

ASPOSE_PDF_SHARED_API void	Sign (int32_t page, System::String SigReason, System::String SigContact, System::String SigLocation, bool visible, System::Drawing::Rectangle annotRect, System::SharedPtr< Aspose::Pdf::Forms::Signature > sig)
	Sign the document with the given type signature. More...

ASPOSE_PDF_SHARED_API void	Sign (int32_t page, bool visible, System::Drawing::Rectangle annotRect, System::SharedPtr< Aspose::Pdf::Forms::Signature > sig)
	Sign the document with the given type signature. More...

ASPOSE_PDF_SHARED_API void	Sign (System::String SigName, System::String SigReason, System::String SigContact, System::String SigLocation, System::SharedPtr< Aspose::Pdf::Forms::Signature > sig)
	Sign the document with the given type signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). More...

ASPOSE_PDF_SHARED_API void	Sign (int32_t page, System::String SigName, System::String SigReason, System::String SigContact, System::String SigLocation, bool visible, System::Drawing::Rectangle annotRect, System::SharedPtr< Aspose::Pdf::Forms::Signature > sig)
	Sign the document with the given type signature which is placed in already presented signature field. Before signing pdf document should already has signature field, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). More...

ASPOSE_PDF_SHARED_API void	Sign (System::String SigName, System::SharedPtr< Aspose::Pdf::Forms::Signature > sig)
	Sign the document with the given type signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). Such data as signature reason, contact and location must be provided by corresponding properties of the Signature object sig. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::Forms::DocMDPAccessPermissions	GetAccessPermissions ()
	Returns the access permissions value of certified document by the MDP signature type. More...

ASPOSE_PDF_SHARED_API void	Certify (int32_t page, System::String SigReason, System::String SigContact, System::String SigLocation, bool visible, System::Drawing::Rectangle annotRect, System::SharedPtr< Aspose::Pdf::Forms::DocMDPSignature > docMdpSignature)
	Certify the document with the MDP signature. Such data as signature reason, contact and location must be provided by corresponding properties of the Signature object sig. More...

ASPOSE_PDF_SHARED_API void	Certify (System::String sigName, System::SharedPtr< Aspose::Pdf::Forms::DocMDPSignature > docMdpSignature)
	Certify the document with the MDP signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see sigName parameter). More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::String > >	GetSignNames (bool onlyActive=true)
	Gets the names of all not empty signatures. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::String > >	GetBlankSignNames ()
	Gets the names of all empty signature fields. More...

ASPOSE_PDF_SHARED_API bool	IsContainSignature ()
	Checks if the pdf has a digital signature or not. More...

ASPOSE_PDF_SHARED_API bool	ContainsSignature ()
	Checks if the pdf has a digital signature or not. More...

ASPOSE_PDF_SHARED_API bool	ContainsUsageRights ()
	Checks if the pdf has a usage rights or not. More...

ASPOSE_PDF_SHARED_API bool	IsCoversWholeDocument (System::String signName)
	Checks if the signature covers the whole document. More...

ASPOSE_PDF_SHARED_API bool	CoversWholeDocument (System::String signName)
	Checks if the signature covers the whole document. More...

ASPOSE_PDF_SHARED_API int32_t	GetRevision (System::String signName)
	Gets the revision of a signature. More...

ASPOSE_PDF_SHARED_API int32_t	GetTotalRevision ()
	Gets the toltal revision. More...

ASPOSE_PDF_SHARED_API void	RemoveUsageRights ()
	Removes the usage rights entry. More...

ASPOSE_PDF_SHARED_API void	RemoveSignature (System::String signName)
	Remove the signature according to the name of the signature. More...

ASPOSE_PDF_SHARED_API void	RemoveSignature (System::String signName, bool removeField)
	Removes the signature according to the name of the signature. More...

ASPOSE_PDF_SHARED_API void	RemoveSignatures ()
	Removes all signatures. More...

ASPOSE_PDF_SHARED_API bool	VerifySigned (System::String signName)
	Checks the validity of a signature. More...

ASPOSE_PDF_SHARED_API System::String	GetSignerName (System::String signName)
	Gets the name of person or organization who signing the pdf document. More...

ASPOSE_PDF_SHARED_API System::DateTime	GetDateTime (System::String signName)
	Gets the signature's datetime. More...

ASPOSE_PDF_SHARED_API System::String	GetReason (System::String signName)
	Gets the reason of a signature. More...

ASPOSE_PDF_SHARED_API System::String	GetLocation (System::String signName)
	Gets the location of a signature. More...

ASPOSE_PDF_SHARED_API System::String	GetContactInfo (System::String signName)
	Gets the contact information of a signature. More...

ASPOSE_PDF_SHARED_API bool	VerifySignature (System::String signName)
	Checks the validity of a signature. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Stream >	ExtractImage (System::String signName)
	Extracts signature's image. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Stream >	ExtractCertificate (System::String signName)
	Extracts signature's single X.509 certificate as a stream. More...

ASPOSE_PDF_SHARED_API void	Save ()
	Save signed pdf file. Output filename must be provided before with the help of coresponding PdfFileSignature constructor. More...

ASPOSE_PDF_SHARED_API	PdfFileSignature (System::SharedPtr< Aspose::Pdf::Document > document)
	Initializes new PdfFileSignature object on base of the document . More...

ASPOSE_PDF_SHARED_API	PdfFileSignature (System::SharedPtr< Aspose::Pdf::Document > document, System::String outputFile)
	Initializes new PdfFileSignature object on base of the document . More...

ASPOSE_PDF_SHARED_API void	SetCertificate (System::String pfx, System::String pass)
	Set certificate file and password for signing routine. More...

ASPOSE_PDF_SHARED_API void	Close () override
	Closes the facade. More...

Public Member Functions inherited from Aspose::Pdf::Facades::Facade
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Document >	get_Document () const
	Gets the document facade is working on. More...

ASPOSE_PDF_SHARED_API void	BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
	Initializes the facade. More...

ASPOSE_PDF_SHARED_API void	Dispose () override
	Disposes the facade. More...

Public Member Functions inherited from Aspose::Pdf::Facades::IFacade
virtual void	BindPdf (System::SharedPtr< Document > srcDoc)=0
	Binds PDF document for editing. 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...

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...

Protected Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API	SaveableFacade ()
	The constructor. More...

ASPOSE_PDF_SHARED_API	SaveableFacade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
	The constructor. More...

Protected Member Functions inherited from Aspose::Pdf::Facades::Facade
bool	get__IsObjectLicensed ()
	Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...

ASPOSE_PDF_SHARED_API	Facade ()
	The constructor. More...

ASPOSE_PDF_SHARED_API	Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
	The constructor. More...

virtual ASPOSE_PDF_SHARED_API void	BindPdf (System::String srcFile, System::String password)
	Initializes the facade. More...

virtual ASPOSE_PDF_SHARED_API void	BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
	Initializes the facade. More...

virtual ASPOSE_PDF_SHARED_API void	AssertDocument () const
	Asserts if the facade is initialized. More...

virtual ASPOSE_PDF_SHARED_API	~Facade ()

Detailed Description

Represents a class to sign a pdf file with a certificate.

Constructor & Destructor Documentation

◆ PdfFileSignature() [1/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSignature::PdfFileSignature ( )

The constructor of PdfFileSignature class.

◆ PdfFileSignature() [2/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSignature::PdfFileSignature ( System::String inputFile )

The constructor of PdfFileSignature class.

Deprecated:: Use another constructor for instance initialization.

Parameters

inputFile The input file for signature.

◆ PdfFileSignature() [3/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSignature::PdfFileSignature	(	System::String	inputFile,
		System::String	outputFile
	)

The constructor of PdfFileSignature class.

Deprecated:: Use another constructor for instance initialization.

Parameters

inputFile	The input file for signature.
outputFile	The output file.

◆ PdfFileSignature() [4/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSignature::PdfFileSignature ( System::SharedPtr< Aspose::Pdf::Document > document )

Initializes new PdfFileSignature object on base of the document .

Parameters

document Pdf document.

◆ PdfFileSignature() [5/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSignature::PdfFileSignature	(	System::SharedPtr< Aspose::Pdf::Document >	document,
		System::String	outputFile
	)

Initializes new PdfFileSignature object on base of the document .

Deprecated:: Use another constructor for instance initialization.

Parameters

document	Pdf document.
outputFile	The output file.

Member Function Documentation

◆ BindPdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::BindPdf ( System::String inputFile )

overridevirtual

Binds a Pdf file for editing.

Parameters

inputFile The pdf file to be edited.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ BindPdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::BindPdf ( System::SharedPtr< System::IO::Stream > inputStream )

overridevirtual

Binds a Pdf stream for editing.

Parameters

inputStream The pdf stream to be edited.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ Certify() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Certify	(	int32_t	page,
		System::String	SigReason,
		System::String	SigContact,
		System::String	SigLocation,
		bool	visible,
		System::Drawing::Rectangle	annotRect,
		System::SharedPtr< Aspose::Pdf::Forms::DocMDPSignature >	docMdpSignature
	)

Certify the document with the MDP signature. Such data as signature reason, contact and location must be provided by corresponding properties of the Signature object sig.

Parameters

page	The page on which signature is made.
SigReason	The reason of signature.
SigContact	The contact of signature.
SigLocation	The location of signature.
visible	The visiblity of signature.
annotRect	The rect of signature.
docMdpSignature	The document MDP type of the signature.

◆ Certify() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Certify	(	System::String	sigName,
		System::SharedPtr< Aspose::Pdf::Forms::DocMDPSignature >	docMdpSignature
	)

Certify the document with the MDP signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see sigName parameter).

Parameters

sigName	The name of the signature field.
docMdpSignature	The type of the signature, could be Aspose::Pdf::Forms::PKCS1, Aspose::Pdf::Forms::PKCS7 and Aspose::Pdf::Forms::PKCS7Detached

◆ Close()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Close ( )

overridevirtual

Closes the facade.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ ContainsSignature()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::ContainsSignature ( )

Checks if the pdf has a digital signature or not.

Returns: Return a result of bool type.

◆ ContainsUsageRights()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::ContainsUsageRights ( )

Checks if the pdf has a usage rights or not.

Returns: Returns a result of bool type.

◆ CoversWholeDocument()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::CoversWholeDocument ( System::String signName )

Checks if the signature covers the whole document.

Parameters

signName The name of signature.

Returns: Return a result of bool type.

◆ ExtractCertificate()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::PdfFileSignature::ExtractCertificate ( System::String signName )

Extracts signature's single X.509 certificate as a stream.

Parameters

signName The name of signature.

Returns: If certificate was found returns X.509 single certificate; otherwise, null.

◆ ExtractImage()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::PdfFileSignature::ExtractImage ( System::String signName )

Extracts signature's image.

Parameters

signName The name of signature.

Returns: If image was successfully found than returns stream object; otherwise, null.

◆ get_IsCertified()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::get_IsCertified ( )

Gets the flag determining whether a document is certified or not.

◆ get_IsLtvEnabled()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::get_IsLtvEnabled ( )

Gets the LTV enabled flag.

◆ get_SignatureAppearance()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileSignature::get_SignatureAppearance ( ) const

Sets or gets a graphic appearance for the signature. Property value represents image file name.

◆ get_SignatureAppearanceStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::PdfFileSignature::get_SignatureAppearanceStream ( ) const

Sets or gets a graphic appearance for the signature. Property value represents image stream.

◆ GetAccessPermissions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Forms::DocMDPAccessPermissions Aspose::Pdf::Facades::PdfFileSignature::GetAccessPermissions ( )

Returns the access permissions value of certified document by the MDP signature type.

Returns

If the document is being certified, than returns access permissions value; otherwise,

Exceptions

System::ApplicationException

is thrown.

◆ GetBlankSignNames()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::String> > Aspose::Pdf::Facades::PdfFileSignature::GetBlankSignNames ( )

Gets the names of all empty signature fields.

Returns: Return an IList.

◆ GetContactInfo()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileSignature::GetContactInfo ( System::String signName )

Gets the contact information of a signature.

Parameters

signName The name of signature.

Returns: Returns a result of string type.

◆ GetDateTime()

ASPOSE_PDF_SHARED_API System::DateTime Aspose::Pdf::Facades::PdfFileSignature::GetDateTime ( System::String signName )

Gets the signature's datetime.

Parameters

signName The name of signature.

Returns: Return the result of DateTime type.

◆ GetLocation()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileSignature::GetLocation ( System::String signName )

Gets the location of a signature.

Parameters

signName The name of signature.

Returns: Returns a result of string type.

◆ GetReason()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileSignature::GetReason ( System::String signName )

Gets the reason of a signature.

Parameters

signName The name of signature.

Returns: Returns a result of string type.

◆ GetRevision()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileSignature::GetRevision ( System::String signName )

Gets the revision of a signature.

Parameters

signName The name of signature.

Returns: Return the number of signature revision.

◆ GetSignerName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileSignature::GetSignerName ( System::String signName )

Gets the name of person or organization who signing the pdf document.

Parameters

signName The name of signature.

Returns: Returns the result of the signer's name.

◆ GetSignNames()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::String> > Aspose::Pdf::Facades::PdfFileSignature::GetSignNames ( bool onlyActive = true )

Gets the names of all not empty signatures.

Parameters

onlyActive if true, return only active signatures; otherwise, return all signatures.

Returns: Return an IList<string>.

◆ GetTotalRevision()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileSignature::GetTotalRevision ( )

Gets the toltal revision.

Returns: Return the total number of signature revision.

◆ IsContainSignature()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::IsContainSignature ( )

Checks if the pdf has a digital signature or not.

Deprecated:: ContainsSignature should be used instead of IsContainSignature.

Returns: Return a result of bool type.

◆ IsCoversWholeDocument()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::IsCoversWholeDocument ( System::String signName )

Checks if the signature covers the whole document.

Deprecated:: CoversWholeDocument should be used instead of IsCoversWholeDocument.

Parameters

signName The name of signature.

Returns: Return a result of bool type.

◆ RemoveSignature() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::RemoveSignature ( System::String signName )

Remove the signature according to the name of the signature.

Parameters

signName The name of signature.

◆ RemoveSignature() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::RemoveSignature	(	System::String	signName,
		bool	removeField
	)

Removes the signature according to the name of the signature.

Parameters

signName	The name of signature.
removeField	If set to true, than removes both of signature and field from document; otherwise, signature only.

◆ RemoveSignatures()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::RemoveSignatures ( )

Removes all signatures.

◆ RemoveUsageRights()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::RemoveUsageRights ( )

Removes the usage rights entry.

◆ Save() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Save ( System::String outputFile )

overridevirtual

Saves the result PDF to file.

Parameters

outputFile Output pdf file.

Reimplemented from Aspose::Pdf::Facades::SaveableFacade.

◆ Save() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Save ( System::SharedPtr< System::IO::Stream > outputStream )

overridevirtual

Saves the result PDF to stream.

Parameters

outputStream Output pdf stream.

Reimplemented from Aspose::Pdf::Facades::SaveableFacade.

◆ Save() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Save ( )

Save signed pdf file. Output filename must be provided before with the help of coresponding PdfFileSignature constructor.

Deprecated:: Please, use Save method with parameter.

◆ set_SignatureAppearance()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::set_SignatureAppearance ( System::String value )

Sets or gets a graphic appearance for the signature. Property value represents image file name.

◆ set_SignatureAppearanceStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::set_SignatureAppearanceStream ( System::SharedPtr< System::IO::Stream > value )

Sets or gets a graphic appearance for the signature. Property value represents image stream.

◆ SetCertificate()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::SetCertificate	(	System::String	pfx,
		System::String	pass
	)

Set certificate file and password for signing routine.

Parameters

pfx	PKCS #12 certificate file.
pass	Password to get access for the certificate private key.

◆ Sign() [1/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Sign	(	int32_t	page,
		System::String	SigReason,
		System::String	SigContact,
		System::String	SigLocation,
		bool	visible,
		System::Drawing::Rectangle	annotRect
	)

Make a signature on the pdf document.

Parameters

page	The page number on which signature is made.
SigReason	The reason of signature.
SigContact	The contact of signature.
SigLocation	The location of signature.
visible	The visiblity of signature.
annotRect	The rect of signature.

◆ Sign() [2/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Sign	(	int32_t	page,
		System::String	SigReason,
		System::String	SigContact,
		System::String	SigLocation,
		bool	visible,
		System::Drawing::Rectangle	annotRect,
		System::SharedPtr< Aspose::Pdf::Forms::Signature >	sig
	)

Sign the document with the given type signature.

Parameters

page	The page number on which signature is made.
SigReason	The reason of signature.
SigContact	The contact of signature.
SigLocation	The location of signature.
visible	The visiblity of signature.
annotRect	The rect of signature.
sig	The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached.

◆ Sign() [3/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Sign	(	int32_t	page,
		bool	visible,
		System::Drawing::Rectangle	annotRect,
		System::SharedPtr< Aspose::Pdf::Forms::Signature >	sig
	)

Sign the document with the given type signature.

Parameters

page	The page number on which signature is made.
visible	The visiblity of signature.
annotRect	The rect of signature.
sig	The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached. Such data as signature reason, contact and location must be already present in this object (see corresponding properties).

◆ Sign() [4/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Sign	(	System::String	SigName,
		System::String	SigReason,
		System::String	SigContact,
		System::String	SigLocation,
		System::SharedPtr< Aspose::Pdf::Forms::Signature >	sig
	)

Sign the document with the given type signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter).

Parameters

SigName	The name of the signature field.
SigReason	The reason of signature.
SigContact	The contact of signature.
SigLocation	The location of signature.
sig	The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached.

◆ Sign() [5/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Sign	(	int32_t	page,
		System::String	SigName,
		System::String	SigReason,
		System::String	SigContact,
		System::String	SigLocation,
		bool	visible,
		System::Drawing::Rectangle	annotRect,
		System::SharedPtr< Aspose::Pdf::Forms::Signature >	sig
	)

Sign the document with the given type signature which is placed in already presented signature field. Before signing pdf document should already has signature field, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter).

Parameters

page	The page number on which signature is made.
SigName	The name of the signature field.
SigReason	The reason of signature.
SigContact	The contact of signature.
SigLocation	The location of signature.
visible	The visiblity of signature.
annotRect	The rect of signature.
sig	The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached.

◆ Sign() [6/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSignature::Sign	(	System::String	SigName,
		System::SharedPtr< Aspose::Pdf::Forms::Signature >	sig
	)

Sign the document with the given type signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). Such data as signature reason, contact and location must be provided by corresponding properties of the Signature object sig.

Parameters

SigName	The name of the signature field.
sig	The type of the signature, could be PKCS1 (Pkcs1Signature object), PKCS7 and PKCS7 detached (Pkcs7Signature object)

◆ VerifySignature()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::VerifySignature ( System::String signName )

Checks the validity of a signature.

Parameters

signName The name of signature.

Returns: Return a result of bool type.

◆ VerifySigned()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSignature::VerifySigned ( System::String signName )

Checks the validity of a signature.

Parameters

signName The name of signature.

Returns: Return a result of bool type.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfFileSignature() [1/5]

◆ PdfFileSignature() [2/5]

◆ PdfFileSignature() [3/5]

◆ PdfFileSignature() [4/5]

◆ PdfFileSignature() [5/5]

Member Function Documentation

◆ BindPdf() [1/2]

◆ BindPdf() [2/2]

◆ Certify() [1/2]

◆ Certify() [2/2]

◆ Close()

◆ ContainsSignature()

◆ ContainsUsageRights()

◆ CoversWholeDocument()

◆ ExtractCertificate()

◆ ExtractImage()

◆ get_IsCertified()

◆ get_IsLtvEnabled()

◆ get_SignatureAppearance()

◆ get_SignatureAppearanceStream()

◆ GetAccessPermissions()

◆ GetBlankSignNames()

◆ GetContactInfo()

◆ GetDateTime()

◆ GetLocation()

◆ GetReason()

◆ GetRevision()

◆ GetSignerName()

◆ GetSignNames()

◆ GetTotalRevision()

◆ IsContainSignature()

◆ IsCoversWholeDocument()

◆ RemoveSignature() [1/2]

◆ RemoveSignature() [2/2]

◆ RemoveSignatures()

◆ RemoveUsageRights()

◆ Save() [1/3]

◆ Save() [2/3]

◆ Save() [3/3]

◆ set_SignatureAppearance()

◆ set_SignatureAppearanceStream()

◆ SetCertificate()

◆ Sign() [1/6]

◆ Sign() [2/6]

◆ Sign() [3/6]

◆ Sign() [4/6]

◆ Sign() [5/6]

◆ Sign() [6/6]

◆ VerifySignature()

◆ VerifySigned()