FileAttachment Class Documentation

classFileAttachment

Namespace:datalogics_interface

Detailed Description

The class allows to create attachment and manipulate by its content.

Uses types

AFRelationship

Constructor & Destructor Documentation

FileAttachment

FileAttachment(Document &doc, const std::string &file_name)

Parameters

doc: Document &

The PDF document (reference).

file_name: const std::string &

The path to file which will be attached to the document.

Allows to add attachment into the PDF document.

FileAttachment

FileAttachment(Document &doc, const std::string &file_name, const std::string &key_name)

Parameters

doc: Document &

The PDF document (reference).

file_name: const std::string &

The path to file which will be attached to the document.

key_name: const std::string &

Allows to add attachment into the PDF document.

~FileAttachment

~FileAttachment()

Member Function Documentation

get_af_relationship

AFRelationshipget_af_relationship()

Returns:

The attachment's Associated File relationship.

Gets the attachment's Associated File relationship.

get_file_name

std::stringget_file_name()

Returns:

The attachment's file name.

Gets the attachment's file name.

get_file_size

size_tget_file_size()

Returns:

The attachment's size in bytes.

Gets the attachment's file size.

save_to_file

voidsave_to_file(const std::string &file_name)

Parameters

file_name: const std::string &

The path where attachment will be saved.

Returns:

void

Allows to save attachment to the specified file.

set_af_relationship

voidset_af_relationship(AFRelationshiprelationship)

Parameters

relationship: AFRelationship

The Associated File relationship to set.

Returns:

void

Sets the attachment's Associated File relationship.

update_from_file

voidupdate_from_file(const std::string &file_name)

Parameters

file_name: const std::string &

The path to the file from which attachment will be updated.

Returns:

void

Allows to update attachment from another file.