Class PdfClient<T>

Inheritance

System.Object

PdfClient<T>

Implements

System.IDisposable

Namespace: IronSoftware.Pdfium

Assembly: IronPdf.dll

Syntax

public abstract class PdfClient<T> : Object, IDisposable, IPdfClient where T : PdfiumDeploymentBase

Type Parameters

Name	Description
T

Constructors

PdfClient(Boolean, String)

Declaration

protected PdfClient(bool deployPdfium = true, string directory = null)

Parameters

Type	Name	Description
System.Boolean	deployPdfium
System.String	directory

Methods

AddAttachment(IDocumentId, String)

Declaration

public int AddAttachment(IDocumentId id, string name)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	name

Returns

Type	Description
System.Int32

AddBookmark(IDocumentId, IPdfBookmark)

Declaration

public void AddBookmark(IDocumentId id, IPdfBookmark bookmark)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronPdf.Bookmarks.IPdfBookmark	bookmark

AddFont(IDocumentId, Byte[])

Declaration

public PdfFont AddFont(IDocumentId id, byte[] fontData)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Byte[]	fontData

Returns

Type	Description
PdfFont

AddFont(IDocumentId, String)

Declaration

public PdfFont AddFont(IDocumentId id, string standardFontName)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	standardFontName

Returns

Type	Description
PdfFont

AddFontIntoPageResources(IDocumentId, Int32, PdfFont)

Declaration

public string AddFontIntoPageResources(IDocumentId id, int pageIndex, PdfFont pdfFont)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
PdfFont	pdfFont

Returns

Type	Description
System.String

AddFormField(IDocumentId, IFormFieldObject)

Declaration

public int AddFormField(IDocumentId id, IFormFieldObject form)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form

Returns

Type	Description
System.Int32

AddFormFieldAnnotation(IDocumentId, IFormFieldObject, IFormFieldAnnotation)

Declaration

public int AddFormFieldAnnotation(IDocumentId id, IFormFieldObject form, IFormFieldAnnotation annot)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form
IFormFieldAnnotation	annot

Returns

Type	Description
System.Int32

AddLayersFromAnotherPdf(IDocumentId, LayerMode, IEnumerable<Int32>, IDocumentId, Int32)

Declaration

public void AddLayersFromAnotherPdf(IDocumentId destId, LayerMode layermode, IEnumerable<int> toPageIndexes, IDocumentId srcId, int backgroundPdfPageIndex = 0)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	destId
LayerMode	layermode
System.Collections.Generic.IEnumerable<System.Int32>	toPageIndexes
IronSoftware.IDocumentId	srcId
System.Int32	backgroundPdfPageIndex

AddLinkAnnotation(IDocumentId, String, String, Int32, Rectangle, Color, Boolean, Boolean)

Declaration

public void AddLinkAnnotation(IDocumentId id, string name, string url, int pageIndex, Rectangle rectangle = null, Color color = null, bool hidden = false, bool showBorder = false)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	name
System.String	url
System.Int32	pageIndex
IronSoftware.Drawing.Rectangle	rectangle
IronSoftware.Drawing.Color	color
System.Boolean	hidden
System.Boolean	showBorder

AddPage(IDocumentId, Double, Double)

Declaration

public int AddPage(IDocumentId id, double width, double height)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Double	width
System.Double	height

Returns

Type	Description
System.Int32

AddSignature(IDocumentId, PdfSignature, Int32, SignaturePermissions)

Declaration

public int AddSignature(IDocumentId id, PdfSignature signature, int pageIndex, SignaturePermissions perms)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
PdfSignature	signature
System.Int32	pageIndex
SignaturePermissions	perms

Returns

Type	Description
System.Int32

AddSignatureImage(IDocumentId, Image<Rgba32>, Int32, Int32, Double, Double, Double, Double)

Declaration

public void AddSignatureImage(IDocumentId id, Image<Rgba32> bitmap, int pageIndex, int signatureIndex, double x, double y, double desiredWidth, double desiredHeight)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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(IDocumentId, IAnnotation)

Declaration

public int AddTextAnnotation(IDocumentId id, IAnnotation annot)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IAnnotation	annot

Returns

Type	Description
System.Int32

AddTextHeadersAndFooters(IDocumentId, IHeaderFooter, IEnumerable<Int32>, String, String, String)

Declaration

public void AddTextHeadersAndFooters(IDocumentId id, IHeaderFooter options, IEnumerable<int> pages, string url, string htmlTitle, string pdfTitle)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronPdf.IHeaderFooter	options
System.Collections.Generic.IEnumerable<System.Int32>	pages
System.String	url
System.String	htmlTitle
System.String	pdfTitle

CloseDocument(IDocumentId)

Declaration

public int CloseDocument(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Int32

CombinePages(IDocumentId, Double, Double, Int32, Int32, Boolean)

Declaration

public IDocumentId CombinePages(IDocumentId id, double width, double height, int cols, int rows, bool draw_borders)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Double	width
System.Double	height
System.Int32	cols
System.Int32	rows
System.Boolean	draw_borders

Returns

Type	Description
IronSoftware.IDocumentId

CompressImages(IDocumentId, Int32, Boolean, Boolean)

Declaration

public void CompressImages(IDocumentId id, int quality, bool useVisible, bool useHighQualitySampling)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	quality
System.Boolean	useVisible
System.Boolean	useHighQualitySampling

ConvertToPdfA(IDocumentId, Byte[], Int32, Boolean)

Declaration

public void ConvertToPdfA(IDocumentId id, byte[] iccBytes, int convtVer, bool isAVariant)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Byte[]	iccBytes
System.Int32	convtVer
System.Boolean	isAVariant

ConvertToPdfUA(IDocumentId, Int32)

Declaration

public void ConvertToPdfUA(IDocumentId id, int naturalLangIndex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	naturalLangIndex

ConvertToPdfUAForScreenReader(IDocumentId, String, Int32)

Declaration

public void ConvertToPdfUAForScreenReader(IDocumentId id, string htmlDom, int naturalLangIndex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	htmlDom
System.Int32	naturalLangIndex

CopyPages(IDocumentId, IEnumerable<Int32>)

Declaration

public IDocumentId CopyPages(IDocumentId srcId, IEnumerable<int> pageIndexes)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	srcId
System.Collections.Generic.IEnumerable<System.Int32>	pageIndexes

Returns

Type	Description
IronSoftware.IDocumentId

Dispose()

Declaration

public virtual void Dispose()

DrawImage(IDocumentId, Image<Rgba32>, Int32, Double, Double, Double, Double, PixelFormat)

Declaration

public void DrawImage(IDocumentId id, Image<Rgba32> bitmap, int pageIndex, double x, double y, double desiredWidth, double desiredHeight, PixelFormat format)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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

DrawImages(IDocumentId, Image<Rgba32>, List<Int32>, List<Double>, List<Double>, List<Double>, List<Double>, PixelFormat)

Declaration

public void DrawImages(IDocumentId 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.IDocumentId	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(IDocumentId, Int32, PointF, PointF, Double, Color)

Declaration

public void DrawLine(IDocumentId id, int page_index, PointF start, PointF end, double width, Color color)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index
IronSoftware.Drawing.PointF	start
IronSoftware.Drawing.PointF	end
System.Double	width
IronSoftware.Drawing.Color	color

DrawPath(IDocumentId, Int32, IDocumentPathObject)

Declaration

public void DrawPath(IDocumentId id, int page_index, IDocumentPathObject path)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index
IronSoftware.IDocumentPathObject	path

DrawRectangle(IDocumentId, Int32, RectangleF, Color, Color, Double)

Declaration

public void DrawRectangle(IDocumentId id, int page_index, RectangleF rect, Color line_color, Color fill_color, double line_width)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index
IronSoftware.Drawing.RectangleF	rect
IronSoftware.Drawing.Color	line_color
IronSoftware.Drawing.Color	fill_color
System.Double	line_width

DrawText(IDocumentId, Int32, IDocumentTextObject)

Declaration

public void DrawText(IDocumentId id, int page_index, IDocumentTextObject text)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index
IronSoftware.IDocumentTextObject	text

DrawText(IDocumentId, String, PdfFont, Double, Int32, Double, Double, Color, Double, Double)

Declaration

public void DrawText(IDocumentId id, string text, PdfFont pdfFont, double fontSize, int pageIndex, double x, double y, Color color, double scale, double rotation)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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(IDocumentId, IAnnotation)

Declaration

public void EditTextAnnotation(IDocumentId id, IAnnotation annot)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IAnnotation	annot

EmbedFileToPdfA(IDocumentId, Byte[], String, String, Int32, Int32, Int32, Int32, Int32, Int32)

Declaration

public void EmbedFileToPdfA(IDocumentId id, byte[] embedFileBytes, string embedFileName, string afDesc, int conformLvlIdx, int docTypeIdx, int propVerIdx, int schNamespaceIdx, int schPrefixIdx, int afRelIdx)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Byte[]	embedFileBytes
System.String	embedFileName
System.String	afDesc
System.Int32	conformLvlIdx
System.Int32	docTypeIdx
System.Int32	propVerIdx
System.Int32	schNamespaceIdx
System.Int32	schPrefixIdx
System.Int32	afRelIdx

EmbedFont(IDocumentId, UInt32, Byte[], FontType)

Declaration

public bool EmbedFont(IDocumentId id, uint objNum, byte[] fontData, FontType embedAsType)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.UInt32	objNum
System.Byte[]	fontData
FontType	embedAsType

Returns

Type	Description
System.Boolean

ExtendPageSize(IDocumentId, Int32, Double, Double, Double, Double)

Declaration

public void ExtendPageSize(IDocumentId id, int pageIndex, double left, double right, double top, double bottom)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.Double	left
System.Double	right
System.Double	top
System.Double	bottom

Finalize()

Declaration

protected override void Finalize()

FindFonts(IDocumentId, String)

Declaration

public PdfFontCollection FindFonts(IDocumentId id, string regex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	regex

Returns

Type	Description
PdfFontCollection

FlattenPages(IDocumentId, IEnumerable<Int32>, PdfFlattenStyles)

Declaration

public List<PdfFlattenResults> FlattenPages(IDocumentId id, IEnumerable<int> pages, PdfFlattenStyles style)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Collections.Generic.IEnumerable<System.Int32>	pages
PdfFlattenStyles	style

Returns

Type	Description
System.Collections.Generic.List<PdfFlattenResults>

FreeBytes(IntPtr, Boolean)

Declaration

public void FreeBytes(IntPtr pointer, bool is_array)

Parameters

Type	Name	Description
System.IntPtr	pointer
System.Boolean	is_array

GetAnnotationCount(IDocumentId, Int32)

Declaration

public int GetAnnotationCount(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

Returns

Type	Description
System.Int32

GetAnnotations(IDocumentId, Int32)

Declaration

public List<PdfAnnotation> GetAnnotations(IDocumentId id, int pageIndex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex

Returns

Type	Description
System.Collections.Generic.List<PdfAnnotation>

GetAttachmentCount(IDocumentId)

Declaration

public int GetAttachmentCount(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Int32

GetAttachmentData(IDocumentId, Int32)

Declaration

public byte[] GetAttachmentData(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

Returns

Type	Description
System.Byte[]

GetAttachmentName(IDocumentId, Int32)

Declaration

public string GetAttachmentName(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

Returns

Type	Description
System.String

GetBookmarks(IDocumentId)

Declaration

public List<PdfiumBookmarkDescriptor> GetBookmarks(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Collections.Generic.List<PdfiumBookmarkDescriptor>

GetBytes(IDocumentId, Boolean, AnyBitmap, AnyBitmap, List<PdfSignature>, String)

Declaration

public byte[] GetBytes(IDocumentId id, bool incremental, AnyBitmap backgroundWatermark = null, AnyBitmap footerWatermark = null, List<PdfSignature> signatures = null, string footerWatermarkURL = null)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Boolean	incremental
IronSoftware.Drawing.AnyBitmap	backgroundWatermark
IronSoftware.Drawing.AnyBitmap	footerWatermark
System.Collections.Generic.List<PdfSignature>	signatures
System.String	footerWatermarkURL

Returns

Type	Description
System.Byte[]

GetCharacters(IDocumentId, Int32)

Declaration

public IDocumentCharCollection GetCharacters(IDocumentId id, int page_index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index

Returns

Type	Description
IronSoftware.IDocumentCharCollection

GetFontInfo(IDocumentId)

Declaration

public PdfFontCollection GetFontInfo(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
PdfFontCollection

GetFontInfoAt(IDocumentId, UInt32)

Declaration

public PdfFont GetFontInfoAt(IDocumentId id, uint objNum)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.UInt32	objNum

Returns

Type	Description
PdfFont

GetFormFields(IDocumentId)

Declaration

public FormFieldCollection GetFormFields(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
FormFieldCollection

GetImageObjects(IDocumentId, Int32)

Declaration

public ImageObjectCollection GetImageObjects(IDocumentId id, int page_index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index

Returns

Type	Description
ImageObjectCollection

GetMetadata(IDocumentId, String)

Declaration

public string GetMetadata(IDocumentId id, string name)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	name

Returns

Type	Description
System.String

GetMetadataDict(IDocumentId)

Declaration

public Dictionary<string, string> GetMetadataDict(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>

GetMetadataKeys(IDocumentId)

Declaration

public List<string> GetMetadataKeys(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetPageBounds(IDocumentId, Int32, ref Double, ref Double, ref Double, ref Double)

Declaration

public void GetPageBounds(IDocumentId id, int pageIndex, ref double left, ref double right, ref double top, ref double bottom)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.Double	left
System.Double	right
System.Double	top
System.Double	bottom

GetPageCount(IDocumentId)

Declaration

public int GetPageCount(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Int32

GetPageImages(IDocumentId, IEnumerable<Int32>, PdfImageExtractionOptions, out List<RectangleF>, out List<Int32>)

Declaration

public List<Image<Rgba32>> GetPageImages(IDocumentId id, IEnumerable<int> pages, PdfImageExtractionOptions options, out List<RectangleF> rects, out List<int> pageIndices)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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(IDocumentId)

Declaration

public IList<IPdfPage> GetPageInfo(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Collections.Generic.IList<IPdfPage>

GetPageInfo(IDocumentId, Int32)

Declaration

public IPdfPage GetPageInfo(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

Returns

Type	Description
IPdfPage

GetPageRotation(IDocumentId, Int32)

Declaration

public PdfPageRotation GetPageRotation(IDocumentId id, int pageIndex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex

Returns

Type	Description
PdfPageRotation

GetPageText(IDocumentId, IEnumerable<Int32>, Boolean, CancellationToken)

Declaration

public string GetPageText(IDocumentId id, IEnumerable<int> pages, bool isLicensed = true, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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

GetPathObjects(IDocumentId, Int32)

Declaration

public PathObjectCollection GetPathObjects(IDocumentId id, int page_index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index

Returns

Type	Description
PathObjectCollection

GetPermissions(IDocumentId)

Declaration

public PdfDocumentPermissions GetPermissions(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
PdfDocumentPermissions

GetRawPageImages(IDocumentId, IEnumerable<Int32>, PdfImageExtractionOptions, out List<RectangleF>)

Declaration

public List<byte[]> GetRawPageImages(IDocumentId id, IEnumerable<int> pages, PdfImageExtractionOptions options, out List<RectangleF> rects)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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(IDocumentId, Int32)

Declaration

public byte[] GetRevision(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

Returns

Type	Description
System.Byte[]

GetRevisionCount(IDocumentId)

Declaration

public int GetRevisionCount(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Int32

GetSignatureByteRange(IDocumentId, Int32)

Declaration

public int[] GetSignatureByteRange(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

Returns

Type	Description
System.Int32[]

GetSignatureCount(IDocumentId)

Declaration

public int GetSignatureCount(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Int32

GetTextAnnotation(IDocumentId, Int32, Int32)

Declaration

public IAnnotation GetTextAnnotation(IDocumentId id, int pageIndex, int annotationIndex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.Int32	annotationIndex

Returns

Type	Description
IAnnotation

GetTextObjects(IDocumentId, Int32)

Declaration

public TextObjectCollection GetTextObjects(IDocumentId id, int page_index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index

Returns

Type	Description
TextObjectCollection

GetVerifiedSignatures(IDocumentId, Byte[])

Declaration

public List<VerifiedSignature> GetVerifiedSignatures(IDocumentId id, byte[] data)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Byte[]	data

Returns

Type	Description
System.Collections.Generic.List<VerifiedSignature>

IncrementReference(IDocumentId)

Declaration

public int IncrementReference(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

Returns

Type	Description
System.Int32

InsertPdf(IDocumentId, IDocumentId, Int32)

Declaration

public void InsertPdf(IDocumentId destId, IDocumentId srcId, int atIndex = 0)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	destId
IronSoftware.IDocumentId	srcId
System.Int32	atIndex

Merge(IEnumerable<IDocumentId>)

Declaration

public IDocumentId Merge(IEnumerable<IDocumentId> pdfs)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IronSoftware.IDocumentId>	pdfs

Returns

Type	Description
IronSoftware.IDocumentId

MergePageObjectsAppend(IDocumentId, Int32, IDocumentId, Int32, Boolean)

Declaration

public void MergePageObjectsAppend(IDocumentId srcId, int srcPageIndex, IDocumentId destId, int destPageIndex, bool copyAnnotations)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	srcId
System.Int32	srcPageIndex
IronSoftware.IDocumentId	destId
System.Int32	destPageIndex
System.Boolean	copyAnnotations

MergePageObjectsPrepend(IDocumentId, Int32, IDocumentId, Int32, Boolean)

Declaration

public void MergePageObjectsPrepend(IDocumentId srcId, int srcPageIndex, IDocumentId destId, int destPageIndex, bool copyAnnotations)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	srcId
System.Int32	srcPageIndex
IronSoftware.IDocumentId	destId
System.Int32	destPageIndex
System.Boolean	copyAnnotations

OpenDocument(Stream, String, String, ChangeTrackingModes)

Declaration

public IDocumentId 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.IDocumentId

OpenDocument(ReadOnlySpan<Byte>, String, String, ChangeTrackingModes)

Declaration

public IDocumentId 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.IDocumentId

OpenDocument(String, String, String, ChangeTrackingModes)

Declaration

public IDocumentId 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.IDocumentId

OpenDocumentFromJobResult(Int32, String, String)

Declaration

public IDocumentId 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.IDocumentId

OpenDocumentFromJobResultWithoutForms(Int32, String)

Declaration

public IDocumentId OpenDocumentFromJobResultWithoutForms(int jobId, string password)

Parameters

Type	Name	Description
System.Int32	jobId
System.String	password

Returns

Type	Description
IronSoftware.IDocumentId

OpenEmptyDocument(Double, Double)

Declaration

public IDocumentId OpenEmptyDocument(double width, double height)

Parameters

Type	Name	Description
System.Double	width
System.Double	height

Returns

Type	Description
IronSoftware.IDocumentId

RedactRegions(IDocumentId, Int32, IEnumerable<RectangleF>, Boolean)

Declaration

public void RedactRegions(IDocumentId id, int pageIndex, IEnumerable<RectangleF> regions, bool isDrawBoxes)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.Collections.Generic.IEnumerable<IronSoftware.Drawing.RectangleF>	regions
System.Boolean	isDrawBoxes

RedactText(IDocumentId, Int32, String, Boolean, Boolean, String, Boolean)

Declaration

public void RedactText(IDocumentId id, int pageIndex, string replaceText, bool isDrawBoxes, bool isMatchWholeWord, string filler_text, bool isCaseSensitive)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.String	replaceText
System.Boolean	isDrawBoxes
System.Boolean	isMatchWholeWord
System.String	filler_text
System.Boolean	isCaseSensitive

RemoveAnnotation(IDocumentId, Int32, Int32)

Declaration

public int RemoveAnnotation(IDocumentId id, int pageIndex, int annotIndex)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.Int32	annotIndex

Returns

Type	Description
System.Int32

RemoveAttachment(IDocumentId, Int32)

Declaration

public void RemoveAttachment(IDocumentId id, int index)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index

RemoveBookmark(IDocumentId, IPdfBookmark)

Declaration

public void RemoveBookmark(IDocumentId id, IPdfBookmark bookmark)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronPdf.Bookmarks.IPdfBookmark	bookmark

RemoveBookmarks(IDocumentId, List<IPdfBookmark>)

Declaration

public void RemoveBookmarks(IDocumentId id, List<IPdfBookmark> bookmarks)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Collections.Generic.List<IronPdf.Bookmarks.IPdfBookmark>	bookmarks

RemoveFont(IDocumentId, String)

Declaration

public uint RemoveFont(IDocumentId id, string fontName)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	fontName

Returns

Type	Description
System.UInt32

RemoveFormField(IDocumentId, IFormFieldObject)

Declaration

public void RemoveFormField(IDocumentId id, IFormFieldObject form)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form

RemoveFormFieldAnnotation(IDocumentId, IFormFieldObject, IFormFieldAnnotation)

Declaration

public void RemoveFormFieldAnnotation(IDocumentId id, IFormFieldObject form, IFormFieldAnnotation annot)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form
IFormFieldAnnotation	annot

RemoveImageObject(IDocumentId, IPdfImageObject)

Declaration

public void RemoveImageObject(IDocumentId id, IPdfImageObject image_object)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IPdfImageObject	image_object

RemoveMetadataKey(IDocumentId, String)

Declaration

public void RemoveMetadataKey(IDocumentId id, string key)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	key

RemovePages(IDocumentId, IEnumerable<Int32>)

Declaration

public int RemovePages(IDocumentId id, IEnumerable<int> pagesIn)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Collections.Generic.IEnumerable<System.Int32>	pagesIn

Returns

Type	Description
System.Int32

RemovePasswordsAndEncryption(IDocumentId)

Declaration

public void RemovePasswordsAndEncryption(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

RemovePathObject(IDocumentId, IDocumentPathObject)

Declaration

public void RemovePathObject(IDocumentId id, IDocumentPathObject path_object)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.IDocumentPathObject	path_object

RemoveSignatures(IDocumentId)

Declaration

public void RemoveSignatures(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

RemoveStructTree(IDocumentId)

Declaration

public void RemoveStructTree(IDocumentId id)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id

RemoveTextObject(IDocumentId, IDocumentTextObject)

Declaration

public void RemoveTextObject(IDocumentId id, IDocumentTextObject text_object)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.IDocumentTextObject	text_object

RenderPageImage(IDocumentId, Int32, Nullable<Int32>, Nullable<Int32>, BitmapRenderOptions, Int32, out Int32, out Int32, out Int32, Boolean)

Declaration

public IntPtr RenderPageImage(IDocumentId 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.IDocumentId	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

RenderPageImageHighQuality(IDocumentId, Int32, Nullable<Int32>, Nullable<Int32>, BitmapRenderOptions, Int32, out Int32, out Int32, out Int32, Boolean)

Declaration

public IntPtr RenderPageImageHighQuality(IDocumentId 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.IDocumentId	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(IDocumentId, IEnumerable<Int32>, Nullable<Int32>, Nullable<Int32>, BitmapRenderOptions, Int32, Boolean)

Declaration

public List<Image<Rgb24>> RenderPageImages(IDocumentId id, IEnumerable<int> pages, Nullable<int> maxWidthPx, Nullable<int> maxHeightPx, BitmapRenderOptions flags, int dpi, bool flatten)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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.Rgb24>>

RenderPageImagesHighQuality(IDocumentId, IEnumerable<Int32>, Nullable<Int32>, Nullable<Int32>, BitmapRenderOptions, Int32, Boolean)

Declaration

public List<Image<Rgba32>> RenderPageImagesHighQuality(IDocumentId id, IEnumerable<int> pages, Nullable<int> maxWidthPx, Nullable<int> maxHeightPx, BitmapRenderOptions flags, int dpi, bool flatten)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	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(IDocumentId, UInt32, Byte[], FontType)

Declaration

public uint ReplaceFont(IDocumentId id, uint objNum, byte[] fontData, FontType replacingFontType)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.UInt32	objNum
System.Byte[]	fontData
FontType	replacingFontType

Returns

Type	Description
System.UInt32

ReplaceFont(IDocumentId, UInt32, String)

Declaration

public uint ReplaceFont(IDocumentId id, uint objNum, string standardFontName)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.UInt32	objNum
System.String	standardFontName

Returns

Type	Description
System.UInt32

ReplaceText(IDocumentId, Int32, String, String, PdfFont, Single)

Declaration

public void ReplaceText(IDocumentId id, int pageIndex, string oldText, string newText, PdfFont pdfFont, float customFontSize)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.String	oldText
System.String	newText
PdfFont	pdfFont
System.Single	customFontSize

ResizePage(IDocumentId, Int32, Double, Double)

Declaration

public void ResizePage(IDocumentId id, int pageIndex, double width, double height)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	pageIndex
System.Double	width
System.Double	height

SetAttachmentData(IDocumentId, Int32, ReadOnlySpan<Byte>)

Declaration

public int SetAttachmentData(IDocumentId id, int index, ReadOnlySpan<byte> bytes)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	index
System.ReadOnlySpan<System.Byte>	bytes

Returns

Type	Description
System.Int32

SetFormFieldValue(IDocumentId, IFormFieldObject, String)

Declaration

public void SetFormFieldValue(IDocumentId id, IFormFieldObject form, string value)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form
System.String	value

SetMetadata(IDocumentId, String, String)

Declaration

public void SetMetadata(IDocumentId id, string name, string value)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.String	name
System.String	value

SetMetadataDict(IDocumentId, Dictionary<String, String>)

Declaration

public void SetMetadataDict(IDocumentId id, Dictionary<string, string> metadataDict)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Collections.Generic.Dictionary<System.String, System.String>	metadataDict

SetPageRotation(IDocumentId, IEnumerable<Int32>, PdfPageRotation)

Declaration

public void SetPageRotation(IDocumentId id, IEnumerable<int> pages, PdfPageRotation rotation)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Collections.Generic.IEnumerable<System.Int32>	pages
PdfPageRotation	rotation

SetPermissions(IDocumentId, PdfDocumentPermissions, String, String)

Declaration

public IDocumentId SetPermissions(IDocumentId id, PdfDocumentPermissions permissions, string ownerPassword, string userPassword)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
PdfDocumentPermissions	permissions
System.String	ownerPassword
System.String	userPassword

Returns

Type	Description
IronSoftware.IDocumentId

StampBackgroundWatermark(IDocumentId, AnyBitmap)

Declaration

public void StampBackgroundWatermark(IDocumentId id, AnyBitmap bitmap)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.Drawing.AnyBitmap	bitmap

StampFooterWatermark(IDocumentId, AnyBitmap, String)

Declaration

public void StampFooterWatermark(IDocumentId id, AnyBitmap bitmap, string licensingUrl = null)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.Drawing.AnyBitmap	bitmap
System.String	licensingUrl

TransformPage(IDocumentId, Int32, Double, Double, Double, Double)

Declaration

public void TransformPage(IDocumentId id, int page_index, double translate_x, double translate_y, double scale_x, double scale_y)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
System.Int32	page_index
System.Double	translate_x
System.Double	translate_y
System.Double	scale_x
System.Double	scale_y

UnEmbedFont(IDocumentId, IDocumentFontObject)

Declaration

public uint UnEmbedFont(IDocumentId id, IDocumentFontObject font)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.IDocumentFontObject	font

Returns

Type	Description
System.UInt32

UpdateFormField(IDocumentId, IFormFieldObject)

Declaration

public void UpdateFormField(IDocumentId id, IFormFieldObject form)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form

UpdateFormFieldAnnotation(IDocumentId, IFormFieldObject, IFormFieldAnnotation)

Declaration

public void UpdateFormFieldAnnotation(IDocumentId id, IFormFieldObject form, IFormFieldAnnotation annot)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IFormFieldObject	form
IFormFieldAnnotation	annot

UpdateImageObject(IDocumentId, IPdfImageObject)

Declaration

public void UpdateImageObject(IDocumentId id, IPdfImageObject image_object)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IPdfImageObject	image_object

UpdatePathObject(IDocumentId, IDocumentPathObject)

Declaration

public void UpdatePathObject(IDocumentId id, IDocumentPathObject path_object)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.IDocumentPathObject	path_object

UpdateTextObject(IDocumentId, IDocumentTextObject)

Declaration

public void UpdateTextObject(IDocumentId id, IDocumentTextObject text_object)

Parameters

Type	Name	Description
IronSoftware.IDocumentId	id
IronSoftware.IDocumentTextObject	text_object

Implements

System.IDisposable