Specifying the characteristics of the annotation’s border. More...

Inheritance diagram for iText.Kernel.Pdf.PdfAnnotationBorder:

Public Member Functions
	PdfAnnotationBorder (float hRadius, float vRadius, float width)
	Creates a PdfAnnotationBorder with three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units. More...

	PdfAnnotationBorder (float hRadius, float vRadius, float width, PdfDashPattern dash)
	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. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfArray >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual void	Flush ()

virtual bool	IsFlushed ()

Package Functions
override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfArray >
	PdfObjectWrapper (T pdfObject)

virtual void	SetPdfObject (T pdfObject)

virtual void	SetForbidRelease ()

virtual void	UnsetForbidRelease ()

virtual void	EnsureUnderlyingObjectHasIndirectReference ()

Additional Inherited Members
Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfArray >
static void	MarkObjectAsIndirect (PdfObject pdfObject)

static void	EnsureObjectIsAddedToDocument (PdfObject @object)
	Some wrappers use object's indirect reference to obtain the `PdfDocument` to which the object belongs to. More...

Detailed Description

Specifying the characteristics of the annotation’s border.

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.

Constructor & Destructor Documentation

◆ PdfAnnotationBorder() [1/2]

iText.Kernel.Pdf.PdfAnnotationBorder.PdfAnnotationBorder	(	float	hRadius,
		float	vRadius,
		float	width
	)

inline

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

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.

Parameters

hRadius	horizontal corner radius
vRadius	vertical corner radius
width	width of the border

◆ PdfAnnotationBorder() [2/2]

iText.Kernel.Pdf.PdfAnnotationBorder.PdfAnnotationBorder	(	float	hRadius,
		float	vRadius,
		float	width,
		PdfDashPattern	dash
	)

inline

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.

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.

Parameters

hRadius	horizontal corner radius
vRadius	vertical corner radius
width	width of the border
dash	the dash pattern

Member Function Documentation

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.PdfAnnotationBorder.IsWrappedObjectMustBeIndirect ( )

inlinepackagevirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns: true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfArray >.

Public Member Functions