API Reference
PdfAnnotation
Generic page annotation metadata read from a PDF page.
Inheritance
- Object
- PdfAnnotation
Usage
Explore 14 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 11
- Method PdfAnnotationGrouping.GetMembers
- Property PdfAnnotationReviewEntry.Annotation
- Method PdfDocumentAnnotations.GetForEditing
- Method PdfDocumentInfo.GetAnnotationsByActionType
- Method PdfDocumentInfo.GetAnnotationsBySubtype
- Property PdfDocumentInfo.Annotations
- Property PdfDocumentInfo.AnnotationsByActionType
- Property PdfDocumentInfo.AnnotationsBySubtype
- Property PdfLogicalPage.Annotations
- Property PdfPageInfo.Annotations
- Method PdfReadPage.GetAnnotations
Accepted by parameters 3
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32? ObjectNumber { get; } #Indirect annotation object number, when the annotation is referenced indirectly.
public String Subtype { get; } #PDF annotation subtype name, for example Link, Text, FreeText, or Highlight.
public String? Contents { get; } #Optional annotation contents metadata from /Contents.
public Double Y1 { get; } #Bottom edge of the annotation rectangle in PDF points.
public Boolean HasNormalAppearance { get; } #True when the annotation dictionary exposes a normal appearance stream through /AP /N.
public String? AppearanceState { get; } #Selected annotation appearance state from /AS, when present.
public String? ActionType { get; } #Primary annotation action type from /A /S, when present.
public IReadOnlyList<PdfAnnotationAdditionalAction> AdditionalActions { get; } #Additional annotation actions from the /AA dictionary, when present.
public IReadOnlyList<PdfAnnotationChainedAction> ChainedActions { get; } #Chained annotation actions discovered through /Next entries on /A or /AA action dictionaries.
public String? Title { get; } #Annotation title or author from /T, when present.
public String? Modified { get; } #Annotation modification date string from /M, when present.
public IReadOnlyList<Double> Color { get; } #Annotation color components from /C, when readable.
public String? DefaultAppearance { get; } #FreeText default appearance string from /DA, when present.
public String? DefaultStyle { get; } #FreeText default style string from /DS, when present.
public String? RichContents { get; } #FreeText rich contents string from /RC, when present.
public String? RichContentsPlainText { get; } #Plain text extracted from FreeText /RC when rich contents are present and readable.
public Double? EffectiveFontSize { get; } #Effective FreeText font size resolved from /DA or /DS, when readable.
public PdfColor? EffectiveTextColor { get; } #Effective FreeText text color resolved from /DA or /DS, when readable.
public PdfAlign? EffectiveTextAlign { get; } #Effective FreeText text alignment resolved from /Q or /DS, when readable.
public IReadOnlyList<Double> InteriorColor { get; } #Annotation interior color components from /IC, when readable.
public Double? Opacity { get; } #Annotation opacity from /CA, when present and valid.
public Double? BorderWidth { get; } #Annotation border width from /BS /W or /Border, when present and valid.
public String? BorderStyle { get; } #Annotation border style resolved from /BS /S, when present.
public IReadOnlyList<Double> BorderDashPattern { get; } #Annotation border dash pattern from /BS /D, when present and valid.
public String? BorderEffectStyle { get; } #Annotation border effect style from /BE /S, when present.
public Double? BorderEffectIntensity { get; } #Annotation border effect intensity from /BE /I, when present and valid.
public IReadOnlyList<Double> RectangleDifferences { get; } #FreeText rectangle differences from /RD as left, top, right, bottom values, when valid.
public IReadOnlyList<Double> CalloutLine { get; } #FreeText callout line coordinates from /CL, when present and valid.
public String? CalloutLineEnding { get; } #FreeText callout line ending from /LE, when present.
public String? LineStartEnding { get; } #Line or PolyLine start ending from /LE, when present.
public String? LineEndEnding { get; } #Line or PolyLine end ending from /LE, when present.
public IReadOnlyList<Double> QuadPoints { get; } #Text-markup quad point coordinates from /QuadPoints, when present and valid.
public IReadOnlyList<Double> LineCoordinates { get; } #Line annotation coordinates from /L, when present and valid.
public IReadOnlyList<Double> Vertices { get; } #Polygon or PolyLine vertices from /Vertices, when present and valid.
public IReadOnlyList<IReadOnlyList<Double>> InkList { get; } #Ink annotation paths from /InkList, when present and valid.
public PdfAnnotationReviewInfo? Review { get; } #Reply and review metadata, when the annotation defines any.
public Boolean HasFreeTextAppearanceMetadata { get; } #True when the annotation exposes FreeText appearance metadata such as /DA, /DS, /RC, or /Q.
public Boolean HasVisualStyleMetadata { get; } #True when the annotation exposes visual styling metadata beyond the rectangle and subtype.
public Boolean HasPathGeometryMetadata { get; } #True when the annotation exposes path geometry such as /QuadPoints, /L, /Vertices, or /InkList.
public Boolean HasColor { get; } #True when the annotation has a readable color array.
public Boolean HasAction { get; } #True when the annotation has a primary action dictionary.
public Boolean HasAdditionalActions { get; } #True when the annotation has at least one additional action dictionary.
public Boolean HasChainedActions { get; } #True when at least one chained /Next action was discovered for this annotation.
public Int32 ChainedActionCount { get; } #Number of chained /Next actions discovered for this annotation.
public Boolean IsInvisible { get; } #True when the annotation has the PDF Invisible flag.
public Boolean IsPrint { get; } #True when the annotation has the PDF Print flag.
public Boolean IsNoZoom { get; } #True when the annotation has the PDF NoZoom flag.
public Boolean IsNoRotate { get; } #True when the annotation has the PDF NoRotate flag.
public Boolean IsNoView { get; } #True when the annotation has the PDF NoView flag.
public Boolean IsReadOnly { get; } #True when the annotation has the PDF ReadOnly flag.
public Boolean IsLocked { get; } #True when the annotation has the PDF Locked flag.
public Boolean IsToggleNoView { get; } #True when the annotation has the PDF ToggleNoView flag.
public Boolean IsLockedContents { get; } #True when the annotation has the PDF LockedContents flag.