Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Public Member Functions | Static Public Member Functions | Properties | List of all members
SolidFramework.Imaging.Image Class Reference

Represents Image More...

Inheritance diagram for SolidFramework.Imaging.Image:

Public Member Functions

virtual void Dispose ()
 
global::System.Drawing.Color GetPaletteColor (int i)
 Gets the color of the palette. More...
 
global::System.Drawing.Color GetPixelColor (int x, int y)
 Gets the color of the pixel. More...
 
void GetAngles ()
 Gets the autorotate and deskew angles for the image. More...
 
SolidFramework.Imaging.ImagesCollection GetComponentImages ()
 Gets the component images. More...
 
SolidFramework.Imaging.ImagesCollection GetComponentImages (SolidFramework.Imaging.Plumbing.ImageCompression compression)
 Gets the component images. More...
 
SolidFramework.Imaging.ImagesCollection GetComponentImages (SolidFramework.Imaging.Plumbing.ImageCompression compression, SolidFramework.Imaging.Plumbing.ImageComponents components)
 Gets the component images. More...
 
SolidFramework.Imaging.ImagesCollection GetComponentImages (SolidFramework.Imaging.Plumbing.ImageCompression compression, SolidFramework.Imaging.Plumbing.ImageComponents components, SolidFramework.Imaging.Plumbing.ImageComponentOrder imageOrder)
 Gets the component images. More...
 
global::System.Drawing.Bitmap ToBitmap ()
 Converts to System.Drawing.Bitmap More...
 
string ToDataURI (SolidFramework.Converters.Plumbing.ImageDocumentType format)
 
string ToDataURI ()
 
bool Equals (SolidFramework.Imaging.Image other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static SolidFramework.Imaging.Image Create (global::System.IntPtr native_image, SolidFramework.Pdf.Plumbing.PageStatistics statistics)
 Creates from the specified path. More...
 
static SolidFramework.Imaging.Image Create (string path)
 
static bool operator== (SolidFramework.Imaging.Image obj1, SolidFramework.Imaging.Image obj2)
 
static bool operator!= (SolidFramework.Imaging.Image obj1, SolidFramework.Imaging.Image obj2)
 

Properties

string Name [getset]
 
SolidFramework.Pdf.Plumbing.PageStatistics PageStatistics [get]
 
SolidFramework.Imaging.ImageEncoder ImageEncoder [get]
 Gets the image encoder.
 
SolidFramework.Imaging.ImageType ImageType [get]
 Gets the type of the image. More...
 
byte DCTCompressionQuality [get]
 Gets a value indicating the quality of lossy compression to use. More...
 
int BitsPerComponent [get]
 Gets the bits per component.
 
int TransparentIndex [get]
 index in a palette image of transparent color (-1 means no transparent color)
 
int HeightProcessed [get]
 Gets the height processed.
 
int WidthProcessed [get]
 Gets the width processed.
 
int DpiProcessed [get]
 Gets the dpi processed.
 
bool IsUnderlineComponent [get]
 Gets a value indicating whether this instance is underline component. More...
 
bool IsRectangleComponent [get]
 Gets a value indicating whether this instance is rectangle component. More...
 
bool IsInverseComponent [get]
 Gets a value indicating whether this instance is inverse component. More...
 
bool UsesDCTCompression [get]
 Gets a value indicating whether this instance is lossy. More...
 
bool IsVectorComponent [get]
 Gets a value indicating whether this instance is vector component. More...
 
bool IsImageComponent [get]
 Gets a value indicating whether this instance is image component. More...
 
bool IsTextBackground [get]
 Gets a value indicating whether this instance is text background. More...
 
bool IsTextComponent [get]
 Gets a value indicating whether this instance is text component. More...
 
bool IsPaletteUsed [get]
 Gets a value indicating whether this instance is palette used. More...
 
bool IsNeedingOCR [get]
 Gets a value indicating whether this instance is needing OCR. More...
 
bool IsAlphaUsed [get]
 Gets a value indicating whether this instance is alpha channel used. More...
 
double WasAutoRotated [get]
 Gets the auto rotate angle (non-zero if the image needed to be rotated)
 
double WasDeskewed [get]
 Gets the deskew angle (non-zero if the image needed to be deskewed)
 
int PaletteSize [get]
 Gets the number of entries in the current palette. More...
 
int Height [get]
 Gets the height.
 
int TextAngle [get]
 Gets a value indicating whether this instance ortho rotated text More...
 
SolidFramework.Imaging.Plumbing.TextLanguage TextLanguage [get]
 Gets a value indicating whether this instance was detected as CJK text. More...
 
int Width [get]
 Gets the width.
 
int DpiX [get]
 Gets the dpi X co-ordinates.
 
int DpiY [get]
 Gets the dpi Y co-ordinates.
 
int Dx [get]
 Gets the delta x co-ordinates.
 
int Dy [get]
 Gets the delta y co-ordinates.
 

Detailed Description

Represents Image

Member Function Documentation

◆ Create()

static SolidFramework.Imaging.Image SolidFramework.Imaging.Image.Create ( global::System.IntPtr  native_image,
SolidFramework.Pdf.Plumbing.PageStatistics  statistics 
)
static

Creates from the specified path.

Returns

◆ GetAngles()

void SolidFramework.Imaging.Image.GetAngles ( )

Gets the autorotate and deskew angles for the image.

Returns
Nothing. Properties WasaAutoRotated and WasDeskewed are valid after this call.

◆ GetComponentImages() [1/4]

SolidFramework.Imaging.ImagesCollection SolidFramework.Imaging.Image.GetComponentImages ( )

Gets the component images.

Returns
The component images.

◆ GetComponentImages() [2/4]

SolidFramework.Imaging.ImagesCollection SolidFramework.Imaging.Image.GetComponentImages ( SolidFramework.Imaging.Plumbing.ImageCompression  compression)

Gets the component images.

Parameters
compressionThe compression.
Returns
The component images.

◆ GetComponentImages() [3/4]

Gets the component images.

Parameters
compressionThe compression.
componentsThe components.
Returns
The component images.

◆ GetComponentImages() [4/4]

Gets the component images.

Parameters
compressionThe compression.
componentsThe components.
imageOrderThe image order.
Returns
The component images.

◆ GetPaletteColor()

global.System.Drawing.Color SolidFramework.Imaging.Image.GetPaletteColor ( int  i)

Gets the color of the palette.

Returns
Exceptions
System.InvalidOperationException

◆ GetPixelColor()

global.System.Drawing.Color SolidFramework.Imaging.Image.GetPixelColor ( int  x,
int  y 
)

Gets the color of the pixel.

Returns
Exceptions
System.InvalidOperationException

◆ ToBitmap()

global.System.Drawing.Bitmap SolidFramework.Imaging.Image.ToBitmap ( )

Converts to System.Drawing.Bitmap

Returns

Property Documentation

◆ DCTCompressionQuality

byte SolidFramework.Imaging.Image.DCTCompressionQuality
get

Gets a value indicating the quality of lossy compression to use.

true if this instance is lossy; otherwise, false.

◆ ImageType

SolidFramework.Imaging.ImageType SolidFramework.Imaging.Image.ImageType
get

Gets the type of the image.

The type of the image.

◆ IsAlphaUsed

bool SolidFramework.Imaging.Image.IsAlphaUsed
get

Gets a value indicating whether this instance is alpha channel used.

true if this instance is alpha channel used; otherwise, false.

◆ IsImageComponent

bool SolidFramework.Imaging.Image.IsImageComponent
get

Gets a value indicating whether this instance is image component.

true if this instance is image component; otherwise, false.

◆ IsInverseComponent

bool SolidFramework.Imaging.Image.IsInverseComponent
get

Gets a value indicating whether this instance is inverse component.

true if this instance is inverse component; otherwise, false.

◆ IsNeedingOCR

bool SolidFramework.Imaging.Image.IsNeedingOCR
get

Gets a value indicating whether this instance is needing OCR.

true if this instance is needing OCR; otherwise, false.

◆ IsPaletteUsed

bool SolidFramework.Imaging.Image.IsPaletteUsed
get

Gets a value indicating whether this instance is palette used.

true if this instance is palette used; otherwise, false.

◆ IsRectangleComponent

bool SolidFramework.Imaging.Image.IsRectangleComponent
get

Gets a value indicating whether this instance is rectangle component.

true if this instance is rectangle component; otherwise, false.

◆ IsTextBackground

bool SolidFramework.Imaging.Image.IsTextBackground
get

Gets a value indicating whether this instance is text background.

true if this instance is text background; otherwise, false.

◆ IsTextComponent

bool SolidFramework.Imaging.Image.IsTextComponent
get

Gets a value indicating whether this instance is text component.

true if this instance is text component; otherwise, false.

◆ IsUnderlineComponent

bool SolidFramework.Imaging.Image.IsUnderlineComponent
get

Gets a value indicating whether this instance is underline component.

true if this instance is underline component; otherwise, false.

◆ IsVectorComponent

bool SolidFramework.Imaging.Image.IsVectorComponent
get

Gets a value indicating whether this instance is vector component.

true if this instance is vector component; otherwise, false.

◆ PaletteSize

int SolidFramework.Imaging.Image.PaletteSize
get

Gets the number of entries in the current palette.

true if this instance is palette used; otherwise, false.

◆ TextAngle

int SolidFramework.Imaging.Image.TextAngle
get

Gets a value indicating whether this instance ortho rotated text

0, 90 or -90 if rotated, 0 if not.

◆ TextLanguage

SolidFramework.Imaging.Plumbing.TextLanguage SolidFramework.Imaging.Image.TextLanguage
get

Gets a value indicating whether this instance was detected as CJK text.

Bit flagged value if CJK, 0 if not.

◆ UsesDCTCompression

bool SolidFramework.Imaging.Image.UsesDCTCompression
get

Gets a value indicating whether this instance is lossy.

true if this instance is lossy; otherwise, false.