CmxImage

CmxImage class

The CMX image.

public class CmxImage : VectorMultipageImage, ICmxImage

Constructors

Name Description
CmxImage(StreamContainer, LoadOptions) Initializes a new instance of the CmxImage class.

Properties

Name Description
AutoAdjustPalette { get; set; } Gets or sets a value indicating whether automatic adjust palette.
virtual BackgroundColor { get; set; } Gets or sets a value for the background color.
override BitsPerPixel { get; } Gets the image bits per pixel count.
Bounds { get; } Gets the image bounds.
BufferSizeHint { get; set; } Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
CmxPage { get; } Gets the CMX page.
Container { get; } Gets the Image container.
DataStreamContainer { get; } Gets the object’s data stream.
Disposed { get; } Gets a value indicating whether this instance is disposed.
Document { get; } Gets the CMX document.
override FileFormat { get; } Gets a value of file format
virtual HasBackgroundColor { get; set; } Gets or sets a value indicating whether image has background color.
override Height { get; } Gets the image height.
override HeightF { get; } Gets the object height, in inches.
InterruptMonitor { get; set; } Gets or sets the interrupt monitor.
override IsCached { get; } Gets a value indicating whether object’s data is cached currently and no data reading is required.
override PageCount { get; } Gets the page count.
override PageExportingAction { get; set; } Gets or sets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.
override Pages { get; } Gets the pages.
Palette { get; set; } Gets or sets the color palette. The color palette is not used when pixels are represented directly.
Size { get; } Gets the image size.
SizeF { get; } Gets the object size, in inches.
virtual UsePalette { get; } Gets a value indicating whether the image palette is used.
override Width { get; } Gets the image width.
override WidthF { get; } Gets the object width, in inches.

Methods

Name Description
override CacheData() Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer.
CanSave(ImageOptionsBase) Determines whether image can be saved to the specified file format represented by the passed save options.
Dispose() Disposes the current instance.
override GetDefaultOptions(object[]) Gets the default options.
override GetEmbeddedImages() Gets the embedded images.
virtual GetOriginalOptions() Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the Save method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Save method as the second parameter.
Resize(int, int) Resizes the image. The default NearestNeighbourResample is used.
override Resize(int, int, ImageResizeSettings) Resizes the image.
override Resize(int, int, ResizeType) Resizes the image.
ResizeHeightProportionally(int) Resizes the height proportionally. The default NearestNeighbourResample is used.
virtual ResizeHeightProportionally(int, ImageResizeSettings) Resizes the height proportionally.
virtual ResizeHeightProportionally(int, ResizeType) Resizes the height proportionally.
ResizeWidthProportionally(int) Resizes the width proportionally. The default NearestNeighbourResample is used.
virtual ResizeWidthProportionally(int, ImageResizeSettings) Resizes the width proportionally.
virtual ResizeWidthProportionally(int, ResizeType) Resizes the width proportionally.
override RotateFlip(RotateFlipType) Rotates, flips, or rotates and flips the image.
Save() Saves the image data to the underlying stream.
Save(Stream) Saves the object’s data to the specified stream.
override Save(string) Saves the image to the specified file location.
Save(Stream, ImageOptionsBase) Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, bool) Saves the object’s data to the specified file location.
virtual Save(string, ImageOptionsBase) Saves the object’s data to the specified file location in the specified file format according to save options.
virtual Save(Stream, ImageOptionsBase, Rectangle) Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, ImageOptionsBase, Rectangle) Saves the object’s data to the specified file location in the specified file format according to save options.
override SetPalette(IColorPalette, bool) Sets the image palette.

Examples

The following example shows how to cache all pages of a CMX image.

[C#]

string dir = "c:\\temp\\";

// Load an image from a CMX file.
using (Aspose.Imaging.FileFormats.Cmx.CmxImage image = (Aspose.Imaging.FileFormats.Cmx.CmxImage)Aspose.Imaging.Image.Load(dir + "sample.cmx"))
{
    // This call caches only the default page.
    image.CacheData();

    // Cache all pages so that no additional data loading will be performed from the underlying data stream.
    foreach (Aspose.Imaging.FileFormats.Cmx.CmxImagePage page in image.Pages)
    {
        page.CacheData();
    }
}

See Also