RasterRenderer Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Represents PDF to raster image renderer.
Inheritance Hierarchy
Bytescout.PDFRendererBaseRenderer
Bytescout.PDFRendererRasterRenderer
Namespace:Bytescout.PDFRenderer
Assembly: Bytescout.PDFRenderer (in Bytescout.PDFRenderer.dll) Version: 13.4.0.4759-master
Syntax
public class RasterRenderer : BaseRenderer, IRasterRenderer, IBaseRenderer, IDisposable
The RasterRenderer type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | RasterRenderer | Initializes a new instance of the RasterRenderer class. |
| RasterRenderer(String, String) | Initializes a new instance of the RasterRenderer class. |
Properties
| Name | Description | |
|---|---|---|
 | ExtractionArea | Sets the extraction area by coordinates and dimensions. (Inherited from BaseRenderer.) |
| ExtractionAreaRect | Sets the extraction area by rectangle. (Inherited from BaseRenderer.) |
| LicenseInfo | Gets license information. (Inherited from BaseRenderer.) |
| Password | PDF document owner password. (Inherited from BaseRenderer.) |
| Profiles | Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded. (Inherited from BaseRenderer.) |
| RegistrationKey | Registration key. (Inherited from BaseRenderer.) |
| RegistrationName | Registration name. (Inherited from BaseRenderer.) |
| Version | Gets the component version number. (Inherited from BaseRenderer.) |
Methods
| Name | Description | |
|---|---|---|
| CreateProfile(String, RenderingOptions, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. (Inherited from BaseRenderer.) |
| CreateProfile(String, String, RenderingOptions, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. (Inherited from BaseRenderer.) |
| Dispose | Releases the unmanaged resources used by the instance and optionally releases the managed resources. (Inherited from BaseRenderer.) |
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| FireParsingError | (Inherited from BaseRenderer.) |
| FireProgressChanged | (Inherited from BaseRenderer.) |
| GetHashCode | (Inherited from Object.) |
| GetImage(Int32, Single) | Renders PDF document page to Image object. |
| GetImage(Int32, Int32, Int32) | Renders PDF document page to Image object. |
| GetImage(Int32, Single, RenderingOptions) | Renders PDF document page to Image object. |
| GetImage(Int32, Int32, Int32, RenderingOptions) | Renders PDF document page to Image object. |
| GetPageCount | Returns document page count. (Inherited from BaseRenderer.) |
| GetPageRect_Height | Gets the specified page height. (Inherited from BaseRenderer.) |
| GetPageRect_Left | Gets the specified page left coordinate. (Inherited from BaseRenderer.) |
| GetPageRect_Top | Gets the specified page top coordinate. (Inherited from BaseRenderer.) |
| GetPageRect_Width | Gets the specified page width. (Inherited from BaseRenderer.) |
| GetPageRectangle(Int32) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseRenderer.) |
| GetPageRectangle(Int32, Boolean) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseRenderer.) |
| GetType | (Inherited from Object.) |
| LoadAndApplyProfiles | Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction. (Inherited from BaseRenderer.) |
| LoadDocumentFromFile | Loads PDF document from specified file. (Inherited from BaseRenderer.) |
| LoadDocumentFromStream | Loads PDF document from provided stream. (Inherited from BaseRenderer.) |
| LoadProfiles | Loads profiles from JSON file. (Inherited from BaseRenderer.) |
| LoadProfilesFromString | Loads profiles from JSON string. (Inherited from BaseRenderer.) |
| MemberwiseClone | (Inherited from Object.) |
| Reset | Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file. (Inherited from BaseRenderer.) |
| ResetExtractionArea | Resets the extraction area to full page. (Inherited from BaseRenderer.) |
| Save(Stream, RasterImageFormat, Int32, Single) | Renders PDF document page as image file in specified format to stream. |
| Save(String, RasterImageFormat, Int32, Single) | Renders PDF document page to image file in specified format. |
| Save(Stream, RasterImageFormat, Int32, Int32, Int32) | Renders PDF document page as image file in specified format to stream. |
| Save(Stream, RasterImageFormat, Int32, Single, RenderingOptions) | Renders PDF document page as image file in specified format to stream. |
| Save(String, RasterImageFormat, Int32, Int32, Int32) | Renders PDF document page to image file in specified format. |
| Save(String, RasterImageFormat, Int32, Single, RenderingOptions) | Renders PDF document page to image file in specified format. |
| Save(Stream, RasterImageFormat, Int32, Int32, Int32, RenderingOptions) | Renders PDF document page as image file in specified format to stream. |
| Save(String, RasterImageFormat, Int32, Int32, Int32, RenderingOptions) | Renders PDF document page to image file in specified format. |
| SaveMultipageTiff(Stream, Int32, Int32, Single) | Renders PDF document page range as multi-page TIFF file to stream. |
| SaveMultipageTiff(String, Int32, Int32, Single) | Renders PDF document page range to multi-page TIFF file. |
| SaveMultipageTiff(Stream, Int32, Int32, Int32, Int32) | Renders PDF document page range as multi-page TIFF file to stream. |
| SaveMultipageTiff(Stream, Int32, Int32, Single, RenderingOptions) | Renders PDF document page range as multi-page TIFF file to stream. |
| SaveMultipageTiff(String, Int32, Int32, Int32, Int32) | Renders PDF document page range to multi-page TIFF file. |
| SaveMultipageTiff(String, Int32, Int32, Single, RenderingOptions) | Renders PDF document page range to multi-page TIFF file. |
| SaveMultipageTiff(Stream, Int32, Int32, Int32, Int32, RenderingOptions) | Renders PDF document page range as multi-page TIFF file to stream. |
| SaveMultipageTiff(String, Int32, Int32, Int32, Int32, RenderingOptions) | Renders PDF document page range to multi-page TIFF file. |
| SetExtractionArea(RectangleF) | Sets the extraction area by rectangle. (Inherited from BaseRenderer.) |
| SetExtractionArea(Double, Double, Double, Double) | (Inherited from BaseRenderer.) |
| SetExtractionArea(Single, Single, Single, Single) | Sets the extraction area by coordinates and dimensions. (Inherited from BaseRenderer.) |
| ToString | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | ParsingError | Raised on PDF document parsing errors. This usually indicates a damaged document. (Inherited from BaseRenderer.) |
| PasswordRequired | Occurs when the password required to decrypt the document. (Inherited from BaseRenderer.) |
| ProgressChanged | Raised for each reported progress value. Allows to cancel the processing. (Inherited from BaseRenderer.) |
Fields
| Name | Description | |
|---|---|---|
 | _defaultRenderingOptions | (Inherited from BaseRenderer.) |
| ExtractionAreaInternal | (Inherited from BaseRenderer.) |
See Also