CmxImage Class
The CMX image.
Inheritance Hierarchy

Namespace: Aspose.Imaging.FileFormats.Cmx
Assembly: Aspose.Imaging (in Aspose.Imaging.dll) Version: 21.05
Syntax
public class CmxImage : VectorMultipageImage, ICmxImage, 
	IObjectWithSizeF

The CmxImage type exposes the following members.

Constructors
  NameDescription
Public methodCmxImage
Initializes a new instance of the CmxImage class.
Properties
  NameDescription
Public propertyAutoAdjustPalette
Gets or sets a value indicating whether automatic adjust palette.
(Inherited from Image.)
Public propertyBackgroundColor
Gets or sets a value for the background color.
(Inherited from Image.)
Public propertyBitsPerPixel
Gets the image bits per pixel count.
(Overrides VectorMultipageImageBitsPerPixel.)
Public propertyBounds
Gets the image bounds.
(Inherited from Image.)
Public propertyBufferSizeHint
Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
(Inherited from Image.)
Public propertyCmxPage
Gets the CMX page.
Public propertyContainer
Gets the Image container.
(Inherited from Image.)
Public propertyDataStreamContainer
Gets the object's data stream.
(Inherited from DataStreamSupporter.)
Public propertyDefaultPage Obsolete.
Gets the default page.
(Overrides VectorMultipageImageDefaultPage.)
Public propertyDisposed
Gets a value indicating whether this instance is disposed.
(Inherited from DisposableObject.)
Public propertyDocument
Gets the CMX document.
Public propertyFileFormat
Gets a value of file format
(Overrides ImageFileFormat.)
Public propertyHasBackgroundColor
Gets or sets a value indicating whether image has background color.
(Inherited from Image.)
Public propertyHeight
Gets the image height.
(Inherited from VectorMultipageImage.)
Public propertyHeightF
Gets the object height, in inches.
(Overrides VectorImageHeightF.)
Public propertyInterruptMonitor
Gets or sets the interrupt monitor.
(Inherited from Image.)
Public propertyIsCached
Gets a value indicating whether object's data is cached currently and no data reading is required.
(Overrides VectorMultipageImageIsCached.)
Public propertyPageCount
Gets the page count.
(Overrides VectorMultipageImagePageCount.)
Public propertyPageExportingAction
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.
(Overrides VectorMultipageImagePageExportingAction.)
Public propertyCode examplePages
Gets the pages.
(Overrides VectorMultipageImagePages.)
Public propertyPalette
Gets or sets the color palette. The color palette is not used when pixels are represented directly.
(Inherited from Image.)
Public propertyCode exampleSize
Gets the image size.
(Inherited from Image.)
Public propertySizeF
Gets the object size, in inches.
(Inherited from VectorImage.)
Public propertyCode exampleUsePalette
Gets a value indicating whether the image palette is used.
(Inherited from Image.)
Public propertyWidth
Gets the image width.
(Inherited from VectorMultipageImage.)
Public propertyWidthF
Gets the object width, in inches.
(Overrides VectorImageWidthF.)
Methods
  NameDescription
Public methodCode exampleCacheData
Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer.
(Overrides VectorMultipageImageCacheData.)
Public methodCode exampleCanSave
Determines whether image can be saved to the specified file format represented by the passed save options.
(Inherited from Image.)
Public methodCode exampleDispose
Disposes the current instance.
(Inherited from DisposableObject.)
Protected methodDoAfterSave
Does the after save.
(Inherited from DataStreamSupporter.)
Protected methodDoUseRecursion
Gets value indicating whether use recursion for synchronization.
(Inherited from Image.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (Inherited from DisposableObject.)
Protected methodGetCanNotSaveMessage
Gets the can not save message.
(Inherited from Image.)
Public methodGetDefaultOptions
Gets the default options.
(Overrides ImageGetDefaultOptions(Object).)
Protected methodGetFitRectangle(Rectangle)
Gets rectangle which fits the current image.
(Inherited from Image.)
Protected methodGetFitRectangle(Rectangle, Int32)
Gets rectangle which fits the current bitmap taking into account the pixels passed. The passed pixels array count should be equal to the fitting rectangle size.
(Inherited from Image.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetImage2Export
Gets the image to export.
(Inherited from Image.)
Public methodGetOriginalOptions
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(String) 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(String, ImageOptionsBase) method as the second parameter.
(Inherited from Image.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDataStreamContainerChanging
Called when data stream container is changing.
(Inherited from DataStreamSupporter.)
Protected methodOnPaletteChanged
Called when palette is changed.
(Inherited from Image.)
Protected methodOnPaletteChanging
Called when palette is changing.
(Inherited from Image.)
Protected methodReleaseManagedResources
Releases the managed resources. Make sure no unmanaged resources are released here, since they may have been already released.
(Overrides ImageReleaseManagedResources.)
Protected methodReleaseUnmanagedResources
Releases the unmanaged resources. Make sure no managed resources are released here, since they may have been already released.
(Inherited from DisposableObject.)
Public methodCode exampleResize(Int32, Int32)
Resizes the image. The default LeftTopToLeftTop is used.
(Inherited from Image.)
Public methodResize(Int32, Int32, ImageResizeSettings)
Resizes the image.
(Overrides VectorMultipageImageResize(Int32, Int32, ImageResizeSettings).)
Public methodResize(Int32, Int32, ResizeType)
Resizes the image.
(Overrides VectorMultipageImageResize(Int32, Int32, ResizeType).)
Public methodResizeHeightProportionally(Int32)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeHeightProportionally(Int32, ImageResizeSettings)
Resizes the height proportionally.
(Inherited from Image.)
Public methodCode exampleResizeHeightProportionally(Int32, ResizeType)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32)
Resizes the width proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32, ImageResizeSettings)
Resizes the width proportionally.
(Inherited from Image.)
Public methodCode exampleResizeWidthProportionally(Int32, ResizeType)
Resizes the width proportionally.
(Inherited from Image.)
Public methodRotateFlip
Rotates, flips, or rotates and flips the image.
(Overrides VectorMultipageImageRotateFlip(RotateFlipType).)
Public methodCode exampleSave
Saves the image data to the underlying stream.
(Inherited from Image.)
Public methodSave(Stream)
Saves the object's data to the specified stream.
(Inherited from DataStreamSupporter.)
Public methodSave(String)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodSave(String, Boolean)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodCode exampleSave(Stream, ImageOptionsBase)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(Stream, ImageOptionsBase, Rectangle)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase, Rectangle)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Protected methodSaveData
Saves the data.
(Overrides VectorMultipageImageSaveData(Stream).)
Public methodSetPalette
Sets the image palette.
(Overrides VectorMultipageImageSetPalette(IColorPalette, Boolean).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyNotDisposed
Verifies that the current instance is not disposed.
(Inherited from DisposableObject.)
Fields
  NameDescription
Protected fieldTimeout
The timeout to wait for synchronization
(Inherited from DataStreamSupporter.)
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