Interface IAnnotation
This Interface represents an annotation.
Namespace: PSPDFKit.Pdf.Annotation
Assembly: PSPDFKit.dll
Syntax
public interface IAnnotation
Properties
AnnotationType
The type of the annotation.
Declaration
AnnotationType AnnotationType { get; }
Property Value
Type | Description |
---|---|
AnnotationType |
BlendMode
The blend mode to use when rendering.
Declaration
BlendMode BlendMode { get; set; }
Property Value
Type | Description |
---|---|
BlendMode |
BoundingBox
The bounding box of the annotation within the page.
Declaration
Rect BoundingBox { get; set; }
Property Value
Type | Description |
---|---|
Windows.Foundation.Rect |
CreatedAt
The date of the annotation creation.
Declaration
DateTimeOffset CreatedAt { get; set; }
Property Value
Type | Description |
---|---|
System.DateTimeOffset |
CreatorName
The name of the creator of the annotation. This is a general purpose string which can easily be spoofed and might not reflect the actual creator of the annotation.
Declaration
string CreatorName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CustomData
Annotations can store additional user-specified data.
PSPDFKit does not use or evaluate CustomData
in the UI directly.
You have full control over this property.
For a new annotation, this defaults to a null object.
Declaration
JsonObject CustomData { get; set; }
Property Value
Type | Description |
---|---|
Windows.Data.Json.JsonObject |
Id
A unique identifier to describe the annotation.
Declaration
string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Name
An optional field that may be used to identify the annotation. By default it is set that to the same value as the automatically generated Id.
Declaration
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
NoPrint
If the annotation should be printed or not.
Declaration
bool NoPrint { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
NoView
The property that determines if the annotation is prevented from being rendered in the UI. The annotation may still be rendered in a printed page, depending of the value of NoPrint.
Declaration
bool NoView { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Opacity
The opacity of the annotation, 0.0 - 1.0.
Declaration
float Opacity { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
PageIndex
The page index of the annotation in the document.
Declaration
int PageIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
PdfObjectId
The Pdf object ID, if the annotation is included in a Pdf file.
Declaration
int? PdfObjectId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
UpdatedAt
The date of last annotation update.
Declaration
DateTimeOffset UpdatedAt { get; set; }
Property Value
Type | Description |
---|---|
System.DateTimeOffset |
Version
The Instant JSON spec version this annotation is compliant to.
Declaration
int Version { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
ToJson()
Converts the annotation to the Instant JSON annotation format. See https://pspdfkit.com/guides/server/current/document/json-format/
Declaration
JsonObject ToJson()
Returns
Type | Description |
---|---|
Windows.Data.Json.JsonObject | The annotation object. |