HPS::Publish::ImageKit

class HPS.Publish.ImageKit : public HPS.SprocketKit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImageKit has any values set on it.

Return: true if no values are set on this ImageKit, false otherwise.

bool Equals (HPS.Publish.ImageKit in_kit)

Check if the source ImageKit is equivalent to this ImageKit.

Param in_kit: The source ImageKit to compare to this ImageKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ImageKit (): The default constructor creates an empty ImageKit object.

ImageKit (HPS.Publish.ImageKit in_kit)

The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.

Param in_kit: The source ImageKit to copy.

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.ImageKit in_kit)

Copies the source ImageKit into this ImageKit.

Param in_kit: The source ImageKit to copy.

HPS.Publish.ImageKit SetFile (string in_filename)

Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.

Param in_filename: UTF8-encoded filename for the image.
Return: A reference to this ImageKit.

HPS.Publish.ImageKit SetFormat (HPS.Publish.Image.Format in_format)

Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.

Param in_format: The format of the image.
Return: A reference to this ImageKit.

HPS.Publish.ImageKit SetSize (int in_width, int in_height)

Sets the size of the image in pixels. This corresponds to the value that will be passed to A3DPDFImageData::m_iWidth and A3DPDFImageData::m_iHeight.

Param in_width: The width of the image in pixels.
Param in_height: The height of the image in pixels.
Return: A reference to this ImageKit.

void Show (out HPS.Publish.ImageKit out_kit)

Copies this ImageKit into the given ImageKit.

Param out_kit: The ImageKit to populate with the contents of this ImageKit.

bool ShowFile (out string out_filename)

Shows the file setting.

Param out_filename: The filename for the image.
Return: true if a color was specified, false otherwise.

bool ShowFormat (out HPS.Publish.Image.Format out_format)

Shows the format setting.

Param out_format: The format of the image.
Return: true if a format was specified, false otherwise.

bool ShowSize (out int out_width, out int out_height)

Shows the size setting.

Param out_width: The width of the image in pixels.
Param out_height: The height of the image in pixels.
Return: true if a width and height were specified, false otherwise.

HPS.Publish.ImageKit UnsetEverything ()

Removes all data from the image.

Return: A reference to this ImageKit.

HPS.Publish.ImageKit UnsetFile ()

Removes the file from the image.

Return: A reference to this ImageKit.

HPS.Publish.ImageKit UnsetFormat ()

Removes the format from the image.

Return: A reference to this ImageKit.

HPS.Publish.ImageKit UnsetSize ()

Removes the size from the image.

Return: A reference to this ImageKit.

Public Static Functions

bool operator!= (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b)

bool operator== (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b)