DjvuImage

DjvuImage class

DjvuDocument class

public sealed class DjvuImage : RasterCachedMultipageImage, INotifyPropertyChanged

Constructors

Name Description
DjvuImage(Stream) Initializes a new instance of the DjvuImage class.
DjvuImage(Stream, LoadOptions) Initializes a new instance of the DjvuImage class.

Properties

Name Description
ActivePage { get; set; } Gets or sets the currently active page
AutoAdjustPalette { get; set; } Gets or sets a value indicating whether automatic adjust palette.
override 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.
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.
DjvuPages { get; } Gets the pages for the document
override FileFormat { get; } Gets a value of file format
FirstPage { get; } Gets the first page of the document
override HasAlpha { get; } Gets the Has alpha channel.
virtual HasBackgroundColor { get; set; } Gets or sets a value indicating whether image has background color.
override HasTransparentColor { get; } Gets a value indicating whether image has transparent color.
override Height { get; } Gets the image height.
virtual HorizontalResolution { get; set; } Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage.
Identifier { get; } Gets the unique identifier for the document
override ImageOpacity { get; } Gets opacity of this image.
InterruptMonitor { get; set; } Gets or sets the interrupt monitor.
IsCached { get; } Gets a value indicating whether image data is cached currently.
IsRawDataAvailable { get; } Gets a value indicating whether raw data loading is available.
LastPage { get; } Gets the last page of the document
NextPage { get; } Gets the next page of the document
override PageCount { get; } Gets the page count.
virtual 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.
virtual PremultiplyComponents { get; set; } Gets or sets a value indicating whether the image components must be premultiplied.
PreviousPage { get; } Gets the previous page of the document
RawCustomColorConverter { get; set; } Gets or sets the custom color converter
virtual RawDataFormat { get; } Gets the raw data format.
RawDataSettings { get; } Gets the current raw data settings. Note when using these settings the data loads without conversion.
RawFallbackIndex { get; set; } Gets or sets the fallback index to use when palette index is out of bounds
RawIndexedColorConverter { get; set; } Gets or sets the indexed color converter
virtual RawLineSize { get; } Gets the raw line size in bytes.
Size { get; } Gets the image size.
virtual TransparentColor { get; set; } Gets the image transparent color.
virtual UpdateXmpData { get; set; } Gets or sets a value indicating whether to update the XMP metadata.
override UsePalette { get; } Gets a value indicating whether the image palette is used.
virtual UseRawData { get; set; } Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
virtual VerticalResolution { get; set; } Gets or sets the vertical resolution, in pixels per inch, of this RasterImage.
override Width { get; } Gets the image width.
override XmpData { get; set; } Gets or sets XMP data from frame.

Methods

Name Description
static LoadDocument(Stream) Loads the document.
static LoadDocument(Stream, LoadOptions) Loads the document.
override AdjustBrightness(int) Adjust of a brightness for image.
override AdjustContrast(float) Image contrasting
override AdjustGamma(float) Gamma-correction of an image.
override AdjustGamma(float, float, float) Gamma-correction of an image.
override BinarizeBradley(double) Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeBradley(double, int) Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeFixed(byte) Binarization of an image with predefined threshold
override BinarizeOtsu() Binarization of an image with Otsu thresholding
override CacheData() Caches the data private.
CanSave(ImageOptionsBase) Determines whether image can be saved to the specified file format represented by the passed save options.
override Crop(Rectangle) Cropping the image.
override Crop(int, int, int, int) Crop image with shifts.
Dispose() Disposes the current instance.
Dither(DitheringMethod, int) Performs dithering on the current image.
override Dither(DitheringMethod, int, IColorPalette) Performs dithering on the current image.
override Filter(Rectangle, FilterOptionsBase) Filters the specified rectangle.
GetArgb32Pixel(int, int) Gets an image 32-bit ARGB pixel.
GetDefaultArgb32Pixels(Rectangle) Gets the default 32-bit ARGB pixels array.
virtual GetDefaultOptions(object[]) Gets the default options.
GetDefaultPixels(Rectangle, IPartialArgb32PixelLoader) Gets the default pixels array using partial pixel loader.
GetDefaultRawData(Rectangle, RawDataSettings) Gets the default raw data array.
GetDefaultRawData(Rectangle, IPartialRawDataLoader, RawDataSettings) Gets the default raw data array using partial pixel loader.
virtual GetModifyDate(bool) Gets the date and time the resource image was last modified.
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.
GetPixel(int, int) Gets an image pixel.
GetSkewAngle() Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning.
override Grayscale() Transformation of an image to its grayscale representation
LoadArgb32Pixels(Rectangle) Loads 32-bit ARGB pixels.
LoadArgb64Pixels(Rectangle) Loads 64-bit ARGB pixels.
LoadCmyk32Pixels(Rectangle) Loads pixels in CMYK format.
LoadPartialArgb32Pixels(Rectangle, IPartialArgb32PixelLoader) Loads 32-bit ARGB pixels partially by packs.
LoadPartialPixels(Rectangle, IPartialPixelLoader) Loads pixels partially by packs.
LoadPixels(Rectangle) Loads pixels.
LoadRawData(Rectangle, RawDataSettings, IPartialRawDataLoader) Loads raw data.
LoadRawData(Rectangle, Rectangle, RawDataSettings, IPartialRawDataLoader) Loads raw data.
NormalizeAngle() Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate methods.
override NormalizeAngle(bool, Color) Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses !:GetSkewAngle and Rotate methods.
ReadArgb32ScanLine(int) Reads the whole scan line by the specified scan line index.
ReadScanLine(int) Reads the whole scan line by the specified scan line index.
ReplaceColor(Color, byte, Color) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
override ReplaceColor(int, byte, int) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
ReplaceNonTransparentColors(Color) Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
override ReplaceNonTransparentColors(int) Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
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.
override ResizeHeightProportionally(int, ResizeType) Resizes the width proportionally.
ResizeWidthProportionally(int) Resizes the width proportionally. The default NearestNeighbourResample is used.
virtual ResizeWidthProportionally(int, ImageResizeSettings) Resizes the width proportionally.
override ResizeWidthProportionally(int, ResizeType) Resizes the width proportionally.
virtual Rotate(float) Rotate image around the center.
override Rotate(float, bool, Color) !:RasterCahcedMultipageImage.Rotate image around the center.
override RotateFlip(RotateFlipType) Rotates, flips, or rotates and flips the Active frame only.
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.
override 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.
SaveArgb32Pixels(Rectangle, int[]) Saves the 32-bit ARGB pixels.
SaveCmyk32Pixels(Rectangle, int[]) Saves the pixels.
SavePixels(Rectangle, Color[]) Saves the pixels.
SaveRawData(byte[], int, Rectangle, RawDataSettings) Saves the raw data.
SetArgb32Pixel(int, int, int) Sets an image 32-bit ARGB pixel for the specified position.
override SetPalette(IColorPalette, bool) Sets the image palette.
SetPixel(int, int, Color) Sets an image pixel for the specified position.
virtual SetResolution(double, double) Sets the resolution for this RasterImage.
virtual ToBitmap() Converts raster image to the bitmap.
WriteArgb32ScanLine(int, int[]) Writes the whole scan line to the specified scan line index.
WriteScanLine(int, Color[]) Writes the whole scan line to the specified scan line index.

Examples

This example shows how to load a DJVU image from a file stream.

[C#]

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

// Load a DJVU image from a file stream.
using (System.IO.Stream stream = System.IO.File.OpenRead(dir + "sample.djvu"))
{
    using (Aspose.Imaging.FileFormats.Djvu.DjvuImage djvuImage = new Aspose.Imaging.FileFormats.Djvu.DjvuImage(stream))
    {
        // Save each page as an individual PNG image.
        foreach (Aspose.Imaging.FileFormats.Djvu.DjvuPage djvuPage in djvuImage.Pages)
        {
            // Generate a file name based on the page number.
            string fileName = string.Format("sample.{0}.png", djvuPage.PageNumber);
            djvuPage.Save(dir + fileName, new Aspose.Imaging.ImageOptions.PngOptions());
        }
    }
}

See Also