< Home

< Table of Contents

REFERENCE MANUAL

HPS.Hardcopy.File.ExportOptionsKit Class Reference

The Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. More...

Inheritance diagram for HPS.Hardcopy.File.ExportOptionsKit:
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.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...
 
- 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
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 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
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

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.

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

Member Function Documentation

override bool HPS.Hardcopy.File.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.Hardcopy.File.ExportOptionsKit.Equals ( HPS.Hardcopy.File.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_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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.GetDefault ( )
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.

Returns
A ExportOptionsKit with the default settings.
override HPS.Type HPS.Hardcopy.File.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.Hardcopy.File.ExportOptionsKit.Set ( HPS.Hardcopy.File.ExportOptionsKit  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

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

Parameters
in_resolutionResolution (dots per inch or dots per centimeter).
in_unitsUnits of preceding arguments. Defaults to Inches.
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_resolutionResolution (dots per inch or dots per centimeter).
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_widthWidth in inches.
in_heightHeight in inches.
in_unitsUnits of preceding arguments. Defaults to Inches
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_widthWidth in inches.
in_heightHeight in inches.
Returns
A reference to this ExportOptionsKit.

Default value

HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.SetWYSIWYG ( bool  in_onoff)

Enables or disables wysiwyg hardcopy output

Parameters
in_onofftrue is on, false is off
Returns
A reference to this ExportOptionsKit.

Default value

void HPS.Hardcopy.File.ExportOptionsKit.Show ( out HPS.Hardcopy.File.ExportOptionsKit  out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

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

Parameters
out_resolutionResolution (dots per inch or dots per centimeter).
out_unitsUnits of preceding arguments.
Returns
true if a size setting was specified, false otherwise.
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.

Parameters
out_widthWidth.
out_heightHeight.
out_unitsUnits of preceding arguments.
Returns
true if a size setting was specified, false otherwise.
bool HPS.Hardcopy.File.ExportOptionsKit.ShowWYSIWYG ( out bool  out_onoff)

Shows true if wysiwyg has been enabled

Returns
true if a size setting was specified, false otherwise.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetEverything ( )

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetResolution ( )

Removes the resolution of the image to be inserted into the Hardcopy.

Returns
A reference to this ExportOptionsKit.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetSize ( )

Removes the size of the image to be inserted into the Hardcopy.

Returns
A reference to this ExportOptionsKit.
HPS.Hardcopy.File.ExportOptionsKit HPS.Hardcopy.File.ExportOptionsKit.UnsetWYSIWYG ( )

Removes the wysiwyg setting from Hardcopy.

Returns
A reference to this ExportOptionsKit.

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