API Reference
PdfAnnotationCreateOptions
Creates a standard annotation on an existing PDF page.
Inheritance
- Object
- PdfAnnotationCreateOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method PdfDocumentAnnotations.Add
Constructors
public PdfAnnotationCreateOptions() #Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Int32 PageNumber { get; set; } #One-based target page number.
public String Subtype { get; set; } #PDF annotation subtype such as Text, FreeText, Highlight, Line, Square, Circle, Polygon, PolyLine, Ink, Stamp, or Caret.
public IReadOnlyList<Double> Rectangle { get; set; } #Annotation rectangle as left, bottom, right, top.
public String Contents { get; set; } #Optional annotation contents.
public String LinkUri { get; set; } #URI action target for a Link annotation. Other annotation subtypes must leave this null.
public String Title { get; set; } #Optional author/title.
public String Name { get; set; } #Optional stable /NM name.
public Int32 Flags { get; set; } #Annotation flags. The default enables printing.
public IReadOnlyList<Double> Color { get; set; } #Optional RGB color.
public IReadOnlyList<Double> InteriorColor { get; set; } #Optional gray, RGB, or CMYK interior color.
public Nullable<Double> Opacity { get; set; } #Optional annotation opacity from 0 through 1.
public Nullable<Double> BorderWidth { get; set; } #Optional border width.
public Nullable<PdfAnnotationBorderStyle> BorderStyle { get; set; } #Optional standard border style.
public IReadOnlyList<Double> BorderDashPattern { get; set; } #Optional border dash pattern.
public IReadOnlyList<Double> QuadPoints { get; set; } #Optional text-markup quadrilaterals.
public IReadOnlyList<Double> Vertices { get; set; } #Optional polygon/polyline vertices.
public IReadOnlyList<Double> Line { get; set; } #Optional line endpoints.
public IReadOnlyList<IReadOnlyList<Double>> InkPaths { get; set; } #Optional ink paths.
public String LineStartEnding { get; set; } #Optional line-start ending name.
public String LineEndEnding { get; set; } #Optional line-end ending name.
public String IconName { get; set; } #Optional icon or stamp name stored in /Name.
public Nullable<Int32> InReplyToObjectNumber { get; set; } #Optional reply-parent annotation object number.
public String ReplyType { get; set; } #Reply type, normally R or Group.
public Nullable<PdfAnnotationReviewState> ReviewState { get; set; } #Optional standard annotation review state.
public String Subject { get; set; } #Optional annotation subject stored in /Subj.
public String Intent { get; set; } #Optional annotation intent name stored in /IT.
public Boolean CreatePopup { get; set; } #Creates and links a popup annotation.
public IReadOnlyList<Double> PopupRectangle { get; set; } #Popup rectangle. Defaults beside the parent rectangle.
public Boolean PopupOpen { get; set; } #Initial popup open state.
public Boolean GenerateAppearance { get; set; } #Generates a normal appearance for supported visual subtypes.
public PdfMutationExecutionPreference ExecutionPreference { get; set; } #Preferred full-rewrite or append-only mutation mode.