You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
416 lines
24 KiB
416 lines
24 KiB
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Syncfusion.PdfToImageConverter.Base</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Syncfusion.PdfToImageConverter.PdfiumNative">
|
|
<summary>
|
|
Class that imports the pdfium dlls.
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:Syncfusion.PdfToImageConverter.PdfiumNative.#cctor" -->
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.None">
|
|
<summary>
|
|
No flags.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.ForPrinting">
|
|
<summary>
|
|
Render for printing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.Annotations">
|
|
<summary>
|
|
Set if annotations are to be rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.LcdText">
|
|
<summary>
|
|
Set if using text rendering optimized for LCD display.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.NoNativeText">
|
|
<summary>
|
|
Don't use the native text output available on some platforms.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.Grayscale">
|
|
<summary>
|
|
Grayscale output.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.LimitImageCacheSize">
|
|
<summary>
|
|
Limit image cache size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.ForceHalftone">
|
|
<summary>
|
|
Always use halftone for image stretching.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.Transparent">
|
|
<summary>
|
|
Render with a transparent background.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Syncfusion.PdfToImageConverter.PdfiumNative.PdfRenderFlags.CorrectFromDpi">
|
|
<summary>
|
|
Correct height/width for DPI.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syncfusion.PdfToImageConverter.PdfiumViewer">
|
|
<summary>
|
|
Class to use the pdfium methods for internal purpose.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syncfusion.PdfToImageConverter.PdfToImageConverter">
|
|
<summary>
|
|
Class to convert the pdf to images.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.#ctor">
|
|
<summary>
|
|
Initializes the members of the <see cref="T:Syncfusion.PdfToImageConverter.PdfToImageConverter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.#ctor(System.IO.Stream)">
|
|
<summary>
|
|
Intializes the members of the <see cref="T:Syncfusion.PdfToImageConverter.PdfToImageConverter"/> class.
|
|
</summary>
|
|
<param name="stream">Stream of the file</param>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.#ctor(System.IO.Stream,System.String)">
|
|
<summary>
|
|
Intializes the members of the <see cref="T:Syncfusion.PdfToImageConverter.PdfToImageConverter"/> class.
|
|
</summary>
|
|
<param name="stream">Stream of the file</param>
|
|
<param name="password">Pasword for the file</param>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Dispose">
|
|
<summary>
|
|
Disposes the pdf document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Load(System.IO.Stream)">
|
|
<summary>
|
|
Loads the PDF document from the specified stream.
|
|
</summary>
|
|
<param name="stream">Pdf file as stream</param>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Load(System.IO.Stream,System.String)">
|
|
<summary>
|
|
Loads the PDF document from the specified stream.
|
|
</summary>
|
|
<param name="stream">Pdf file stream</param>
|
|
<param name="password">Password of the stream</param>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified page of the PDF document as stream.
|
|
</summary>
|
|
<param name="pageIndex">page index of the document</param>
|
|
<param name="keepTransparency">Whether the background of the page needs to be transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the stream of the specified page</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Single,System.Single,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified page of the PDF document as stream.
|
|
</summary>
|
|
<param name="pageIndex">Page index of the document</param>
|
|
<param name="dpiX">The horizontal DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="dpiY">The vertical DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="keepTransparency">Whether the background of the page needs to be transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the stream of the specified page</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Drawing.SizeF,System.Single,System.Single,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified page of the PDF document as stream.
|
|
</summary>
|
|
<param name="pageIndex">Page index of the document</param>
|
|
<param name="customSize">The custom size of the converted image</param>
|
|
<param name="dpiX">The horizontal DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="dpiY">The vertical DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="keepAspectRatio">Whether need to maintain the pdf page size</param>
|
|
<param name="keepTransparency">Whether need to make the background of the page as transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the stream of the specified page</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Int32,System.Single,System.Single,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified range of PDF document's pages as stream array.
|
|
</summary>
|
|
<param name="startIndex">The starting page index</param>
|
|
<param name="endIndex">The ending page index</param>
|
|
<param name="dpiX">The horizontal DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="dpiY">The vertical DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="keepTransparency">Whether need to make the background of the page as transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the array of stream for the range of pages</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Int32,System.Drawing.SizeF,System.Single,System.Single,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified range of PDF document's pages as stream array.
|
|
</summary>
|
|
<param name="startIndex">The starting page index</param>
|
|
<param name="endIndex">The ending page index</param>
|
|
<param name="customSize">The custom size of the converted image</param>
|
|
<param name="dpiX">The horizontal DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="dpiY">The vertical DPI of the resultant <see cref="T:System.Drawing.Bitmap"/>.</param>
|
|
<param name="keepAspectRatio">Whether need to maintain the pdf page size</param>
|
|
<param name="keepTransparency">Whether need to make the background of the page as transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the array of stream for the range of pages</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Drawing.SizeF,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified page of the PDF document as stream.
|
|
</summary>
|
|
<param name="pageIndex">The page index of the document</param>
|
|
<param name="customSize">The custom size of the converted image</param>
|
|
<param name="keepAspectRatio">Whether need to maintain the pdf page size</param>
|
|
<param name="keepTransparency">Whether need to make the background of the page as transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the specified page as stream with custom size</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Int32,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified range of PDF document's pages as stream array.
|
|
</summary>
|
|
<param name="startIndex">The starting page index</param>
|
|
<param name="endIndex">The ending page index</param>
|
|
<param name="keepTransparency">Whether need to make the background of the page as transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the array of stream for the range of pages</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.Convert(System.Int32,System.Int32,System.Drawing.SizeF,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Converts the specified range of PDF document's pages as stream array.
|
|
</summary>
|
|
<param name="startIndex">The starting page index</param>
|
|
<param name="endIndex">The ending page index</param>
|
|
<param name="customSize">The custom size for the converted image</param>
|
|
<param name="keepAspectRatio">Whether need to maintain the pdf page size</param>
|
|
<param name="keepTransparency">Whether need to make the background of the page as transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the array of stream for the range of pages</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ExportAsImage(System.Int32,System.Drawing.SizeF,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Exports the specified page as <see cref="T:System.Drawing.Bitmap"/>
|
|
</summary>
|
|
<param name="pageIndex">The page index to be converted into <see cref="T:System.Drawing.Bitmap"/></param>
|
|
<param name="customSize">The custom size of the converted <see cref="T:System.Drawing.Bitmap"/> </param>
|
|
<param name="keepAspectRatio">Whether need to maintain the pdf page size</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<param name="keepTransparency">Whether the background of the page needs to be transparent</param>
|
|
<returns>Returns the specified page as <see cref="T:System.Drawing.Bitmap"/> with custom size</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ExportAsImage(System.Int32,System.Int32,System.Drawing.SizeF,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Exports the specified pages as <see cref="T:System.Drawing.Bitmap"/>
|
|
</summary>
|
|
<param name="startIndex">The starting page index</param>
|
|
<param name="endIndex">The ending page index</param>
|
|
<param name="customSize">The custom size of the converted <see cref="T:System.Drawing.Bitmap"/> </param>
|
|
<param name="keepAspectRatio">Whether need to maintain the pdf page size</param>
|
|
<param name="keepTransparency">Whether the background of the page needs to be transparent</param>
|
|
<param name="isSkipAnnotations">Whether need to keep the annotation of the page</param>
|
|
<returns>Returns the specified pages as <see cref="T:System.Drawing.Bitmap"/> with custom size</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.PdfiumExportAsImage(System.Drawing.Bitmap,System.Int32,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Exports the specified page as a bitmap image.
|
|
</summary>
|
|
<param name="bitmapImage">Bitmap image</param>
|
|
<param name="pageindex">page index</param>
|
|
<param name="keepTransparency">Whether the background of the page needs to be transparent</param>
|
|
<param name="isSkipAnnotation">Whether need to keep the annotations on the page</param>
|
|
<returns>Returns the converted bitmap image</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ConvertPointToPixel(System.Double)">
|
|
<summary>
|
|
Converts points to pixel
|
|
</summary>
|
|
<param name="number">Point value</param>
|
|
<returns>Returns the pixel value</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.PdfiumRendering(System.Drawing.Bitmap,System.Int32,System.Boolean,System.Boolean,System.Boolean,System.IntPtr)">
|
|
<summary>
|
|
Exports the specified page as a bitmap image.
|
|
</summary>
|
|
<param name="bitmapImage">Bitmap image</param>
|
|
<param name="pageindex">page index</param>
|
|
<param name="keepTransparency">Whether the background of the page needs to be transparent</param>
|
|
<param name="isSkipAnnotation">Whether need to keep the annotations on the page</param>
|
|
<returns>Returns the converted bitmap image</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.CreatePdfiumDocument(System.IO.Stream,System.String)">
|
|
<summary>
|
|
Creates the pdfium document for the provided string.
|
|
</summary>
|
|
<param name="stream">Stream of the Pdf</param>
|
|
<param name="password">Password of the pdf stream</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.CheckBaseDirectory">
|
|
<summary>
|
|
Checks the base directory and provides it.
|
|
</summary>
|
|
<returns>Returns the base directory.</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ExtractText(System.Int32,System.Collections.Generic.List{Syncfusion.PdfToImageConverter.TextData}@,System.Boolean)">
|
|
<summary>
|
|
Extracts text along with its format.
|
|
</summary>///
|
|
<param name=" pageIndex">The page index in which the text has be extracted</param>
|
|
<param name=" textDataCollection">Provides the text data collection </param>
|
|
<param name=" isLayout">maintains the layout if it is true </param>
|
|
<returns>Returns the extracted text for the provided page</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.TextExtraction(System.Int32,System.Collections.Generic.List{Syncfusion.PdfToImageConverter.TextData}@,System.Boolean,System.Boolean,System.Int32)">
|
|
<summary>
|
|
Extracts the text from the specified page index.
|
|
</summary>
|
|
<param name="index">Page index</param>
|
|
<param name="textDataCollection">Text collection</param>
|
|
<param name="isLayout">Text format</param>
|
|
<param name="isRotated">Whether rotated or not</param>
|
|
<param name="rotateAngle">Angle of rotation</param>
|
|
<returns>Returns the extracted text from the provided page index</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ExtractTextWithPageSize(System.Int32,System.Collections.Generic.Dictionary{System.Int32,Syncfusion.PdfToImageConverter.PageTextData}@)">
|
|
<summary>
|
|
extracts text along with its format.
|
|
</summary>///
|
|
<param name=" pageIndex">The page index in which the text has be extracted</param>
|
|
<param name=" pageTextDataCollection">Provides the text data collection with page details</param>
|
|
<returns>Returns the extracted text for the provided page</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.GetBounds(System.IntPtr,System.Int32,System.Double,System.Single)">
|
|
<summary>
|
|
Gets the bounds of the text.
|
|
</summary>
|
|
<param name="textPage">Page object</param>
|
|
<param name="index">page index</param>
|
|
<param name="height"></param>
|
|
<param name="cropY"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.GetTextDetails(System.Int32,System.Collections.Generic.List{Syncfusion.PdfToImageConverter.TextData}@)">
|
|
<summary>
|
|
Gets the text details for the provided page index.
|
|
</summary>
|
|
<param name="index">Page index</param>
|
|
<param name="textDataCollection">Text collection of the page</param>
|
|
<returns>Returns the text</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ConvertBitmapToStream(System.Drawing.Bitmap)">
|
|
<summary>
|
|
Converts the bitmap to stream.
|
|
</summary>
|
|
<param name="bitmapImage">Bitmap image to be converted</param>
|
|
<returns>Returns the converted stream</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ConvertBitmapToStream(System.Drawing.Bitmap[])">
|
|
<summary>
|
|
Converts the bitmap to stream.
|
|
</summary>
|
|
<param name="bitmapImage">Array of bitmap images to be converted</param>
|
|
<returns>Returns the converted stream</returns>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.ExtractPdfiumLibrary">
|
|
<summary>
|
|
Extracts the Pdfium library to the application.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PdfToImageConverter.HasUnicodeCharacter(System.String)">
|
|
<summary>
|
|
Checks whether the password is unicoded or not.
|
|
</summary>
|
|
<param name="password">Password of the stream</param>
|
|
<returns>Returns true if the password is unicoded, else false</returns>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PdfToImageConverter.ScaleFactor">
|
|
<summary>
|
|
Scales the page while rendering in the PDF Viewer control for improving the quality of the image.
|
|
Positive float values can be set. Recommended Value is 1 or 1.5f.
|
|
If the value is greater than the recommended value, there might be any distortion in the performance of the PDF Viewer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PdfToImageConverter.ReferencePath">
|
|
<summary>
|
|
Gets or sets the reference path of the Pdfium library.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PdfToImageConverter.PageCount">
|
|
<summary>
|
|
Gets the page count of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PdfToImageConverter.DocumentID">
|
|
<summary>
|
|
Gets or sets the id of the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PdfToImageConverter.Document">
|
|
<summary>
|
|
Gets or sets the pdf document value
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syncfusion.PdfToImageConverter.TextData">
|
|
<summary>
|
|
Represents a text informations
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.TextData.#ctor(System.String,System.Drawing.RectangleF)">
|
|
<summary>
|
|
Initializes the members of the <see cref="T:Syncfusion.PdfToImageConverter.TextData"/> class.
|
|
</summary>
|
|
<param name="text">Text on the document</param>
|
|
<param name="bounds">Bounds of the text</param>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.TextData.Bounds">
|
|
<summary>
|
|
Gets the bounds of the text
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.TextData.Text">
|
|
<summary>
|
|
Gets the text
|
|
</summary>
|
|
</member>
|
|
<member name="T:Syncfusion.PdfToImageConverter.PageTextData">
|
|
<summary>
|
|
Represents a Page text informations
|
|
</summary>
|
|
</member>
|
|
<member name="M:Syncfusion.PdfToImageConverter.PageTextData.#ctor(System.Drawing.SizeF,System.Collections.Generic.List{Syncfusion.PdfToImageConverter.TextData},System.String)">
|
|
<summary>
|
|
Initializes the members of the <see cref="T:Syncfusion.PdfToImageConverter.PageTextData"/> class.
|
|
</summary>
|
|
<param name="pageSize">Size of the page</param>
|
|
<param name="textData">Text informations of the page</param>
|
|
<param name="pageString">Text data of the page</param>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PageTextData.TextData">
|
|
<summary>
|
|
Gets the list of text data for the page
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PageTextData.PageText">
|
|
<summary>
|
|
Gets the text data for the page
|
|
</summary>
|
|
</member>
|
|
<member name="P:Syncfusion.PdfToImageConverter.PageTextData.PageSize">
|
|
<summary>
|
|
Gets the page size for the page
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|