SignDocAttachment Class Reference

Output of SignDocDocument.getAttachment(). More...

Public Member Functions
	~SignDocAttachment ()
	Destructor. More...
	!SignDocAttachment ()
	Finalizer. More...
	SignDocAttachment (SignDocAttachment aSource)
	Copy constructor. More...
string	getName ()
	Get the name of the attachment. More...
string	getFileName ()
	Get the file name of the attachment. More...
string	getDescription ()
	Get the description of the attachment. More...
int	getSize ()
	Get the size (in octets) of the attachment. More...
int	getCompressedSize ()
	Get the compressed size (in octets) of the attachment. More...
string	getType ()
	Get the MIME type of the attachment. More...
string	getCreationTime ()
	Get the creation time and date of the attachment. More...
string	getModificationTime ()
	Get the time and date of the last modification of the attachment. More...

Detailed Description

Output of SignDocDocument.getAttachment().

Constructor & Destructor Documentation

~SignDocAttachment

(

)

Destructor.

!SignDocAttachment

(

)

Finalizer.

SignDocAttachment

(

SignDocAttachment

aSource

)

Copy constructor.

Parameters

[in]

aSource

The object to be copied.

Member Function Documentation

int getCompressedSize

(

)

Get the compressed size (in octets) of the attachment.

Returns

The compressed size (in octets) of the attachment.

See also

getSize()

string getCreationTime

(

)

Get the creation time and date of the attachment.

The returned string will be empty if the creation time and date are missing.

ISO 8601 format is used: yyyy-mm-ddThh:mm:ss, optionally followed by a timezone: Z, +hh:mm, or -hh:mm.

The PDF reference is ambiguous; apparently, the creation time is supposed to be the time and date at which the attachment was the PDF document. Changing the description does not update the modification date/time.

Returns

The creation time and date of the attachment.

See also

getModificationTime()

string getDescription

(

)

Get the description of the attachment.

The returned string will be empty if the description is missing.

Returns

The description of the attachment.

string getFileName

(

)

Get the file name of the attachment.

Returns

The file name of the attachment.

string getModificationTime

(

)

Get the time and date of the last modification of the attachment.

Setting the time and date of the last modification of the attachment is optional. The returned string will be empty if the modification time and date are missing.

ISO 8601 format is used: yyyy-mm-ddThh:mm:ss, optionally followed by a timezone: Z, +hh:mm, or -hh:mm.

The PDF reference is ambiguous; apparently, the modification time is supposed to be the time and date of the last modification of the file at the time it was attached. Changing the description does not update the modification date/time.

Returns

The time and date of the last modification of the attachment.

string getName

(

)

Get the name of the attachment.

Returns

The name of the attachment.

int getSize

(

)

Get the size (in octets) of the attachment.

The return value is -1 if the size of the attachment is not readily available.

Returns

The size (in octets) of the attachment or -1.

See also

getCompressedSize()

string getType

(

)

Get the MIME type of the attachment.

The return string will be empty if the MIME type is missing.

Returns

The MIME type of the attachment.

---

The documentation for this class was generated from the following file:

• SignDocDotNet.cs