|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ImageKit class is a user space object. It acts as the container for all data that can be used to specify an image for a Publish PDF.
◆ ImageKit() [1/2]
HPS.Publish.ImageKit.ImageKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty ImageKit object.
◆ ImageKit() [2/2]
The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.ImageKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this ImageKit has any values set on it.
- Returns
- true if no values are set on this ImageKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source ImageKit is equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.Publish.ImageKit.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()
◆ SetFile()
Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.
- Parameters
-
in_filename | UTF8-encoded filename for the image. |
- Returns
- A reference to this ImageKit.
◆ SetFormat()
Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ImageKit.
◆ SetSize()
◆ Show()
◆ ShowFile()
bool HPS.Publish.ImageKit.ShowFile |
( |
out string |
out_filename | ) |
|
|
inline |
Shows the file setting.
- Parameters
-
out_filename | The filename for the image. |
- Returns
- true if a color was specified, false otherwise.
◆ ShowFormat()
Shows the format setting.
- Parameters
-
out_format | The format of the image. |
- Returns
- true if a format was specified, false otherwise.
◆ ShowSize()
bool HPS.Publish.ImageKit.ShowSize |
( |
out int |
out_width, |
|
|
out int |
out_height |
|
) |
| |
|
inline |
Shows the size setting.
- Parameters
-
out_width | The width of the image in pixels. |
out_height | The height of the image in pixels. |
- Returns
- true if a width and height were specified, false otherwise.
◆ UnsetEverything()
Removes all data from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetFile()
Removes the file from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetFormat()
Removes the format from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetSize()
Removes the size from the image.
- Returns
- A reference to this ImageKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs