Aspose::Pdf::XImage class

XImage class

Class representing image X-Object.

class XImage : public System::Object

Methods

MethodDescription
AddStencilMask(System::SharedPtr<System::IO::Stream>)Adds a stencil mask to the XImage.
static DetectColorType(System::SharedPtr<System::Drawing::Bitmap>)Returns color type of image.
get_ContainsTransparency()If the image contains transparancy than return true; otherwise, false.
get_FilterType()Gets image filter type.
get_Grayscaled()Gets grayscaled version of image.
get_Height()Gets height of the image.
get_ImageMask()Gets a flag indicating whether the image shall be treated as an image mask (see 8.9.6, “Masked Images”). If this flag is true, the value of BitsPerComponent shall be 1 and Mask and ColorSpace shall not be specified; unmasked areas shall bepainted using the current nonstroking colour. Default value: false.
get_Metadata()Metadata of the image.
get_Name()Gets image name. Please note that if you change name of the image which has references in page contents, document may became incorrect. Please use XImage.Rename method in this case.
get_Width()Gets width of the image.
GetColorType()Returns color type of image.
GetNameInCollection()Returns the name of the image in its collection.
IsTheSameObject(System::SharedPtr<Aspose::Pdf::XImage>)Returns true if both images references to the same object.
Rename(System::String)Renames image and replaces all references to the image with the new name.
Save(System::SharedPtr<System::IO::Stream>)Saves image data into stream as JPEG image.
Save(System::SharedPtr<System::IO::Stream>, System::SharedPtr<System::Drawing::Imaging::ImageFormat>)Saves image into stream with requested format.
Save(System::SharedPtr<System::IO::Stream>, int32_t)Saves image data into stream as JPEG image with specified resolution.
Save(System::SharedPtr<System::IO::Stream>, System::SharedPtr<System::Drawing::Imaging::ImageFormat>, int32_t)Saves image into stream with requested format with specified resolution.
set_Name(System::String)Sets image name. Please note that if you change name of the image which has references in page contents, document may became incorrect. Please use XImage.Rename method in this case.
ToStream()Returns the original image stream.

See Also