pdftools_toolbox.pdf.annotations.underline

Classes

Underline(handle)

An text underlining annotation

class pdftools_toolbox.pdf.annotations.underline.Underline(handle)

Bases: TextMarkup

An text underlining annotation

static create_from_quadrilaterals(target_document: Document, markup_area: QuadrilateralList, paint: Paint) → Underline

Create a new underline with defined area

The area to be underlined is defined by the given markupArea. The returned object is associated with the targetDocument but not yet part of any page. It can be added to a page’s list of annotations.

Parameters:

• targetDocument (pdftools_toolbox.pdf.document.Document) – The document in which the links is used

• markupArea (pdftools_toolbox.geometry.real.quadrilateral_list.QuadrilateralList) – The area on the page to be underlined.

• paint (pdftools_toolbox.pdf.content.paint.Paint) – The paint used for drawing the underline

Returns:

The newly created object

Return type:

pdftools_toolbox.pdf.annotations.underline.Underline

Raises:

• ValueError – if the targetDocument has already been closed

• ValueError – if the targetDocument is read-only

• ValueError – if the markupArea is empty

• ValueError – if the paint argument is not associated with targetDocument

• ValueError – if the paint argument has a pdftools_toolbox.pdf.content.paint.Paint.color_space other than a device color space

• ValueError – if the paint argument has a non-Nonepdftools_toolbox.pdf.content.paint.Paint.transparency with pdftools_toolbox.pdf.content.transparency.Transparency.blend_mode other than pdftools_toolbox.pdf.content.blend_mode.BlendMode.NORMAL