The HPS::Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. Calling HPS::Hardcopy::File::ExportOptionsKit::GetDefault() will return an options kit with values found in here. More...
Public Member Functions | |
override void | Dispose () |
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 HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
void | Show (out HPS.Hardcopy.File.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
override bool | Empty () |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. 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... | |
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 | UnsetSize () |
Removes the size of the image to be inserted into the Hardcopy. 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... | |
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 | UnsetResolution () |
Removes the resolution 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 | SetWYSIWYG (bool in_onoff) |
Enables or disables WYSIWYG hardcopy output. The WYSIWYG setting (which stands for What You See Is What You Get) works as follows: <itemizedlist> <listitem> More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetWYSIWYG () |
Removes the wysiwyg setting from Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
![]() | |
IntPtr | GetClassID () |
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... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
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 HPS.Hardcopy.File.ExportOptionsKit | GetDefault () |
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. More... | |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The HPS::Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. Calling HPS::Hardcopy::File::ExportOptionsKit::GetDefault() will return an options kit with values found in here.
|
inline |
The default constructor creates an empty ExportOptionsKit object.
|
inline |
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. |
|
inlinevirtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
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>. |
|
inlinestatic |
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.
|
inlinevirtual |
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.
|
inline |
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. |
|
inline |
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
|
inline |
Sets the resolution of the image to be inserted into the Hardcopy.
in_resolution | Resolution (dots per inch or dots per centimeter). |
Default value
|
inline |
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
|
inline |
Sets the size of the image to be inserted into the Hardcopy.
in_width | Width in inches. |
in_height | Height in inches. |
Default value
|
inline |
Enables or disables WYSIWYG hardcopy output. The WYSIWYG setting (which stands for What You See Is What You Get) works as follows: <itemizedlist> <listitem>
If true, what you see on the screen is what will be printed. This is the default.
</listitem> <listitem>
If false, everything which will fit on the page size you have specified will be printed, even if some of that is not on screen when you issue the command.
</listitem> </itemizedlist>
in_onoff | true is on, false is off. |
Default value
|
inline |
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>. |
|
inline |
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. |
|
inline |
Shows the size of the image to be inserted into the Hardcopy.
out_width | Width. |
out_height | Height. |
out_units | Units of preceding arguments. |
|
inline |
Shows true if wysiwyg has been enabled
|
inline |
Removes all settings from this ExportOptionsKit.
|
inline |
Removes the resolution of the image to be inserted into the Hardcopy.
|
inline |
Removes the size of the image to be inserted into the Hardcopy.
|
inline |
Removes the wysiwyg setting from Hardcopy.