API Reference
PdfDocumentAnnotations
Existing-document annotation creation, update, removal, and flattening operations.
Inheritance
- Object
- PdfDocumentAnnotations
Usage
Explore 1 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 1
- Property PdfDocument.Annotations
Methods
public PdfAnnotationEditResult Add(PdfAnnotationCreateOptions options) #PdfAnnotationEditResultAdds an annotation to an existing page.
Parameters
- options OfficeIMO.Pdf.PdfAnnotationCreateOptions
public PdfAnnotationEditResult AddReply(Int32 parentObjectNumber, String contents, PdfAnnotationReplyOptions? options = null) #PdfAnnotationEditResultAdds a reply to one indirect annotation.
Parameters
- parentObjectNumber System.Int32
- contents System.String
- options OfficeIMO.Pdf.PdfAnnotationReplyOptions? = null
public PdfAnnotationEditResult AddStamp(PdfStampAnnotationOptions options) #PdfAnnotationEditResultAdds a text or image-backed Stamp annotation without changing page content.
Parameters
- options OfficeIMO.Pdf.PdfStampAnnotationOptions
public PdfAnnotationEditResult Arrange(IReadOnlyList<Int32> objectNumbers, PdfAnnotationOrderChange change) #PdfAnnotationEditResultChanges selected annotations' page painting order while preserving their relative order.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
- change OfficeIMO.Pdf.PdfAnnotationOrderChange
public PdfAnnotationEditResult CopyMany(IReadOnlyList<Int32> objectNumbers, Double deltaX = 10, Double deltaY = 10) #PdfAnnotationEditResultCopies selected annotations and their standard groups on the same pages with a user-space offset.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
- deltaX System.Double = 10
- deltaY System.Double = 10
public PdfAnnotationEditResult CopyManyVisual(IReadOnlyList<Int32> objectNumbers, Double deltaX = 10, Double deltaY = 10) #PdfAnnotationEditResultCopies selected annotations on their existing pages by a top-left visual offset, mapping each page's crop, rotation, and user-unit scale in one mutation.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
- deltaX System.Double = 10
- deltaY System.Double = 10
public PdfAnnotationEditResult Flatten(PdfAnnotationFlattenOptions? options = null) #PdfAnnotationEditResultFlattens selected supported visual annotations.
Parameters
- options OfficeIMO.Pdf.PdfAnnotationFlattenOptions? = null
public PdfPageInteractionMap GetEditingInteractions(Int32 pageNumber) #PdfPageInteractionMapBuilds annotation-only visual hit regions for an authorized annotation editing workflow.
Parameters
- pageNumber System.Int32
public IReadOnlyList<PdfAnnotation> GetForEditing() #IReadOnlyList<PdfAnnotation>Reads annotation metadata needed to select and edit annotations under the document's annotation mutation policy.
public PdfAnnotationReviewCatalog GetReviewCatalog() #PdfAnnotationReviewCatalogReads annotation reply threads and review states.
public PdfAnnotationEditResult Group(IReadOnlyList<Int32> objectNumbers) #PdfAnnotationEditResultGroups same-page editable markup annotations using standard /IRT and /RT Group relationships.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
public PdfAnnotationEditResult Move(Int32 objectNumber, Double deltaX, Double deltaY) #PdfAnnotationEditResultMoves one annotation and all supported subtype geometry by a user-space offset.
Parameters
- objectNumber System.Int32
- deltaX System.Double
- deltaY System.Double
public PdfAnnotationEditResult MoveMany(IReadOnlyList<Int32> objectNumbers, Double deltaX, Double deltaY) #PdfAnnotationEditResultMoves selected annotations, including their standard group members, in one mutation.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
- deltaX System.Double
- deltaY System.Double
public PdfAnnotationEditResult MoveManyVisual(IReadOnlyList<Int32> objectNumbers, Double deltaX, Double deltaY) #PdfAnnotationEditResultMoves selected annotations by a top-left visual offset, mapping each page's crop, rotation, and user-unit scale in one mutation.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
- deltaX System.Double
- deltaY System.Double
public PdfAnnotationEditResult Remove(PdfAnnotationRemovalOptions? options = null) #PdfAnnotationEditResultRemoves matching annotations.
Parameters
- options OfficeIMO.Pdf.PdfAnnotationRemovalOptions? = null
public PdfAnnotationEditResult RemoveMany(IReadOnlyList<Int32> objectNumbers, Boolean allowResidualDataInAppendOnly = false) #PdfAnnotationEditResultRemoves selected annotations and groups, retaining replies to removed annotations as standalone comments.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
- allowResidualDataInAppendOnly System.Boolean = false
public PdfAnnotationEditResult Resize(Int32 objectNumber, PdfPageRectangle rectangle) #PdfAnnotationEditResultResizes one annotation and proportionally transforms all supported subtype geometry.
Parameters
- objectNumber System.Int32
- rectangle OfficeIMO.Pdf.PdfPageRectangle
public PdfAnnotationEditResult SetReviewState(Int32 objectNumber, PdfAnnotationReviewState state, PdfMutationExecutionPreference executionPreference = Automatic, Boolean allowResidualDataInAppendOnly = false) #PdfAnnotationEditResultSets the standard review state on one indirect annotation.
Parameters
- objectNumber System.Int32
- state OfficeIMO.Pdf.PdfAnnotationReviewState
- executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference = Automatic
- allowResidualDataInAppendOnly System.Boolean = false
public PdfAnnotationEditResult Ungroup(IReadOnlyList<Int32> objectNumbers) #PdfAnnotationEditResultRemoves standard grouping relationships from selected groups without removing annotations or replies.
Parameters
- objectNumbers System.Collections.Generic.IReadOnlyList<System.Int32>
public PdfAnnotationEditResult Update(Int32 objectNumber, PdfAnnotationUpdateOptions options) #PdfAnnotationEditResultUpdates one indirect annotation.
Parameters
- objectNumber System.Int32
- options OfficeIMO.Pdf.PdfAnnotationUpdateOptions
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?