Click or drag to resize
Pdftools logo

InkAnnotationCreate Method

Create a ink annotation.

The returned ink 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 InkAnnotation Create(
	Document targetDocument,
	Path path,
	Stroke stroke
)

Parameters

targetDocument  Document
The output document with which the returned object is associated.
path  Path
The path of the free-hand drawing.
stroke  Stroke
The stroking parameters used for stroking the line. The stroking paint is used as the annotation's main paint.

Return Value

InkAnnotation
The newly created ink annotation.
Exceptions
ExceptionCondition
ArgumentExceptionif the targetDocument has already been closed
ArgumentExceptionif the targetDocument is read-only
ArgumentExceptionif the path argument has not been constructed with a PathGenerator
ArgumentExceptionif the targetDocument's conformance is not PDF 2.0 and the path argument contains curve-to operations
ArgumentExceptionif the path argument contains rectangle operations
UnsupportedFeatureExceptionif the targetDocument's conformance is PDF 2.0 and the path argument contains curve-to operations
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 dash array is not empty
ArgumentExceptionif the stroke argument's DashPhase is other than 0
ArgumentExceptionif the stroke argument is not associated with the targetDocument
ArgumentNullExceptionif targetDocument is .
ArgumentNullExceptionif path is .
ArgumentNullExceptionif stroke is .
See Also