REFERENCE MANUAL
The ExportOptionsKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (HPS.Publish.ExportOptionsKit in_kit) | |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Publish.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
HPS.Publish.ExportOptionsKit | SetDocumentToAppendTo (string in_filename) |
Sets the PDF document to append to. More... | |
void | Show (out HPS.Publish.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
bool | ShowDocumentToAppendTo (out string out_filename) |
Shows the PDF document to append to setting. More... | |
HPS.Publish.ExportOptionsKit | UnsetDocumentToAppendTo () |
Removes the PDF document to append to setting. More... | |
HPS.Publish.ExportOptionsKit | UnsetEverything () |
Removes all data from the options kit. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Publish.ExportOptionsKit a, HPS.Publish.ExportOptionsKit b) |
static bool | operator== (HPS.Publish.ExportOptionsKit a, HPS.Publish.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ExportOptionsKit class is a user space object.
It contains settings controlling how 3D PDF data is exported via Publish.
HPS.Publish.ExportOptionsKit.ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS.Publish.ExportOptionsKit.ExportOptionsKit | ( | HPS.Publish.ExportOptionsKit | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.ExportOptionsKit.Equals | ( | HPS.Publish.ExportOptionsKit | in_kit | ) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Publish.ExportOptionsKit.Set | ( | HPS.Publish.ExportOptionsKit | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy. |
HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.SetDocumentToAppendTo | ( | string | in_filename | ) |
Sets the PDF document to append to.
in_filename | UTF8-encoded filename of the PDF document to append to. |
void HPS.Publish.ExportOptionsKit.Show | ( | out HPS.Publish.ExportOptionsKit | out_kit | ) |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>. |
bool HPS.Publish.ExportOptionsKit.ShowDocumentToAppendTo | ( | out string | out_filename | ) |
Shows the PDF document to append to setting.
out_filename | Filename of the PDF document to append to. |
HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.UnsetDocumentToAppendTo | ( | ) |
Removes the PDF document to append to setting.
HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.UnsetEverything | ( | ) |
Removes all data from the options kit.