Class Image

Image annotations are images that are added to a document.

Inheritance
object
AnnotationBase
Image
Implements
Inherited Members
Namespace: PSPDFKit.Sdk.Models.Annotation
Assembly: Sdk.dll
Syntax
public sealed class Image : AnnotationBase, IAnnotation

Properties

| Edit this page View Source

ContentType

The content type of the connected attachment binary data.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
public string ContentType { get; set; }
Property Value
Type Description
string
Remarks

We currently support:

  • image/jpeg
  • image/png
  • application/pdf
| Edit this page View Source

Description

Description of the image content.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
public string Description { get; set; }
Property Value
Type Description
string
| Edit this page View Source

FileName

The file name of the attached file.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
public string FileName { get; }
Property Value
Type Description
string
| Edit this page View Source

ImageAttachmentId

The attachment identifier of the image. It holds the image data as binary.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
public string ImageAttachmentId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

IsSignature

Indicates whether the image annotation is a signature.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IsSignature { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Rotation

The rotation of the annotation. Can either be 0°, 90°, 180°, or 270°.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public int Rotation { get; set; }
Property Value
Type Description
int

Implements

IAnnotation