The HPS::Image::ExportOptionsKit class contains options that will be used to export image files. Calling HPS::Image::ExportOptionsKit::GetDefault() will return an options kit with values found in this table. More...
Public Member Functions | |
override void | Dispose () |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (HPS.Image.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.Image.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
void | Show (out HPS.Image.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.Image.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
HPS.Image.ExportOptionsKit | SetSize (uint in_width, uint in_height) |
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export. More... | |
HPS.Image.ExportOptionsKit | SetFormat (HPS.Image.Format in_format) |
Sets the format of the image. This must be specified when exporting any image. More... | |
HPS.Image.ExportOptionsKit | UnsetSize () |
Removes the width and height of the image. More... | |
HPS.Image.ExportOptionsKit | UnsetFormat () |
Removes the format of the image. More... | |
HPS.Image.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
bool | ShowSize (out uint out_width, out uint out_height) |
Shows the width and height (in pixels) of the image. More... | |
bool | ShowFormat (out HPS.Image.Format out_format) |
Shows the format of the image. More... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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 HPS.Image.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 bool | operator== (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b) |
static bool | operator!= (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The HPS::Image::ExportOptionsKit class contains options that will be used to export image files. Calling HPS::Image::ExportOptionsKit::GetDefault() will return an options kit with values found in this table.
|
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 ExportOptionsKit 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 ExportOptionsKit to compare to this ExportOptionsKit. |
|
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 ExportOptionsKit to copy. |
|
inline |
Sets the format of the image. This must be specified when exporting any image.
in_format | The format of the image. |
Export format default value
|
inline |
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export.
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
|
inline |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The ExportOptionsKit to populate with the contents of this ExportOptionsKit. |
|
inline |
Shows the format of the image.
out_format | The format of the image. |
|
inline |
Shows the width and height (in pixels) of the image.
out_width | The width (in pixels) of the image. |
out_height | The height (in pixels) of the image. |
|
inline |
Removes all settings from this ExportOptionsKit.
|
inline |
Removes the format of the image.
|
inline |
Removes the width and height of the image.