< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.ExportOptionsKit Class Reference

The ExportOptionsKit class is a user space object. More...

Inheritance diagram for HPS.Publish.ExportOptionsKit:
HPS.Sprocket HPS.Object

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...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ExportOptionsKit class is a user space object.

It contains settings controlling how 3D PDF data is exported via Publish.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.Publish.ExportOptionsKit.Empty ( )
virtual

Indicates whether this ExportOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.Publish.ExportOptionsKit.Equals ( HPS.Publish.ExportOptionsKit  in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.Publish.ExportOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

void HPS.Publish.ExportOptionsKit.Set ( HPS.Publish.ExportOptionsKit  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe 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.

Parameters
in_filenameUTF8-encoded filename of the PDF document to append to.
Returns
A reference to this ExportOptionsKit.
void HPS.Publish.ExportOptionsKit.Show ( out HPS.Publish.ExportOptionsKit  out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe <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.

Parameters
out_filenameFilename of the PDF document to append to.
Returns
true if a PDF document to append to setting was specified, false otherwise.
HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.UnsetDocumentToAppendTo ( )

Removes the PDF document to append to setting.

Returns
A reference to this ExportOptionsKit.
HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.UnsetEverything ( )

Removes all data from the options kit.

Returns
A reference to this ExportOptionsKit.

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