Link Search Menu Expand Document

BaseRenderer Class

Defines a base class for PDF renderers.
Inheritance Hierarchy
SystemObject
Bytescout.PDFRendererBaseRenderer
Bytescout.PDFRendererRasterRenderer
Bytescout.PDFRendererVectorRenderer

Namespace:Bytescout.PDFRenderer
Assembly: Bytescout.PDFRenderer (in Bytescout.PDFRenderer.dll) Version: 13.0.1.4282-master
Syntax
public abstract class BaseRenderer : IBaseRenderer, 
	IDisposable, IProfiles

The BaseRenderer type exposes the following members.

Constructors
NameDescription
Protected methodBaseRenderer
Protected constructor.
Protected methodBaseRenderer(String, String)
Initializes a new instance of the renderer class.
Top
Properties
NameDescription
Public propertyExtractionArea
Sets the extraction area by coordinates and dimensions.
Public propertyExtractionAreaRect
Sets the extraction area by rectangle.
Public propertyLicenseInfo
Gets license information.
Public propertyPassword
PDF document owner password.
Public propertyProfiles
Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded.
Public propertyRegistrationKey
Registration key.
Public propertyRegistrationName
Registration name.
Public propertyVersion
Gets the component version number.
Top
Methods
NameDescription
Public methodCreateProfile(String, RenderingOptions, Boolean, Boolean, Boolean)
Creates JSON profile will all extractor properties with current values.
Public methodCreateProfile(String, String, RenderingOptions, Boolean, Boolean, Boolean)
Creates JSON profile will all extractor properties with current values.
Public methodDispose
Releases the unmanaged resources used by the instance and optionally releases the managed resources.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodFireParsingError
Protected methodFireProgressChanged
Public methodGetHashCode (Inherited from Object.)
Public methodGetPageCount
Returns document page count.
Public methodGetPageRect_Height
Gets the specified page height.
Public methodGetPageRect_Left
Gets the specified page left coordinate.
Public methodGetPageRect_Top
Gets the specified page top coordinate.
Public methodGetPageRect_Width
Gets the specified page width.
Public methodGetPageRectangle(Int32)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
Public methodGetPageRectangle(Int32, Boolean)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
Public methodGetType (Inherited from Object.)
Public methodLoadAndApplyProfiles
Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.
Public methodLoadDocumentFromFile
Loads PDF document from specified file.
Public methodLoadDocumentFromStream
Loads PDF document from provided stream.
Public methodLoadProfiles
Loads profiles from JSON file.
Public methodLoadProfilesFromString
Loads profiles from JSON string.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodReset
Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file.
Public methodResetExtractionArea
Resets the extraction area to full page.
Public methodSetExtractionArea(RectangleF)
Sets the extraction area by rectangle.
Public methodSetExtractionArea(Double, Double, Double, Double)
Public methodSetExtractionArea(Single, Single, Single, Single)
Sets the extraction area by coordinates and dimensions.
Public methodToString (Inherited from Object.)
Top
Events
NameDescription
Public eventParsingError
Raised on PDF document parsing errors. This usually indicates a damaged document.
Public eventPasswordRequired
Occurs when the password required to decrypt the document.
Public eventProgressChanged
Raised for each reported progress value. Allows to cancel the processing.
Top
Fields
Top
See Also

Reference


Copyright © 2016 - 2021 ByteScout