OfficeConvertParams Class

class OfficeConvertParams

Namespace:datalogics_interface

Detailed Description

Parameters for Document::from_office_file. The settings for one Office-to-PDF conversion: the instant stamped as the PDF's creation date and used for the document's DATE and TIME fields (the system clock unless one is set), and how the document's Word comments appear (left out unless set). One object serves any number of conversions, and building or setting one never throws, on any platform.

Uses types

OfficeCommentRendering OfficeConversionTime

Constructor & Destructor Documentation

OfficeConvertParams()

Default parameters: the system clock, and comments left out.

OfficeConvertParams(const OfficeConvertParams & )

Parameters

: const OfficeConvertParams &

OfficeConvertParams(OfficeConvertParams && )

Parameters

: OfficeConvertParams &&

~OfficeConvertParams()

Member Function Documentation

void clear_conversion_time()

Returns:

void

Go back to the system clock, the default.

OfficeCommentRendering get_comments()

Returns:

OfficeCommentRendering

How the document's Word comments appear.

OfficeConversionTime get_conversion_time()

Returns:

OfficeConversionTime

The instant set; all zero when has_conversion_time() is false.

bool has_conversion_time()

Returns:

bool

Whether an instant is set.

OfficeConvertParams & operator=(const OfficeConvertParams & )

Parameters

: const OfficeConvertParams &

Returns:

OfficeConvertParams &

OfficeConvertParams & operator=(OfficeConvertParams && )

Parameters

: OfficeConvertParams &&

Returns:

OfficeConvertParams &

void set_comments(OfficeCommentRendering mode)

Parameters

mode: OfficeCommentRendering

Returns:

void

How the document's Word comments appear. The default is Omit.

void set_conversion_time(const OfficeConversionTime & time)

Parameters

time: const OfficeConversionTime &

Returns:

void

Use this instant in place of the system clock.