Class PdfAnnotationBorder

Namespace

iText.Kernel.Pdf

Assembly

itext.kernel.dll

Specifying the characteristics of the annotation’s border.

public class PdfAnnotationBorder : PdfObjectWrapper<PdfArray>

Inheritance

object

PdfObjectWrapper<PdfArray>

PdfAnnotationBorder

Inherited Members

PdfObjectWrapper<PdfArray>.GetPdfObject()

PdfObjectWrapper<PdfArray>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfArray>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfArray>.SetModified()

PdfObjectWrapper<PdfArray>.Flush()

PdfObjectWrapper<PdfArray>.IsFlushed()

PdfObjectWrapper<PdfArray>.SetPdfObject(PdfArray)

PdfObjectWrapper<PdfArray>.SetForbidRelease()

PdfObjectWrapper<PdfArray>.UnsetForbidRelease()

PdfObjectWrapper<PdfArray>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfArray>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfArray>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Specifying the characteristics of the annotation’s border. See ISO 32000-1 12.5.2, Table 164 - Entries common to all annotation dictionaries, Key - border.

Note (PDF 1.2): The dictionaries for some annotation types can include the BS (border style) entry. That entry specifies a border style dictionary that has more settings than this class. If an annotation has BS entry, then PdfAnnotationBorder is ignored.

Constructors

PdfAnnotationBorder(float, float, float)

Creates a PdfAnnotationBorder with three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units.

public PdfAnnotationBorder(float hRadius, float vRadius, float width)

Parameters

hRadius float

horizontal corner radius

vRadius float

vertical corner radius

width float

width of the border

Remarks

Creates a PdfAnnotationBorder with three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units. If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

PdfAnnotationBorder(float, float, float, PdfDashPattern)

Creates a PdfAnnotationBorder with three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units and a dash pattern for the border lines.

public PdfAnnotationBorder(float hRadius, float vRadius, float width, PdfDashPattern dash)

Parameters

hRadius float

horizontal corner radius

vRadius float

vertical corner radius

width float

width of the border

dash PdfDashPattern

the dash pattern

Remarks

Creates a PdfAnnotationBorder with three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units and a dash pattern for the border lines. If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

Methods

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool