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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.ExportOptionsKit in_kit)
 
 ExportOptionsKit ()
 
 ExportOptionsKit (HPS.Publish.ExportOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.ExportOptionsKit in_kit)
 
HPS.Publish.ExportOptionsKit SetDocumentToAppendTo (string in_filename)
 
void Show (out HPS.Publish.ExportOptionsKit out_kit)
 
bool ShowDocumentToAppendTo (out string out_filename)
 
HPS.Publish.ExportOptionsKit UnsetDocumentToAppendTo ()
 
HPS.Publish.ExportOptionsKit UnsetEverything ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ ExportOptionsKit() [1/2]

HPS.Publish.ExportOptionsKit.ExportOptionsKit ( )
inline

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/2]

HPS.Publish.ExportOptionsKit.ExportOptionsKit ( HPS.Publish.ExportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportOptionsKit to copy.

Member Function Documentation

◆ Empty()

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

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.

◆ Equals()

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

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.Publish.ExportOptionsKit.ObjectType ( )
inlinevirtual

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).

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

Reimplemented from HPS.SprocketKit.

◆ Set()

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

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ SetDocumentToAppendTo()

HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.SetDocumentToAppendTo ( string  in_filename)
inline

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.

◆ Show()

void HPS.Publish.ExportOptionsKit.Show ( out HPS.Publish.ExportOptionsKit  out_kit)
inline

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe ExportOptionsKit to populate with the contents of this ExportOptionsKit.

◆ ShowDocumentToAppendTo()

bool HPS.Publish.ExportOptionsKit.ShowDocumentToAppendTo ( out string  out_filename)
inline

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.

◆ UnsetDocumentToAppendTo()

HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.UnsetDocumentToAppendTo ( )
inline

Removes the PDF document to append to setting.

Returns
A reference to this ExportOptionsKit.

◆ UnsetEverything()

HPS.Publish.ExportOptionsKit HPS.Publish.ExportOptionsKit.UnsetEverything ( )
inline

Removes all data from the options kit.

Returns
A reference to this ExportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs