PdfRenderer.Page.AddPageAnnotation(PdfAnnotation) Method

Definition

Namespace:: Android.Graphics.Pdf

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds the given annotation to the page.

[Android.Runtime.Register("addPageAnnotation", "(Landroid/graphics/pdf/component/PdfAnnotation;)I", "", ApiSince=36)]
public int AddPageAnnotation(Android.Graphics.Pdf.Component.PdfAnnotation annotation);

[<Android.Runtime.Register("addPageAnnotation", "(Landroid/graphics/pdf/component/PdfAnnotation;)I", "", ApiSince=36)>]
member this.AddPageAnnotation : Android.Graphics.Pdf.Component.PdfAnnotation -> int

Parameters

annotation: PdfAnnotation

the PdfAnnotation object to add

Returns

Int32

id of the added annotation, or -1 if the annotation cannot be added. The id is guaranteed to be non-negative if the annotation is added successfully.

Attributes: RegisterAttribute

Remarks

Adds the given annotation to the page. The annotation should be of supported type. See PdfAnnotationType for the supported types

PdfRenderer#write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer#write.

Java documentation for android.graphics.pdf.PdfRenderer.Page.addPageAnnotation(android.graphics.pdf.component.PdfAnnotation).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to