
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 (if the object is derived, this does not give the true type of the derived object). 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... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 | |
![]() | |
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]
|
inline |
The default constructor creates an empty ExportOptionsKit object.
◆ ExportOptionsKit() [2/2]
|
inline |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
Member Function Documentation
◆ 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()
|
inline |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
inline |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
◆ SetDocumentToAppendTo()
|
inline |
Sets the PDF document to append to.
- Parameters
-
in_filename UTF8-encoded filename of the PDF document to append to.
- Returns
- A reference to this ExportOptionsKit.
◆ Show()
|
inline |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
◆ ShowDocumentToAppendTo()
|
inline |
Shows the PDF document to append to setting.
- Parameters
-
out_filename Filename of the PDF document to append to.
- Returns
- true if a PDF document to append to setting was specified, false otherwise.
◆ UnsetDocumentToAppendTo()
|
inline |
Removes the PDF document to append to setting.
- Returns
- A reference to this 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