pdfOCR 4.0.0 API
|
Properties that will be used by the OcrPdfCreator. More...
Public Member Functions |
|
OcrPdfCreatorProperties () | |
Creates a new OcrPdfCreatorProperties instance. More... |
|
OcrPdfCreatorProperties (iText.Pdfocr.OcrPdfCreatorProperties other) | |
Creates a new OcrPdfCreatorProperties instance based on another OcrPdfCreatorProperties instance (copy constructor). More... |
|
Color | GetTextColor () |
Gets text color in output PDF document. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetTextColor (Color textColor) |
Sets text color in output PDF document. More... |
|
ScaleMode | GetScaleMode () |
Gets scale mode for input images using available options from ScaleMode enumeration. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetScaleMode (ScaleMode scaleMode) |
Sets scale mode for input images using available options from ScaleMode enumeration. More... |
|
Rectangle | GetPageSize () |
Gets required size for output PDF document. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetPageSize (Rectangle pageSize) |
Sets required size for output PDF document. More... |
|
String | GetImageLayerName () |
Gets name of image layer. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetImageLayerName (String layerName) |
Sets name for the image layer. More... |
|
String | GetTextLayerName () |
Gets name of text layer. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetTextLayerName (String layerName) |
Sets name for the text layer. More... |
|
String | GetPdfLang () |
Gets PDF language. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetPdfLang (String language) |
Specify PDF natural language, and optionally locale. More... |
|
String | GetTitle () |
Gets PDF document title. More... |
|
iText.Pdfocr.OcrPdfCreatorProperties | SetTitle (String title) |
Sets PDF document title. More... |
|
virtual FontProvider | GetFontProvider () |
Returns FontProvider that was set previously or if it is null a new instance of PdfOcrFontProvider is returned. More... |
|
virtual iText.Pdfocr.OcrPdfCreatorProperties | SetFontProvider (FontProvider fontProvider) |
Sets font provider. More... |
|
virtual iText.Pdfocr.OcrPdfCreatorProperties | SetFontProvider (FontProvider fontProvider, String defaultFontFamily) |
Sets font provider and default font family. More... |
|
virtual String | GetDefaultFontFamily () |
Gets preferred font family to be used when selecting font from iText.Layout.Font.FontProvider. More... |
|
virtual IImageRotationHandler | GetImageRotationHandler () |
Gets image rotation handler instance. More... |
|
virtual iText.Pdfocr.OcrPdfCreatorProperties | SetImageRotationHandler (IImageRotationHandler imageRotationDetector) |
Sets image rotation handler instance. More... |
|
virtual iText.Pdfocr.OcrPdfCreatorProperties | SetTagged (bool tagged) |
Defines whether pdf document should be tagged or not. More... |
|
virtual bool | IsTagged () |
Retrieve information on whether pdf document should be tagged or not. More... |
|
virtual iText.Pdfocr.OcrPdfCreatorProperties | SetMetaInfo (IMetaInfo metaInfo) |
Set meta info for this OcrPdfCreatorProperties. More... |
|
Properties that will be used by the OcrPdfCreator.
|
inline |
Creates a new OcrPdfCreatorProperties instance.
|
inline |
Creates a new OcrPdfCreatorProperties instance based on another OcrPdfCreatorProperties instance (copy constructor).
other | the other OcrPdfCreatorProperties instance |
|
inlinevirtual |
Gets preferred font family to be used when selecting font from iText.Layout.Font.FontProvider.
|
inlinevirtual |
Returns FontProvider that was set previously or if it is null
a new instance of PdfOcrFontProvider is returned.
iText.Layout.Font.FontProvider object
|
inline |
Gets name of image layer.
null
|
inlinevirtual |
Gets image rotation handler instance.
|
inline |
Gets required size for output PDF document.
Gets required size for output PDF document. Real size of the page will be calculated according to the selected ScaleMode
|
inline |
Gets PDF language.
|
inline |
|
inline |
Gets text color in output PDF document.
|
inline |
Gets name of text layer.
null
|
inline |
Gets PDF document title.
|
inlinevirtual |
Retrieve information on whether pdf document should be tagged or not.
true
if the result pdf is expected to be tagged, false
otherwise.
|
inlinevirtual |
Sets font provider.
Sets font provider. Please note that passed FontProvider is not to be used in multithreaded environments or for any parallel processing. There will be set the following default font family: PdfOcrFontProvider.GetDefaultFontFamily()
fontProvider | selected iText.Layout.Font.FontProvider instance |
|
inlinevirtual |
Sets font provider and default font family.
Sets font provider and default font family. Please note that passed FontProvider is not to be used in multithreaded environments or for any parallel processing.
fontProvider | selected iText.Layout.Font.FontProvider instance |
defaultFontFamily | preferred font family to be used when selecting font from iText.Layout.Font.FontProvider. |
|
inline |
Sets name for the image layer.
Sets name for the image layer. null
by default. If null then image is placed directly in canvas instead of layer. If image layer name is equal to text layer name then text and image placed in one layer.
layerName | name of the image layer as System.String |
|
inlinevirtual |
Sets image rotation handler instance.
Sets image rotation handler instance. If not set - image rotation handling is not applied.
imageRotationDetector | image rotation handler instance |
|
inlinevirtual |
Set meta info for this OcrPdfCreatorProperties.
metaInfo | meta info |
|
inline |
Sets required size for output PDF document.
pageSize | requested page size as iText.Kernel.Geom.Rectangle |
|
inline |
Specify PDF natural language, and optionally locale.
Specify PDF natural language, and optionally locale. Language identifier shall either be the empty text string, to indicate that the language is unknown, or a Language-Tag as defined in BCP 47 (2009), Tags for the Identification of Languages.
language | PDF document language as System.String , e.g. "en-US", etc. |
|
inline |
Sets scale mode for input images using available options from ScaleMode enumeration.
scaleMode | selected ScaleMode |
|
inlinevirtual |
Defines whether pdf document should be tagged or not.
tagged |
true
if the result pdf is expected to be tagged, false
otherwise.
|
inline |
Sets text color in output PDF document.
Sets text color in output PDF document. Text will be transparent by default.
textColor | required text iText.Kernel.Colors.Color |
|
inline |
Sets name for the text layer.
Sets name for the text layer. null
by default. If null then text is placed directly in canvas instead of layer. If text layer name is equal to image layer name then text and image placed in one layer.
layerName | of the text layer as System.String |
|
inline |
Sets PDF document title.
title | PDF title as System.String |