Table of Contents

Class OdImage

Namespace
Aspose.Imaging.FileFormats.OpenDocument
Assembly
Aspose.Imaging.dll

The open document

public abstract class OdImage : VectorMultipageImage, IDisposable, IObjectWithBounds, IObjectWithSizeF, IMultipageImage
Inheritance
OdImage
Implements
Derived
Inherited Members

Constructors

OdImage(StreamContainer)

Creates a new instance of the OdImage class, designed specifically for initialization with a stream container. This constructor enables seamless integration with stream-based data sources, facilitating efficient handling of OdImage instances within software systems.

public OdImage(StreamContainer streamContainer)

Parameters

streamContainer StreamContainer

The stream container.

OdImage(StreamContainer, LoadOptions)

Initialize a new OdImage object by providing a stream container along with load options, facilitating seamless integration into software applications. This constructor efficiently handle image data, offering flexibility and control over the loading process.

public OdImage(StreamContainer streamContainer, LoadOptions options)

Parameters

streamContainer StreamContainer

The stream.

options LoadOptions

The load options.

Properties

BitsPerPixel

Retrieves the count of bits per pixel for the image. This property provides insight into the level of detail and color depth represented in the image, aiding in various image processing tasks and optimizations.

public override int BitsPerPixel { get; }

Property Value

int

The image bits per pixel count.

Exceptions

NotImplementedException

The not implemented this property

DefaultPage

Retrieves the default page associated with the image, providing essential access to the primary page within the image collection. This property streamlines navigation and manipulation of image data, enhancing the efficiency of software development workflows.

[Obsolete("Please use Pages[n]")]
public override Image DefaultPage { get; }

Property Value

Image

The default page.

Height

Returns the height of the image, denoting the vertical dimension in pixels. This property is crucial for understanding the image's overall size and proportions, facilitating accurate display and processing of image content.

public override int Height { get; }

Property Value

int

The image height.

IsCached

Obtains a boolean value indicating whether the data of the object is currently cached, thus eliminating the need for data reading. This property serves as an optimization indicator, enhancing performance by minimizing redundant data access operation.

public override bool IsCached { get; }

Property Value

bool

true if object's data is cached; otherwise, false.

Exceptions

NotImplementedException

The not implemented this method

Metadata

Retrieves metadata specific to OpenDocument files. This property allows access to essential information embedded within OD files, facilitating various operations such as extraction, modification, or analysis of metadata.

public OdMetadata Metadata { get; }

Property Value

OdMetadata

The metadata.

PageCount

Retrieves the total count of pages within the image. This property is essential for applications managing multi-page images, enabling them to accurately determine the number of pages available for processing or display.

public override int PageCount { get; }

Property Value

int

The page count.

Records

Retrieves the OpenDocument records stored within the image. This property grants access to specific structured data elements embedded within OpenDocument files, facilitating retrieval or manipulation of relevant information for further processing or analysis.

public OdObject[] Records { get; }

Property Value

OdObject[]

The records.

Width

Retrieves the width of the image, indicating the horizontal dimension in pixels. This property provides essential information about the image's size, enabling precise rendering, manipulation, and analysis of image data.

public override int Width { get; }

Property Value

int

The image width.

Methods

ReleaseManagedResources()

Releases the managed resources. Make sure no unmanaged resources are released here, since they may have been already released.

protected override void ReleaseManagedResources()

Resize(int, int, ImageResizeSettings)

Adjusts the dimensions of the image according to specified width, height, and resize settings. This method provides flexibility in resizing images while maintaining desired proportions and adhering to defined resize configurations, ensuring accurate adjustment of image dimensions to meet specific requirements or display criteria.

public override void Resize(int newWidth, int newHeight, ImageResizeSettings settings)

Parameters

newWidth int

The new width.

newHeight int

The new height.

settings ImageResizeSettings

The resize settings.

Resize(int, int, ResizeType)

This method resizes the image, adjusting both width and height based on the specified dimensions and resize type. It offers a comprehensive approach to resizing, allowing for precise adjustments while maintaining image quality and integrity. By incorporating the resize type parameter, users can choose from various resizing algorithms or methods to achieve optimal results for different use cases or preferences.

public override void Resize(int newWidth, int newHeight, ResizeType resizeType)

Parameters

newWidth int

The new width.

newHeight int

The new height.

resizeType ResizeType

The resize type.

RotateFlip(RotateFlipType)

This method provides functionality to rotate, flip, or perform both operations simultaneously on the image. It allows users to manipulate the orientation of the image according to their specific requirements. With support for rotation angles and flip directions, it offers flexibility in transforming the image to desired orientations or orientations.

public override void RotateFlip(RotateFlipType rotateFlipType)

Parameters

rotateFlipType RotateFlipType

Type of the rotate flip.