Class PdfClient<T>
Inheritance
System.Object
PdfClient<T>
Implements
System.IDisposable
Assembly: IronPdf.dll
Syntax
public abstract class PdfClient<T> : Object, IDisposable, IPdfClient where T : PdfiumDeploymentBase
Type Parameters
Constructors
PdfClient(Boolean)
Declaration
protected PdfClient(bool deployPdfium = true)
Parameters
Type |
Name |
Description |
System.Boolean |
deployPdfium |
|
Methods
AddAttachment(IPdfDocumentId, String)
Declaration
public int AddAttachment(IPdfDocumentId id, string name)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
name |
|
Returns
Type |
Description |
System.Int32 |
|
AddBookmark(IPdfDocumentId, String, String, String, Int32)
Declaration
public void AddBookmark(IPdfDocumentId id, string text, string parentText, string previousText, int pageIndex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
text |
|
System.String |
parentText |
|
System.String |
previousText |
|
System.Int32 |
pageIndex |
|
AddFont(IPdfDocumentId, Byte[])
Declaration
public PdfFont AddFont(IPdfDocumentId id, byte[] fontData)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Byte[] |
fontData |
|
Returns
AddFont(IPdfDocumentId, String)
Declaration
public PdfFont AddFont(IPdfDocumentId id, string standardFontName)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
standardFontName |
|
Returns
Declaration
public string AddFontIntoPageResources(IPdfDocumentId id, int pageIndex, PdfFont pdfFont, float fontSize)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
PdfFont |
pdfFont |
|
System.Single |
fontSize |
|
Returns
Type |
Description |
System.String |
|
Declaration
public int AddFormField(IPdfDocumentId id, IFormFieldObject form)
Parameters
Returns
Type |
Description |
System.Int32 |
|
Declaration
public int AddFormFieldAnnotation(IPdfDocumentId id, IFormFieldObject form, IFormFieldAnnotation annot)
Parameters
Returns
Type |
Description |
System.Int32 |
|
AddLayersFromAnotherPdf(IPdfDocumentId, LayerMode, IEnumerable<Int32>, IPdfDocumentId, Int32)
Declaration
public void AddLayersFromAnotherPdf(IPdfDocumentId destId, LayerMode layermode, IEnumerable<int> toPageIndexes, IPdfDocumentId srcId, int backgroundPdfPageIndex = 0)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
destId |
|
LayerMode |
layermode |
|
System.Collections.Generic.IEnumerable<System.Int32> |
toPageIndexes |
|
IronSoftware.IPdfDocumentId |
srcId |
|
System.Int32 |
backgroundPdfPageIndex |
|
AddLinkAnnotation(IPdfDocumentId, String, String, Int32, Int32, Int32, Int32, Int32)
Declaration
public void AddLinkAnnotation(IPdfDocumentId id, string name, string url, int pageIndex, int x, int y, int width = 100, int height = 20)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
name |
|
System.String |
url |
|
System.Int32 |
pageIndex |
|
System.Int32 |
x |
|
System.Int32 |
y |
|
System.Int32 |
width |
|
System.Int32 |
height |
|
AddSignature(IPdfDocumentId, PdfSignature, Int32, SignaturePermissions)
Declaration
public int AddSignature(IPdfDocumentId id, PdfSignature signature, int pageIndex, SignaturePermissions perms)
Parameters
Returns
Type |
Description |
System.Int32 |
|
Declaration
public void AddSignatureImage(IPdfDocumentId id, Image<Rgba32> bitmap, int pageIndex, int signatureIndex, double x, double y, double desiredWidth, double desiredHeight)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32> |
bitmap |
|
System.Int32 |
pageIndex |
|
System.Int32 |
signatureIndex |
|
System.Double |
x |
|
System.Double |
y |
|
System.Double |
desiredWidth |
|
System.Double |
desiredHeight |
|
AddTextAnnotation(IPdfDocumentId, IAnnotation)
Declaration
public int AddTextAnnotation(IPdfDocumentId id, IAnnotation annot)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
IAnnotation |
annot |
|
Returns
Type |
Description |
System.Int32 |
|
AddTextHeadersAndFooters(IPdfDocumentId, IHeaderFooter, IEnumerable<Int32>, String, String, String)
Declaration
public void AddTextHeadersAndFooters(IPdfDocumentId id, IHeaderFooter options, IEnumerable<int> pages, string url, string htmlTitle, string pdfTitle)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
IronPdf.IHeaderFooter |
options |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
System.String |
url |
|
System.String |
htmlTitle |
|
System.String |
pdfTitle |
|
CloseDocument(IPdfDocumentId)
Declaration
public int CloseDocument(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Int32 |
|
CombinePages(IPdfDocumentId, Double, Double, Int32, Int32)
Declaration
public IPdfDocumentId CombinePages(IPdfDocumentId id, double width, double height, int cols, int rows)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Double |
width |
|
System.Double |
height |
|
System.Int32 |
cols |
|
System.Int32 |
rows |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
CompressImages(IPdfDocumentId, Int32, Boolean, Boolean)
Declaration
public void CompressImages(IPdfDocumentId id, int quality, bool useVisible, bool useHighQualitySampling)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
quality |
|
System.Boolean |
useVisible |
|
System.Boolean |
useHighQualitySampling |
|
ConvertToPdfA(IPdfDocumentId, Byte[], Int32, Boolean)
Declaration
public void ConvertToPdfA(IPdfDocumentId id, byte[] iccBytes, int convtVer, bool isAVariant)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Byte[] |
iccBytes |
|
System.Int32 |
convtVer |
|
System.Boolean |
isAVariant |
|
ConvertToPdfUA(IPdfDocumentId, Int32)
Declaration
public void ConvertToPdfUA(IPdfDocumentId id, int naturalLangIndex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
naturalLangIndex |
|
CopyPages(IPdfDocumentId, IEnumerable<Int32>)
Declaration
public IPdfDocumentId CopyPages(IPdfDocumentId srcId, IEnumerable<int> pageIndexes)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
srcId |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pageIndexes |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
Dispose()
Declaration
public virtual void Dispose()
Declaration
public void DrawImage(IPdfDocumentId id, Image<Rgba32> bitmap, int pageIndex, double x, double y, double desiredWidth, double desiredHeight, PixelFormat format)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32> |
bitmap |
|
System.Int32 |
pageIndex |
|
System.Double |
x |
|
System.Double |
y |
|
System.Double |
desiredWidth |
|
System.Double |
desiredHeight |
|
PixelFormat |
format |
|
Declaration
public void DrawImages(IPdfDocumentId id, Image<Rgba32> bitmap, List<int> pageIndices, List<double> xs, List<double> ys, List<double> desiredWidths, List<double> desiredHeights, PixelFormat format)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32> |
bitmap |
|
System.Collections.Generic.List<System.Int32> |
pageIndices |
|
System.Collections.Generic.List<System.Double> |
xs |
|
System.Collections.Generic.List<System.Double> |
ys |
|
System.Collections.Generic.List<System.Double> |
desiredWidths |
|
System.Collections.Generic.List<System.Double> |
desiredHeights |
|
PixelFormat |
format |
|
DrawLine(IPdfDocumentId, Int32, PointF, PointF, Double, Color)
Declaration
public void DrawLine(IPdfDocumentId id, int page_index, PointF start, PointF end, double width, Color color)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
page_index |
|
IronSoftware.Drawing.PointF |
start |
|
IronSoftware.Drawing.PointF |
end |
|
System.Double |
width |
|
IronSoftware.Drawing.Color |
color |
|
DrawRectangle(IPdfDocumentId, Int32, RectangleF, Color, Color, Double)
Declaration
public void DrawRectangle(IPdfDocumentId id, int page_index, RectangleF rect, Color line_color, Color fill_color, double line_width)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
page_index |
|
IronSoftware.Drawing.RectangleF |
rect |
|
IronSoftware.Drawing.Color |
line_color |
|
IronSoftware.Drawing.Color |
fill_color |
|
System.Double |
line_width |
|
DrawText(IPdfDocumentId, String, PdfFont, Double, Int32, Double, Double, Color, Double, Double)
Declaration
public void DrawText(IPdfDocumentId id, string text, PdfFont pdfFont, double fontSize, int pageIndex, double x, double y, Color color, double scale, double rotation)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
text |
|
PdfFont |
pdfFont |
|
System.Double |
fontSize |
|
System.Int32 |
pageIndex |
|
System.Double |
x |
|
System.Double |
y |
|
IronSoftware.Drawing.Color |
color |
|
System.Double |
scale |
|
System.Double |
rotation |
|
EditTextAnnotation(IPdfDocumentId, IAnnotation)
Declaration
public void EditTextAnnotation(IPdfDocumentId id, IAnnotation annot)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
IAnnotation |
annot |
|
EmbedFont(IPdfDocumentId, UInt32, Byte[], FontType)
Declaration
public bool EmbedFont(IPdfDocumentId id, uint objNum, byte[] fontData, FontType embedAsType)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.UInt32 |
objNum |
|
System.Byte[] |
fontData |
|
FontType |
embedAsType |
|
Returns
Type |
Description |
System.Boolean |
|
ExtendPageSize(IPdfDocumentId, Int32, Double, Double, Double, Double)
Declaration
public void ExtendPageSize(IPdfDocumentId id, int pageIndex, double left, double right, double top, double bottom)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.Double |
left |
|
System.Double |
right |
|
System.Double |
top |
|
System.Double |
bottom |
|
Finalize()
Declaration
protected override void Finalize()
FindFonts(IPdfDocumentId, String)
Declaration
public PdfFontCollection FindFonts(IPdfDocumentId id, string regex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
regex |
|
Returns
FlattenPages(IPdfDocumentId, IEnumerable<Int32>, PdfFlattenStyles)
Declaration
public List<PdfFlattenResults> FlattenPages(IPdfDocumentId id, IEnumerable<int> pages, PdfFlattenStyles style)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
PdfFlattenStyles |
style |
|
Returns
FreeBytes(IntPtr, Boolean)
Declaration
public void FreeBytes(IntPtr pointer, bool is_array)
Parameters
Type |
Name |
Description |
System.IntPtr |
pointer |
|
System.Boolean |
is_array |
|
GetAnnotationCount(IPdfDocumentId, Int32)
Declaration
public int GetAnnotationCount(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
Returns
Type |
Description |
System.Int32 |
|
GetAnnotations(IPdfDocumentId, Int32)
Declaration
public List<PdfAnnotation> GetAnnotations(IPdfDocumentId id, int pageIndex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
Returns
GetAttachmentCount(IPdfDocumentId)
Declaration
public int GetAttachmentCount(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Int32 |
|
GetAttachmentData(IPdfDocumentId, Int32)
Declaration
public byte[] GetAttachmentData(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
Returns
Type |
Description |
System.Byte[] |
|
GetAttachmentName(IPdfDocumentId, Int32)
Declaration
public string GetAttachmentName(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
Returns
Type |
Description |
System.String |
|
GetBookmarks(IPdfDocumentId)
Declaration
public List<PdfiumBookmarkDescriptor> GetBookmarks(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
GetBytes(IPdfDocumentId, Boolean, Boolean, Boolean, List<PdfSignature>)
Declaration
public byte[] GetBytes(IPdfDocumentId id, bool incremental, bool applyWatermark = false, bool isDeveloperDebuggingInVisualStudio = false, List<PdfSignature> signatures = null)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Boolean |
incremental |
|
System.Boolean |
applyWatermark |
|
System.Boolean |
isDeveloperDebuggingInVisualStudio |
|
System.Collections.Generic.List<PdfSignature> |
signatures |
|
Returns
Type |
Description |
System.Byte[] |
|
GetCharacters(IPdfDocumentId, Int32)
Declaration
public IDocumentCharCollection GetCharacters(IPdfDocumentId id, int page_index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
page_index |
|
Returns
Type |
Description |
IronSoftware.IDocumentCharCollection |
|
GetFontInfo(IPdfDocumentId)
Declaration
public PdfFontCollection GetFontInfo(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
GetFontInfoAt(IPdfDocumentId, UInt32)
Declaration
public PdfFont GetFontInfoAt(IPdfDocumentId id, uint objNum)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.UInt32 |
objNum |
|
Returns
Declaration
public FormFieldCollection GetFormFields(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Declaration
public string GetMetadata(IPdfDocumentId id, string name)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
name |
|
Returns
Type |
Description |
System.String |
|
Declaration
public Dictionary<string, string> GetMetadataDict(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Collections.Generic.Dictionary<System.String, System.String> |
|
Declaration
public List<string> GetMetadataKeys(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Collections.Generic.List<System.String> |
|
GetPageBounds(IPdfDocumentId, Int32, ref Double, ref Double, ref Double, ref Double)
Declaration
public void GetPageBounds(IPdfDocumentId id, int pageIndex, ref double left, ref double right, ref double top, ref double bottom)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.Double |
left |
|
System.Double |
right |
|
System.Double |
top |
|
System.Double |
bottom |
|
GetPageCount(IPdfDocumentId)
Declaration
public int GetPageCount(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Int32 |
|
Declaration
public List<Image<Rgba32>> GetPageImages(IPdfDocumentId id, IEnumerable<int> pages, PdfImageExtractionOptions options, out List<RectangleF> rects, out List<int> pageIndices)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
PdfImageExtractionOptions |
options |
|
System.Collections.Generic.List<SixLabors.ImageSharp.RectangleF> |
rects |
|
System.Collections.Generic.List<System.Int32> |
pageIndices |
|
Returns
Type |
Description |
System.Collections.Generic.List<SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32>> |
|
GetPageInfo(IPdfDocumentId)
Declaration
public List<PdfPageDescriptor> GetPageInfo(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
GetPageInfo(IPdfDocumentId, Int32)
Declaration
public IPdfPage GetPageInfo(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
Returns
Declaration
public PdfPageRotation GetPageRotation(IPdfDocumentId id, int pageIndex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
Returns
GetPageText(IPdfDocumentId, IEnumerable<Int32>, Boolean, CancellationToken)
Declaration
public string GetPageText(IPdfDocumentId id, IEnumerable<int> pages, bool isLicensed = true, CancellationToken cancellationToken = null)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
System.Boolean |
isLicensed |
|
System.Threading.CancellationToken |
cancellationToken |
|
Returns
Type |
Description |
System.String |
|
GetPaperSizePreset(String, out Double, out Double)
Declaration
public void GetPaperSizePreset(string name, out double widthOut, out double heightOut)
Parameters
Type |
Name |
Description |
System.String |
name |
|
System.Double |
widthOut |
|
System.Double |
heightOut |
|
GetPermissions(IPdfDocumentId)
Declaration
public PdfDocumentPermissions GetPermissions(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Declaration
public List<byte[]> GetRawPageImages(IPdfDocumentId id, IEnumerable<int> pages, PdfImageExtractionOptions options, out List<RectangleF> rects)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
PdfImageExtractionOptions |
options |
|
System.Collections.Generic.List<SixLabors.ImageSharp.RectangleF> |
rects |
|
Returns
Type |
Description |
System.Collections.Generic.List<System.Byte[]> |
|
GetRevision(IPdfDocumentId, Int32)
Declaration
public byte[] GetRevision(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
Returns
Type |
Description |
System.Byte[] |
|
GetRevisionCount(IPdfDocumentId)
Declaration
public int GetRevisionCount(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Int32 |
|
GetSignatureByteRange(IPdfDocumentId, Int32)
Declaration
public int[] GetSignatureByteRange(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
Returns
Type |
Description |
System.Int32[] |
|
GetSignatureCount(IPdfDocumentId)
Declaration
public int GetSignatureCount(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Int32 |
|
GetTextAnnotation(IPdfDocumentId, Int32, Int32)
Declaration
public IAnnotation GetTextAnnotation(IPdfDocumentId id, int pageIndex, int annotationIndex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.Int32 |
annotationIndex |
|
Returns
GetTextObjects(IPdfDocumentId, Int32)
Declaration
public IDocumentTextObjectCollection GetTextObjects(IPdfDocumentId id, int page_index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
page_index |
|
Returns
Type |
Description |
IronSoftware.IDocumentTextObjectCollection |
|
GetVerifiedSignatures(IPdfDocumentId, Byte[])
Declaration
public List<VerifiedSignature> GetVerifiedSignatures(IPdfDocumentId id, byte[] data)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Byte[] |
data |
|
Returns
IncrementReference(IPdfDocumentId)
Declaration
public int IncrementReference(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
Returns
Type |
Description |
System.Int32 |
|
InsertPdf(IPdfDocumentId, IPdfDocumentId, Int32)
Declaration
public void InsertPdf(IPdfDocumentId destId, IPdfDocumentId srcId, int atIndex = 0)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
destId |
|
IronSoftware.IPdfDocumentId |
srcId |
|
System.Int32 |
atIndex |
|
Merge(IEnumerable<IPdfDocumentId>)
Declaration
public IPdfDocumentId Merge(IEnumerable<IPdfDocumentId> pdfs)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IEnumerable<IronSoftware.IPdfDocumentId> |
pdfs |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
MergePageObjectsAppend(IPdfDocumentId, Int32, IPdfDocumentId, Int32, Boolean)
Declaration
public void MergePageObjectsAppend(IPdfDocumentId srcId, int srcPageIndex, IPdfDocumentId destId, int destPageIndex, bool copyAnnotations)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
srcId |
|
System.Int32 |
srcPageIndex |
|
IronSoftware.IPdfDocumentId |
destId |
|
System.Int32 |
destPageIndex |
|
System.Boolean |
copyAnnotations |
|
OpenDocument(Stream, String, String, ChangeTrackingModes)
Declaration
public IPdfDocumentId OpenDocument(Stream stream, string password, string ownerPassword, ChangeTrackingModes trackChanges)
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
System.String |
password |
|
System.String |
ownerPassword |
|
ChangeTrackingModes |
trackChanges |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
OpenDocument(ReadOnlySpan<Byte>, String, String, ChangeTrackingModes)
Declaration
public IPdfDocumentId OpenDocument(ReadOnlySpan<byte> data, string password, string ownerPassword, ChangeTrackingModes trackChanges)
Parameters
Type |
Name |
Description |
System.ReadOnlySpan<System.Byte> |
data |
|
System.String |
password |
|
System.String |
ownerPassword |
|
ChangeTrackingModes |
trackChanges |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
OpenDocument(String, String, String, ChangeTrackingModes)
Declaration
public IPdfDocumentId OpenDocument(string path, string password, string ownerPassword, ChangeTrackingModes trackChanges)
Parameters
Type |
Name |
Description |
System.String |
path |
|
System.String |
password |
|
System.String |
ownerPassword |
|
ChangeTrackingModes |
trackChanges |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
OpenDocumentFromJobResult(Int32, String, String)
Declaration
public IPdfDocumentId OpenDocumentFromJobResult(int job_id, string password, string owner_password)
Parameters
Type |
Name |
Description |
System.Int32 |
job_id |
|
System.String |
password |
|
System.String |
owner_password |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
Declaration
public IPdfDocumentId OpenDocumentFromJobResultWithoutForms(int jobId, string password)
Parameters
Type |
Name |
Description |
System.Int32 |
jobId |
|
System.String |
password |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
OpenEmptyDocument(Double, Double)
Declaration
public IPdfDocumentId OpenEmptyDocument(double width, double height)
Parameters
Type |
Name |
Description |
System.Double |
width |
|
System.Double |
height |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
RedactRegions(IPdfDocumentId, Int32, IEnumerable<RectangleF>, Boolean)
Declaration
public void RedactRegions(IPdfDocumentId id, int pageIndex, IEnumerable<RectangleF> regions, bool isDrawBoxes)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.Collections.Generic.IEnumerable<IronSoftware.Drawing.RectangleF> |
regions |
|
System.Boolean |
isDrawBoxes |
|
RedactText(IPdfDocumentId, Int32, String, Boolean, Boolean, String, Boolean)
Declaration
public void RedactText(IPdfDocumentId id, int pageIndex, string replaceText, bool isDrawBoxes, bool isMatchWholeWord, string filler_text, bool isCaseSensitive)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.String |
replaceText |
|
System.Boolean |
isDrawBoxes |
|
System.Boolean |
isMatchWholeWord |
|
System.String |
filler_text |
|
System.Boolean |
isCaseSensitive |
|
RemoveAnnotation(IPdfDocumentId, Int32, Int32)
Declaration
public int RemoveAnnotation(IPdfDocumentId id, int pageIndex, int annotIndex)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.Int32 |
annotIndex |
|
Returns
Type |
Description |
System.Int32 |
|
RemoveAttachment(IPdfDocumentId, Int32)
Declaration
public void RemoveAttachment(IPdfDocumentId id, int index)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
RemoveBookmark(IPdfDocumentId, IPdfBookmark)
Declaration
public void RemoveBookmark(IPdfDocumentId id, IPdfBookmark bookmark)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
IronPdf.Bookmarks.IPdfBookmark |
bookmark |
|
RemoveBookmarks(IPdfDocumentId, List<IPdfBookmark>)
Declaration
public void RemoveBookmarks(IPdfDocumentId id, List<IPdfBookmark> bookmarks)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.List<IronPdf.Bookmarks.IPdfBookmark> |
bookmarks |
|
RemoveFont(IPdfDocumentId, String)
Declaration
public uint RemoveFont(IPdfDocumentId id, string fontName)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
fontName |
|
Returns
Type |
Description |
System.UInt32 |
|
Declaration
public void RemoveFormField(IPdfDocumentId id, IFormFieldObject form)
Parameters
Declaration
public void RemoveFormFieldAnnotation(IPdfDocumentId id, IFormFieldObject form, IFormFieldAnnotation annot)
Parameters
Declaration
public void RemoveMetadataKey(IPdfDocumentId id, string key)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
key |
|
RemovePages(IPdfDocumentId, IEnumerable<Int32>)
Declaration
public int RemovePages(IPdfDocumentId id, IEnumerable<int> pagesIn)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pagesIn |
|
Returns
Type |
Description |
System.Int32 |
|
RemovePasswordsAndEncryption(IPdfDocumentId)
Declaration
public void RemovePasswordsAndEncryption(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
RemoveSignatures(IPdfDocumentId)
Declaration
public void RemoveSignatures(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
RemoveStructTree(IPdfDocumentId)
Declaration
public void RemoveStructTree(IPdfDocumentId id)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
RenderPageImage(IPdfDocumentId, Int32, Nullable<Int32>, Nullable<Int32>, BitmapRenderOptions, Int32, out Int32, out Int32, out Int32, Boolean)
Declaration
public IntPtr RenderPageImage(IPdfDocumentId id, int page_index, Nullable<int> maxWidthPx, Nullable<int> maxHeightPx, BitmapRenderOptions flags, int dpi, out int result_width, out int result_height, out int byte_count, bool flatten)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
page_index |
|
System.Nullable<System.Int32> |
maxWidthPx |
|
System.Nullable<System.Int32> |
maxHeightPx |
|
BitmapRenderOptions |
flags |
|
System.Int32 |
dpi |
|
System.Int32 |
result_width |
|
System.Int32 |
result_height |
|
System.Int32 |
byte_count |
|
System.Boolean |
flatten |
|
Returns
Type |
Description |
System.IntPtr |
|
RenderPageImages(IPdfDocumentId, IEnumerable<Int32>, Nullable<Int32>, Nullable<Int32>, BitmapRenderOptions, Int32, Boolean)
Declaration
public List<Image<Rgba32>> RenderPageImages(IPdfDocumentId id, IEnumerable<int> pages, Nullable<int> maxWidthPx, Nullable<int> maxHeightPx, BitmapRenderOptions flags, int dpi, bool flatten)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
System.Nullable<System.Int32> |
maxWidthPx |
|
System.Nullable<System.Int32> |
maxHeightPx |
|
BitmapRenderOptions |
flags |
|
System.Int32 |
dpi |
|
System.Boolean |
flatten |
|
Returns
Type |
Description |
System.Collections.Generic.List<SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32>> |
|
ReplaceFont(IPdfDocumentId, UInt32, Byte[], FontType)
Declaration
public uint ReplaceFont(IPdfDocumentId id, uint objNum, byte[] fontData, FontType replacingFontType)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.UInt32 |
objNum |
|
System.Byte[] |
fontData |
|
FontType |
replacingFontType |
|
Returns
Type |
Description |
System.UInt32 |
|
ReplaceFont(IPdfDocumentId, UInt32, String)
Declaration
public uint ReplaceFont(IPdfDocumentId id, uint objNum, string standardFontName)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.UInt32 |
objNum |
|
System.String |
standardFontName |
|
Returns
Type |
Description |
System.UInt32 |
|
ReplaceText(IPdfDocumentId, Int32, String, String)
Declaration
public void ReplaceText(IPdfDocumentId id, int pageIndex, string oldText, string newText)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.String |
oldText |
|
System.String |
newText |
|
ResizePage(IPdfDocumentId, Int32, Double, Double)
Declaration
public void ResizePage(IPdfDocumentId id, int pageIndex, double width, double height)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
pageIndex |
|
System.Double |
width |
|
System.Double |
height |
|
SetAttachmentData(IPdfDocumentId, Int32, ReadOnlySpan<Byte>)
Declaration
public int SetAttachmentData(IPdfDocumentId id, int index, ReadOnlySpan<byte> bytes)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
index |
|
System.ReadOnlySpan<System.Byte> |
bytes |
|
Returns
Type |
Description |
System.Int32 |
|
Declaration
public void SetFormFieldValue(IPdfDocumentId id, IFormFieldObject form, string value)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
IFormFieldObject |
form |
|
System.String |
value |
|
Declaration
public void SetMetadata(IPdfDocumentId id, string name, string value)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.String |
name |
|
System.String |
value |
|
Declaration
public void SetMetadataDict(IPdfDocumentId id, Dictionary<string, string> metadataDict)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.Dictionary<System.String, System.String> |
metadataDict |
|
Declaration
public void SetPageRotation(IPdfDocumentId id, IEnumerable<int> pages, PdfPageRotation rotation)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Collections.Generic.IEnumerable<System.Int32> |
pages |
|
PdfPageRotation |
rotation |
|
SetPermissions(IPdfDocumentId, PdfDocumentPermissions, String, String)
Declaration
public IPdfDocumentId SetPermissions(IPdfDocumentId id, PdfDocumentPermissions permissions, string ownerPassword, string userPassword)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
PdfDocumentPermissions |
permissions |
|
System.String |
ownerPassword |
|
System.String |
userPassword |
|
Returns
Type |
Description |
IronSoftware.IPdfDocumentId |
|
Declaration
public void StampBackgroundWatermark(IPdfDocumentId id, Image<Rgba32> bitmap)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32> |
bitmap |
|
Declaration
public void StampFooterWatermark(IPdfDocumentId id, Image<Rgba32> bitmap, string licensingUrl = null)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgba32> |
bitmap |
|
System.String |
licensingUrl |
|
TransformPage(IPdfDocumentId, Int32, Double, Double, Double, Double)
Declaration
public void TransformPage(IPdfDocumentId id, int page_index, double translate_x, double translate_y, double scale_x, double scale_y)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
System.Int32 |
page_index |
|
System.Double |
translate_x |
|
System.Double |
translate_y |
|
System.Double |
scale_x |
|
System.Double |
scale_y |
|
UnEmbedFont(IPdfDocumentId, IDocumentFontObject)
Declaration
public uint UnEmbedFont(IPdfDocumentId id, IDocumentFontObject font)
Parameters
Type |
Name |
Description |
IronSoftware.IPdfDocumentId |
id |
|
IronSoftware.Abstractions.IDocumentFontObject |
font |
|
Returns
Type |
Description |
System.UInt32 |
|
Declaration
public void UpdateFormField(IPdfDocumentId id, IFormFieldObject form)
Parameters
Declaration
public void UpdateFormFieldAnnotation(IPdfDocumentId id, IFormFieldObject form, IFormFieldAnnotation annot)
Parameters
Implements
System.IDisposable