Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Annotation

Hierarchy

  • Annotation

Implements

Index

Constructors

constructor

  • new Annotation(page: IPage, type: NPdfAnnotation.Text | NPdfAnnotation.Link | NPdfAnnotation.FreeText | NPdfAnnotation.Line | NPdfAnnotation.Square | NPdfAnnotation.Circle | NPdfAnnotation.Polygon | NPdfAnnotation.PolyLine | NPdfAnnotation.Highlight | NPdfAnnotation.Underline | NPdfAnnotation.Squiggly | NPdfAnnotation.StrikeOut | NPdfAnnotation.Stamp | NPdfAnnotation.Caret | NPdfAnnotation.Ink | NPdfAnnotation.Popup | NPdfAnnotation.FileAttachement | NPdfAnnotation.Sound | NPdfAnnotation.Movie | NPdfAnnotation.Widget | NPdfAnnotation.Screen | NPdfAnnotation.PrinterMark | NPdfAnnotation.TrapNet | NPdfAnnotation.Watermark | NPdfAnnotation._3D | NPdfAnnotation.RichMedia | NPdfAnnotation.WebMedia, rect: IRect): Annotation
  • Parameters

    • page: IPage
    • type: NPdfAnnotation.Text | NPdfAnnotation.Link | NPdfAnnotation.FreeText | NPdfAnnotation.Line | NPdfAnnotation.Square | NPdfAnnotation.Circle | NPdfAnnotation.Polygon | NPdfAnnotation.PolyLine | NPdfAnnotation.Highlight | NPdfAnnotation.Underline | NPdfAnnotation.Squiggly | NPdfAnnotation.StrikeOut | NPdfAnnotation.Stamp | NPdfAnnotation.Caret | NPdfAnnotation.Ink | NPdfAnnotation.Popup | NPdfAnnotation.FileAttachement | NPdfAnnotation.Sound | NPdfAnnotation.Movie | NPdfAnnotation.Widget | NPdfAnnotation.Screen | NPdfAnnotation.PrinterMark | NPdfAnnotation.TrapNet | NPdfAnnotation.Watermark | NPdfAnnotation._3D | NPdfAnnotation.RichMedia | NPdfAnnotation.WebMedia
    • rect: IRect

    Returns Annotation

Properties

Private _color

_color: NPdfRgb

Private _flag

_flag: NpdfAnnotationFlag.Invisible | NpdfAnnotationFlag.Hidden | NpdfAnnotationFlag.Print | NpdfAnnotationFlag.NoZoom | NpdfAnnotationFlag.NoRotate | NpdfAnnotationFlag.NoView | NpdfAnnotationFlag.ReadOnly | NpdfAnnotationFlag.Locked | NpdfAnnotationFlag.ToggleNoView | NpdfAnnotationFlag.LockedContents

Private _instance

_instance: any

Private _quadPoints

_quadPoints: Array<number>

Private _title

_title: string

Accessors

color

  • get color(): Object
  • set color(value: NPdfRgb): void

flag

  • get flag(): NpdfAnnotationFlag.Invisible | NpdfAnnotationFlag.Hidden | NpdfAnnotationFlag.Print | NpdfAnnotationFlag.NoZoom | NpdfAnnotationFlag.NoRotate | NpdfAnnotationFlag.NoView | NpdfAnnotationFlag.ReadOnly | NpdfAnnotationFlag.Locked | NpdfAnnotationFlag.ToggleNoView | NpdfAnnotationFlag.LockedContents
  • set flag(value: NpdfAnnotationFlag.Invisible | NpdfAnnotationFlag.Hidden | NpdfAnnotationFlag.Print | NpdfAnnotationFlag.NoZoom | NpdfAnnotationFlag.NoRotate | NpdfAnnotationFlag.NoView | NpdfAnnotationFlag.ReadOnly | NpdfAnnotationFlag.Locked | NpdfAnnotationFlag.ToggleNoView | NpdfAnnotationFlag.LockedContents): void
  • Returns NpdfAnnotationFlag.Invisible | NpdfAnnotationFlag.Hidden | NpdfAnnotationFlag.Print | NpdfAnnotationFlag.NoZoom | NpdfAnnotationFlag.NoRotate | NpdfAnnotationFlag.NoView | NpdfAnnotationFlag.ReadOnly | NpdfAnnotationFlag.Locked | NpdfAnnotationFlag.ToggleNoView | NpdfAnnotationFlag.LockedContents

  • Parameters

    • value: NpdfAnnotationFlag.Invisible | NpdfAnnotationFlag.Hidden | NpdfAnnotationFlag.Print | NpdfAnnotationFlag.NoZoom | NpdfAnnotationFlag.NoRotate | NpdfAnnotationFlag.NoView | NpdfAnnotationFlag.ReadOnly | NpdfAnnotationFlag.Locked | NpdfAnnotationFlag.ToggleNoView | NpdfAnnotationFlag.LockedContents

    Returns void

quadPoints

  • get quadPoints(): number[]
  • set quadPoints(value: Array<number>): void

title

  • get title(): string
  • set title(value: string): void

Methods

getType

  • getType(): "Text" | "Link" | "FreeText" | "Line" | "Square" | "Circle" | "Polygon" | "PolyLine" | "Highlight" | "Underline" | "Squiggly" | "StrikeOut" | "Stamp" | "Caret" | "Ink" | "Popup" | "FileAttachment" | "Sound" | "Movie" | "Widget" | "Screen" | "PrinterMark" | "TrapNet" | "Watermark" | "3D" | "RichMedia" | "WebMedia"
  • Returns "Text" | "Link" | "FreeText" | "Line" | "Square" | "Circle" | "Polygon" | "PolyLine" | "Highlight" | "Underline" | "Squiggly" | "StrikeOut" | "Stamp" | "Caret" | "Ink" | "Popup" | "FileAttachment" | "Sound" | "Movie" | "Widget" | "Screen" | "PrinterMark" | "TrapNet" | "Watermark" | "3D" | "RichMedia" | "WebMedia"

hasAction

  • hasAction(): boolean

hasAppearanceStream

  • hasAppearanceStream(): boolean

hasDestination

  • hasDestination(): boolean

hasFileAttachment

  • hasFileAttachment(): boolean

setBorderStyle

  • setBorderStyle(horizontalRadius: number, verticalRadius: number, width: number): void

setFileAttachment

  • setFileAttachment(): void

Generated using TypeDoc