pdftools_toolbox.pdf.annotations.rectangle_annotation

Classes

RectangleAnnotation(handle)

A rectangle drawing annotation

class pdftools_toolbox.pdf.annotations.rectangle_annotation.RectangleAnnotation(handle)

Bases: DrawingAnnotation

A rectangle drawing annotation

static create(target_document: Document, bounding_box: Rectangle, stroke: Stroke | None, fill: Paint | None) → RectangleAnnotation

Create a rectangle annotation.

The returned rectangle annotation is 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 output document with which the returned object is associated.

• boundingBox (pdftools_toolbox.geometry.real.rectangle.Rectangle) – The location on the page.

• stroke (Optional[pdftools_toolbox.pdf.content.stroke.Stroke]) – The stroking parameters used for stroking the rectangle. The stroking paint is used as the annotation’s main paint. If None then the rectangle is not stroked.

• fill (Optional[pdftools_toolbox.pdf.content.paint.Paint]) – The paint used for filling the rectangle. If None then the rectangle is not filled.

Returns:

The newly created rectangle annotation.

Return type:

pdftools_toolbox.pdf.annotations.rectangle_annotation.RectangleAnnotation

Raises:

• ValueError – if the targetDocument is None

• ValueError – if the targetDocument is read-only

• ValueError – if the stroke and fill arguments are both None

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

• ValueError – if the stroke’s pdftools_toolbox.pdf.content.stroke.Stroke.paint has a pdftools_toolbox.pdf.content.paint.Paint.color_space other than a device color space

• ValueError – if the stroke’s pdftools_toolbox.pdf.content.stroke.Stroke.paint 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

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.line_cap_style is other than pdftools_toolbox.pdf.content.line_cap_style.LineCapStyle.BUTT

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.line_join_style is other than pdftools_toolbox.pdf.content.line_join_style.LineJoinStyle.MITER

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.miter_limit is other than 10

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.dash_phase is other than 0

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

• ValueError – if the fill 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

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

property fill: Paint

The filling paint

Returns:

pdftools_toolbox.pdf.content.paint.Paint

Raises:

StateError – if the object has already been closed