API Reference
Class
PdfDocumentAnnotations
Existing-document annotation creation, update, removal, and flattening operations.
Inheritance
- Object
- PdfDocumentAnnotations
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property PdfDocument.Annotations
Methods
public PdfAnnotationEditResult Add(PdfAnnotationCreateOptions options) #Returns:
PdfAnnotationEditResultAdds an annotation to an existing page.
Parameters
- options OfficeIMO.Pdf.PdfAnnotationCreateOptions
public PdfAnnotationEditResult AddReply(Int32 parentObjectNumber, String contents, PdfAnnotationReplyOptions options = null) #Returns:
PdfAnnotationEditResultAdds a reply to one indirect annotation.
Parameters
- parentObjectNumber System.Int32
- contents System.String
- options OfficeIMO.Pdf.PdfAnnotationReplyOptions = null
public PdfAnnotationEditResult Flatten(PdfAnnotationFlattenOptions options = null) #Returns:
PdfAnnotationEditResultFlattens selected supported visual annotations.
Parameters
- options OfficeIMO.Pdf.PdfAnnotationFlattenOptions = null
public PdfAnnotationReviewCatalog GetReviewCatalog() #Returns:
PdfAnnotationReviewCatalogReads annotation reply threads and review states.
public PdfAnnotationEditResult Move(Int32 objectNumber, Double deltaX, Double deltaY) #Returns:
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 Remove(PdfAnnotationRemovalOptions options = null) #Returns:
PdfAnnotationEditResultRemoves matching annotations.
Parameters
- options OfficeIMO.Pdf.PdfAnnotationRemovalOptions = null
public PdfAnnotationEditResult Resize(Int32 objectNumber, PdfPageRectangle rectangle) #Returns:
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) #Returns:
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 Update(Int32 objectNumber, PdfAnnotationUpdateOptions options) #Returns:
PdfAnnotationEditResultUpdates one indirect annotation.
Parameters
- objectNumber System.Int32
- options OfficeIMO.Pdf.PdfAnnotationUpdateOptions
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object