BaseRenderer 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
Defines a base class for PDF renderers.
Inheritance Hierarchy
Bytescout.PDFRendererBaseRenderer
Bytescout.PDFRendererRasterRenderer
Bytescout.PDFRendererVectorRenderer
Namespace:Bytescout.PDFRenderer
Assembly: Bytescout.PDFRenderer (in Bytescout.PDFRenderer.dll) Version: 13.4.0.4759-master
Syntax
The BaseRenderer type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| BaseRenderer | Protected constructor. | |
| BaseRenderer(String, String) | Initializes a new instance of the renderer class. |
Properties
| Name | Description | |
|---|---|---|
| ExtractionArea | Sets the extraction area by coordinates and dimensions. | |
| ExtractionAreaRect | Sets the extraction area by rectangle. | |
| LicenseInfo | Gets license information. | |
| Password | PDF document owner password. | |
| Profiles | Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded. | |
| RegistrationKey | Registration key. | |
| RegistrationName | Registration name. | |
| Version | Gets the component version number. |
Methods
| Name | Description | |
|---|---|---|
| CreateProfile(String, RenderingOptions, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. | |
| CreateProfile(String, String, RenderingOptions, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. | |
| Dispose | Releases the unmanaged resources used by the instance and optionally releases the managed resources. | |
| Equals | (Inherited from Object.) | |
| Finalize | (Inherited from Object.) | |
| FireParsingError | ||
| FireProgressChanged | ||
| GetHashCode | (Inherited from Object.) | |
| GetPageCount | Returns document page count. | |
| GetPageRect_Height | Gets the specified page height. | |
| GetPageRect_Left | Gets the specified page left coordinate. | |
| GetPageRect_Top | Gets the specified page top coordinate. | |
| GetPageRect_Width | Gets the specified page width. | |
| GetPageRectangle(Int32) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). | |
| GetPageRectangle(Int32, Boolean) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). | |
| 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. | |
| LoadDocumentFromFile | Loads PDF document from specified file. | |
| LoadDocumentFromStream | Loads PDF document from provided stream. | |
| LoadProfiles | Loads profiles from JSON file. | |
| LoadProfilesFromString | Loads profiles from JSON string. | |
| MemberwiseClone | (Inherited from Object.) | |
| Reset | Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file. | |
| ResetExtractionArea | Resets the extraction area to full page. | |
| SetExtractionArea(RectangleF) | Sets the extraction area by rectangle. | |
| SetExtractionArea(Double, Double, Double, Double) | ||
| SetExtractionArea(Single, Single, Single, Single) | Sets the extraction area by coordinates and dimensions. | |
| ToString | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
| ParsingError | Raised on PDF document parsing errors. This usually indicates a damaged document. | |
| PasswordRequired | Occurs when the password required to decrypt the document. | |
| ProgressChanged | Raised for each reported progress value. Allows to cancel the processing. |
Fields
| Name | Description | |
|---|---|---|
| _defaultRenderingOptions | ||
| ExtractionAreaInternal |
See Also