HPS::Publish::ExportOptionsKit

class HPS.Publish.ExportOptionsKit : public HPS.SprocketKit

The ExportOptionsKit class is a user space object. It contains settings controlling how 3D PDF data is exported via Publish.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOptionsKit has any values set on it.

Return

true if no values are set on this ExportOptionsKit, false otherwise.

bool Equals (HPS.Publish.ExportOptionsKit in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOptionsKit ()

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit (HPS.Publish.ExportOptionsKit in_kit)

The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to copy.

override int GetHashCode ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.ExportOptionsKit in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to copy.

HPS.Publish.ExportOptionsKit SetDocumentToAppendTo (string in_filename)

Sets the PDF document to append to.

Param in_filename

UTF8-encoded filename of the PDF document to append to.

Return

A reference to this ExportOptionsKit.

void Show (out HPS.Publish.ExportOptionsKit out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Param out_kit

The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

bool ShowDocumentToAppendTo (out string out_filename)

Shows the PDF document to append to setting.

Param out_filename

Filename of the PDF document to append to.

Return

true if a PDF document to append to setting was specified, false otherwise.

HPS.Publish.ExportOptionsKit UnsetDocumentToAppendTo ()

Removes the PDF document to append to setting.

Return

A reference to this ExportOptionsKit.

HPS.Publish.ExportOptionsKit UnsetEverything ()

Removes all data from the options kit.

Return

A reference to this ExportOptionsKit.

Public Static Functions

bool operator!= (HPS.Publish.ExportOptionsKit a, HPS.Publish.ExportOptionsKit b)

bool operator== (HPS.Publish.ExportOptionsKit a, HPS.Publish.ExportOptionsKit b)