REFERENCE MANUAL
The Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. 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.Hardcopy.File.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.Hardcopy.File.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.Hardcopy.File.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetResolution (float in_resolution, HPS.Hardcopy.ResolutionUnits in_units) |
Sets the resolution of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetResolution (float in_resolution) |
Sets the resolution of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetSize (float in_width, float in_height, HPS.Hardcopy.SizeUnits in_units) |
Sets the size of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetSize (float in_width, float in_height) |
Sets the size of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetWYSIWYG (bool in_onoff) |
Enables or disables wysiwyg hardcopy output More... | |
void | Show (out HPS.Hardcopy.File.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
bool | ShowResolution (out float out_resolution, out HPS.Hardcopy.ResolutionUnits out_units) |
Shows the resolution of the image to be inserted into the Hardcopy. More... | |
bool | ShowSize (out float out_width, out float out_height, out HPS.Hardcopy.SizeUnits out_units) |
Shows the size of the image to be inserted into the Hardcopy. More... | |
bool | ShowWYSIWYG (out bool out_onoff) |
Shows true if wysiwyg has been enabled More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetResolution () |
Removes the resolution of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetSize () |
Removes the size of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetWYSIWYG () |
Removes the wysiwyg setting from Hardcopy. More... | |
![]() | |
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 HPS.Hardcopy.File.ExportOptionsKit | GetDefault () |
Creates a ExportOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.Hardcopy.File.ExportOptionsKit a, HPS.Hardcopy.File.ExportOptionsKit b) |
static bool | operator== (HPS.Hardcopy.File.ExportOptionsKit a, HPS.Hardcopy.File.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export.
Calling Hardcopy::File::ExportOptionsKit::GetDefault() will return an options kit with values found in here.
HPS.Hardcopy.File.ExportOptionsKit.ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS.Hardcopy.File.ExportOptionsKit.ExportOptionsKit | ( | HPS.Hardcopy.File.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_hardcopy_1_1_file_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.Hardcopy.File.ExportOptionsKit.Equals | ( | HPS.Hardcopy.File.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_hardcopy_1_1_file_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_hardcopy_1_1_file_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>. |
|
static |
Creates a ExportOptionsKit which contains the default settings.
The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
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.Hardcopy.File.ExportOptionsKit.Set | ( | HPS.Hardcopy.File.ExportOptionsKit | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_hardcopy_1_1_file_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy. |
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.SetResolution | ( | float | in_resolution, |
HPS.Hardcopy.ResolutionUnits | in_units | ||
) |
Sets the resolution of the image to be inserted into the Hardcopy.
in_resolution | Resolution (dots per inch or dots per centimeter). |
in_units | Units of preceding arguments. Defaults to Inches. |
Default value
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.SetResolution | ( | float | in_resolution | ) |
Sets the resolution of the image to be inserted into the Hardcopy.
in_resolution | Resolution (dots per inch or dots per centimeter). |
Default value
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.SetSize | ( | float | in_width, |
float | in_height, | ||
HPS.Hardcopy.SizeUnits | in_units | ||
) |
Sets the size of the image to be inserted into the Hardcopy.
in_width | Width in inches. |
in_height | Height in inches. |
in_units | Units of preceding arguments. Defaults to Inches |
Default value
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.SetSize | ( | float | in_width, |
float | in_height | ||
) |
Sets the size of the image to be inserted into the Hardcopy.
in_width | Width in inches. |
in_height | Height in inches. |
Default value
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.SetWYSIWYG | ( | bool | in_onoff | ) |
Enables or disables wysiwyg hardcopy output
in_onoff | true is on, false is off |
Default value
void HPS.Hardcopy.File.ExportOptionsKit.Show | ( | out HPS.Hardcopy.File.ExportOptionsKit | out_kit | ) |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_hardcopy_1_1_file_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_hardcopy_1_1_file_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>. |
bool HPS.Hardcopy.File.ExportOptionsKit.ShowResolution | ( | out float | out_resolution, |
out HPS.Hardcopy.ResolutionUnits | out_units | ||
) |
Shows the resolution of the image to be inserted into the Hardcopy.
out_resolution | Resolution (dots per inch or dots per centimeter). |
out_units | Units of preceding arguments. |
bool HPS.Hardcopy.File.ExportOptionsKit.ShowSize | ( | out float | out_width, |
out float | out_height, | ||
out HPS.Hardcopy.SizeUnits | out_units | ||
) |
Shows the size of the image to be inserted into the Hardcopy.
out_width | Width. |
out_height | Height. |
out_units | Units of preceding arguments. |
bool HPS.Hardcopy.File.ExportOptionsKit.ShowWYSIWYG | ( | out bool | out_onoff | ) |
Shows true if wysiwyg has been enabled
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetResolution | ( | ) |
Removes the resolution of the image to be inserted into the Hardcopy.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetSize | ( | ) |
Removes the size of the image to be inserted into the Hardcopy.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetWYSIWYG | ( | ) |
Removes the wysiwyg setting from Hardcopy.