GetImageRect(Int32,Int32,Int32,DecodingSettings,EventHandler<ProgressEventArgs>) Method (TiffPage)

In This Topic

Returns the rectangle image of this TIFF page if image data are non compressed (Compression == TiffCompression.None).

Syntax

'Declaration

Public Function GetImageRect( _
   ByVal leftTopRectangleIndexThe zero based index of left-top rectangle.
 As System.Int32, _
   ByVal rightBottomRectangleIndexThe zero based index of right-bottom rectangle.
 As System.Int32, _
   ByVal scaleScale factor.
 As System.Int32, _
   ByVal progressDelegateProgress delegate.
 As Vintasoft.Imaging.Codecs.Decoders.DecodingSettings, _
   ByVal decodingSettingsThe decoding settings that should be used for decoding of page image.
 As System.EventHandler(Of ProgressEventArgs) _
) As Vintasoft.Imaging.VintasoftImage

public Vintasoft.Imaging.VintasoftImage GetImageRect(
   System.Int32 leftTopRectangleIndex, 
   System.Int32 rightBottomRectangleIndex, 
   System.Int32 scale, 
   Vintasoft.Imaging.Codecs.Decoders.DecodingSettings progressDelegate, 
   System.EventHandler<ProgressEventArgs> decodingSettings
)

public: Vintasoft.Imaging.VintasoftImage* GetImageRect(
   System.Int32 leftTopRectangleIndex, 
   System.Int32 rightBottomRectangleIndex, 
   System.Int32 scale, 
   Vintasoft.Imaging.Codecs.Decoders.DecodingSettings* progressDelegate, 
   System.EventHandler<ProgressEventArgs*>* decodingSettings
)

public:
Vintasoft.Imaging.VintasoftImage^ GetImageRect(
   System.Int32 leftTopRectangleIndex, 
   System.Int32 rightBottomRectangleIndex, 
   System.Int32 scale, 
   Vintasoft.Imaging.Codecs.Decoders.DecodingSettings^ progressDelegate, 
   System.EventHandler<ProgressEventArgs^>^ decodingSettings
)

Parameters

leftTopRectangleIndex: The zero based index of left-top rectangle.
rightBottomRectangleIndex: The zero based index of right-bottom rectangle.
scale: Scale factor.
progressDelegate: Progress delegate.
decodingSettings: The decoding settings that should be used for decoding of page image.

Return Value

Image of rectangle of this TiffPage object if image was loaded successfully; otherwise, null.

Exceptions

Exception	Description
System.InvalidOperationException	Thrown if if SourceBitsPerPixel is not equal to BitsPerPixel.
System.ArgumentOutOfRangeException	Thrown if leftTopRectangleIndex is less than zero or greater than number of rectangles in image grid OR rightBottomRectangleIndex is less than zero or greater than number of rectangles in image grid.
TiffFileException	Thrown if error occurred while loading of image.

Remarks

This method is optimized for reading uncompressed data and can be used only when the GetStripGrid method returned not null value.

This method is working in current thread.

Requirements

Target Platforms: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

TiffPage Class
TiffPage Members

GetStripGrid
SourceBitsPerPixel
BitsPerPixel

Send Feedback