Class OdImage

Namespace: Aspose.Imaging.FileFormats.OpenDocument
Assembly: Aspose.Imaging.dll (25.7.0)

The open document

[JsonObject(MemberSerialization.OptIn)]
   public abstract class OdImage : VectorMultipageImage, IDisposable, IObjectWithBounds, IObjectWithSizeF, IMultipageImage
   {
   }

Inheritance

object ← DisposableObject ← DataStreamSupporter ← Image ← VectorImage ← VectorMultipageImage ← OdImage

Derived

OdgImage , OtgImage

Implements

IDisposable , IObjectWithBounds , IObjectWithSizeF , IMultipageImage

Inherited Members

VectorMultipageImage.CacheData() , VectorMultipageImage.Crop(Rectangle) , VectorMultipageImage.Resize(int, int, ResizeType) , VectorMultipageImage.Rotate(float) , VectorMultipageImage.Resize(int, int, ImageResizeSettings) , VectorMultipageImage.RotateFlip(RotateFlipType) , VectorMultipageImage.RemoveBackground(RemoveBackgroundSettings) , VectorMultipageImage.RemoveBackground() , VectorMultipageImage.SetPalette(IColorPalette, bool) , VectorMultipageImage.GetEmbeddedImages() , VectorMultipageImage.SaveData(Stream) , VectorMultipageImage.GetSerializedStream(ImageOptionsBase, Rectangle, out int) , VectorMultipageImage.ReleaseManagedResources() , VectorMultipageImage.PageCount , VectorMultipageImage.Pages , VectorMultipageImage.DefaultPage , VectorMultipageImage.IsCached , VectorMultipageImage.BitsPerPixel , VectorMultipageImage.Width , VectorMultipageImage.Height , VectorMultipageImage.PageExportingAction , VectorImage.GetDefaultOptions(object[]) , VectorImage.GetEmbeddedImages() , VectorImage.RemoveBackground() , VectorImage.RemoveBackground(RemoveBackgroundSettings) , VectorImage.Resize(int, int, ResizeType) , VectorImage.Resize(int, int, ImageResizeSettings) , VectorImage.RotateFlip(RotateFlipType) , VectorImage.Crop(Rectangle) , VectorImage.Rotate(float) , VectorImage.Modify(RectangleF, float, float, float) , VectorImage.ReleaseManagedResources() , VectorImage.SizeF , VectorImage.WidthF , VectorImage.HeightF , VectorImage.Width , VectorImage.Height , Image.CanLoad(string) , Image.CanLoad(string, LoadOptions) , Image.CanLoad(Stream) , Image.CanLoad(Stream, LoadOptions) , Image.Create(ImageOptionsBase, int, int) , Image.Create(Image[]) , Image.Create(MultipageCreateOptions) , Image.Create(string[], bool) , Image.Create(string[]) , Image.Create(Image[], bool) , Image.GetFileFormat(string) , Image.GetFileFormat(Stream) , Image.GetFittingRectangle(Rectangle, int, int) , Image.GetFittingRectangle(Rectangle, int[], int, int) , Image.Load(string, LoadOptions) , Image.Load(string) , Image.Load(Stream, LoadOptions) , Image.Load(Stream) , Image.GetProportionalWidth(int, int, int) , Image.GetProportionalHeight(int, int, int) , Image.RemoveMetadata() , Image.CanSave(ImageOptionsBase) , Image.Resize(int, int) , Image.Resize(int, int, ResizeType) , Image.Resize(int, int, ImageResizeSettings) , Image.GetDefaultOptions(object[]) , Image.GetOriginalOptions() , Image.ResizeWidthProportionally(int) , Image.ResizeHeightProportionally(int) , Image.ResizeWidthProportionally(int, ResizeType) , Image.ResizeHeightProportionally(int, ResizeType) , Image.ResizeWidthProportionally(int, ImageResizeSettings) , Image.ResizeHeightProportionally(int, ImageResizeSettings) , Image.RotateFlip(RotateFlipType) , Image.Rotate(float) , Image.Crop(Rectangle) , Image.Crop(int, int, int, int) , Image.Save() , Image.Save(string) , Image.Save(string, ImageOptionsBase) , Image.Save(string, ImageOptionsBase, Rectangle) , Image.Save(Stream, ImageOptionsBase) , Image.Save(Stream, ImageOptionsBase, Rectangle) , Image.GetSerializedStream(ImageOptionsBase, Rectangle, out int) , Image.SetPalette(IColorPalette, bool) , Image.UpdateContainer(Image) , Image.GetCanNotSaveMessage(ImageOptionsBase) , Image.GetFitRectangle(Rectangle) , Image.GetImage2Export(ImageOptionsBase, Rectangle, IImageExporter) , Image.GetFitRectangle(Rectangle, int[]) , Image.OnPaletteChanged(IColorPalette, IColorPalette) , Image.OnPaletteChanging(IColorPalette, IColorPalette) , Image.ReleaseManagedResources() , Image.BitsPerPixel , Image.Bounds , Image.Container , Image.Height , Image.Palette , Image.UsePalette , Image.Size , Image.Width , Image.InterruptMonitor , Image.BufferSizeHint , Image.AutoAdjustPalette , Image.HasBackgroundColor , Image.FileFormat , Image.BackgroundColor , DataStreamSupporter.timeout , DataStreamSupporter.CacheData() , DataStreamSupporter.Save() , DataStreamSupporter.Save(Stream) , DataStreamSupporter.Save(string) , DataStreamSupporter.Save(string, bool) , DataStreamSupporter.SaveData(Stream) , DataStreamSupporter.ReleaseManagedResources() , DataStreamSupporter.OnDataStreamContainerChanging(StreamContainer) , DataStreamSupporter.DataStreamContainer , DataStreamSupporter.IsCached , DisposableObject.Dispose() , DisposableObject.ReleaseManagedResources() , DisposableObject.ReleaseUnmanagedResources() , DisposableObject.VerifyNotDisposed() , DisposableObject.Disposed , object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Constructors

OdImage(StreamContainer, LoadOptions)

Initialize a new Aspose.Imaging.FileFormats.OpenDocument.OdImage object by providing a stream container alongwith load options, facilitating seamless integration into software applications. Thisconstructor efficiently handle image data, offering flexibility and control over theloading process.

public OdImage(StreamContainer streamContainer, LoadOptions options)
   {
   }

Parameters

streamContainer StreamContainer

The stream.

options LoadOptions

The load options.

OdImage(StreamContainer)

Creates a new instance of the Aspose.Imaging.FileFormats.OpenDocument.OdImage class, designed specifically forinitialization with a stream container. This constructor enables seamless integrationwith stream-based data sources, facilitating efficient handling of OdImage instanceswithin software systems.

public OdImage(StreamContainer streamContainer)
   {
   }

Parameters

streamContainer StreamContainer

The stream container.

Properties

BitsPerPixel

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

public override int BitsPerPixel
   {
      get;
   }

Property Value

int

Exceptions

NotImplementedException

The not implemented this property

DefaultPage

Retrieves the default page associated with the image, providing essential access tothe primary page within the image collection. This property streamlines navigationand manipulation of image data, enhancing the efficiency of software developmentworkflows.

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

Property Value

Image

IsCached

Obtains a boolean value indicating whether the data of the object is currentlycached, thus eliminating the need for data reading. This property serves as anoptimization indicator, enhancing performance by minimizing redundant data accessoperation.

public override bool IsCached
{
    get;
}

Property Value

bool

Exceptions

NotImplementedException

The not implemented this method

Metadata

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

public OdMetadata Metadata
   {
      get;
   }

Property Value

OdMetadata

PageCount

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

public override int PageCount
   {
      get;
   }

Property Value

int

Records

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

public OdObject[] Records
   {
      get;
   }

Property Value

OdObject []

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()
   {
   }