Click or drag to resize
Pdftools logo

LineAnnotationCreate Method

Create a line annotation.

The returned line annotation is not yet part of any page. It can be added to a page's list of annotations.

Namespace: PdfTools.Toolbox.Pdf.Annotations
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.4.0+02318d3e3f9645a1305b87026fb971a660079e54
Syntax
C#
public static LineAnnotation Create(
	Document targetDocument,
	Point start,
	Point end,
	Stroke stroke
)

Parameters

targetDocument  Document
The output document with which the returned object is associated.
start  Point
The line's start point.
end  Point
The line's end point.
stroke  Stroke
The stroking parameters used for stroking the line. The stroking paint is used as the annotation's main paint.

Return Value

LineAnnotation
The newly created line annotation.
Exceptions
ExceptionCondition
ArgumentExceptionif the targetDocument has already been closed
ArgumentExceptionif the targetDocument is read-only
ArgumentExceptionif the stroke argument is not associated with the targetDocument
ArgumentExceptionif the stroke's Paint has a ColorSpace other than a device color space
ArgumentExceptionif the stroke's Paint has a non-Transparency with BlendMode other than Normal
ArgumentExceptionif the stroke argument's LineCapStyle is other than Butt
ArgumentExceptionif the stroke argument's LineJoinStyle is other than Miter
ArgumentExceptionif the stroke argument's MiterLimit is other than 10
ArgumentExceptionif the stroke argument's DashPhase is other than 0
ArgumentNullExceptionif targetDocument is .
ArgumentNullExceptionif stroke is .
See Also