TextMarkupAnnotation Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
Text markup annotations appear as highlights, underlines, strikeouts, or jagged (“squiggly”) underlines in the text of a document. When opened, they display a pop-up window containing the text of the associated note.
Inheritance Hierarchy

SystemObject
  Apitron.PDF.Kit.FixedLayout.ResourcesResource
    Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
      Apitron.PDF.Kit.Interactive.AnnotationsAnnotation
        Apitron.PDF.Kit.Interactive.AnnotationsMarkupAnnotation
          Apitron.PDF.Kit.Interactive.AnnotationsTextMarkupAnnotation

Namespace:  Apitron.PDF.Kit.Interactive.Annotations
Assembly:  Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Syntax

public sealed class TextMarkupAnnotation : MarkupAnnotation

The TextMarkupAnnotation type exposes the following members.

Constructors

  NameDescription
Public methodCode exampleTextMarkupAnnotation
Initializes a new instance of the Object class.
Top
Properties

  NameDescription
Public propertyAppearance
Gets the annotation's appearance.
(Inherited from Annotation.)
Public propertyBlendMode
The blend mode that shall be used when painting the annotation onto the page. If this key is not present, blending shall take place using the Normal blend mode. The value shall be a valur, designating one of the standard blend modes listed in BlendMode enum.
(Inherited from Annotation.)
Public propertyBorderEffect
Gets or sets a border effect that is used in conjunction with the border style specified by the BorderStyle entry.
(Inherited from Annotation.)
Public propertyBorderStyle
Gets the annotation's border style.
(Inherited from Annotation.)
Public propertyBoundary
Gets the annotation's boundary.
(Inherited from Annotation.)
Public propertyCanBeExported
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.)
Public propertyColor
Gets or sets the color. An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes: The background of the annotation’s icon when closed The title bar of the annotation’s pop-up window The border of a link annotation The number of array elements determines the colour space in which the colour shall be defined: 0 No colour; transparent 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
(Inherited from Annotation.)
Public propertyContents
Gets or sets the contents. Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. In either case, this text is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.
(Inherited from Annotation.)
Public propertyCreationDate
Gets the date and time when the annotation was created.
(Inherited from MarkupAnnotation.)
Public propertyFlags
Gets the annotation's flags.
(Inherited from Annotation.)
Public propertyFontResourceID
Gets or sets the font resource ID.
(Inherited from Annotation.)
Public propertyFontSize
Gets or sets the size of the font.
(Inherited from Annotation.)
Public propertyIdentity
Gets or sets the identity.
(Inherited from Annotation.)
Public propertyIntent
Gets or sets the intent. A name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type. If this entry is not present or its value is the same as the annotation type, the annotation shall have no explicit intent and should behave in a generic manner in a conforming reader.
(Inherited from MarkupAnnotation.)
Public propertyInteriorColor
Gets or sets the interior color. An array of numbers in the range 0.0 to 1.0 specifying the interior color that shall be used to fill the annotation’s line endings. The number of array elements shall determine the colour space in which the colour is defined: 0 No colour; transparent 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
(Inherited from Annotation.)
Public propertyMarkupType
Gets or sets the type of the markup.
Public propertyModificationDate
Gets the date and time when the annotation was most recently modified.
(Inherited from Annotation.)
Public propertyNonStrokingOpacity
When regenerating the annotation's appearance, this is the opacity value (the range is 0.0 - 1.0) that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened. Default value: 1.0 The specified value shall not be used if the annotation has an appearance; in that case, the appearance stream shall specify any transparency.
(Inherited from Annotation.)
Public propertyOpacity
Gets or sets the constant opacity value that shall be used in painting the annotation. Default value: 1.0.
(Inherited from MarkupAnnotation.)
Public propertyPageNumber
Gets or sets the ordinal page number on which this annotation shall appear, where page 0 is the first page. Meaningful for FormsDataDocument only.
(Inherited from Annotation.)
Public propertyPopup
Gets or sets a pop-up annotation for entering or editing the text associated with this annotation
(Inherited from MarkupAnnotation.)
Public propertyRectDifferences
Gets or sets a set of four numbers describing the numerical differences between two rectangles: the Boundary entry of the annotation and a rectangle contained within that rectangle. The inner rectangle is where the annotation’s text should be displayed. Any border styles and/or border effects specified by BorderStyle and BorderEffect entries, respectively, shall be applied to the border of the inner rectangle. The four numbers correspond to the differences in default user space between the left, top, right, and bottom coordinates of Boundary and those of the inner rectangle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of Boundary, and the sum of the left and right differences shall be less than the width of Boundary.
(Inherited from Annotation.)
Public propertyReplyTo
Gets or sets the annotation that this annotation is “in reply to.” Both annotations shall be on the same page of the document. The relationship between the two annotations shall be specified by the RT entry.
(Inherited from MarkupAnnotation.)
Public propertyReplyType
Gets or sets the type of the reply to.
(Inherited from MarkupAnnotation.)
Public propertyResourceType
Gets the resource type.
(Inherited from Resource.)
Public propertyRichTextString
Gets or sets the rich text string that shall be displayed in the pop-up window when the annotation is opened.
(Inherited from MarkupAnnotation.)
Public propertyStrokingOpacity
When regenerating the annotation's appearance, this is the opacity value (the range is 0.0 - 1.0) that shall be used for stroking all visible elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened. If a NonStrokingOpacity property is not present in this annotation, then the value of this StrokingOpacity entry shall also be used for nonstroking operations as well. Default Value: 1.0 The specified value shall not be used if the annotation has an appearance; in that case, the appearance stream shall specify any transparency.
(Inherited from Annotation.)
Public propertyStructParent
Gets or sets the parent's structure.
(Inherited from Annotation.)
Public propertySubject
Gets or sets the text representing a short description of the subject being addressed by the annotation.
(Inherited from MarkupAnnotation.)
Public propertyTag
Gets or sets extra information about the annotation.
(Inherited from Annotation.)
Public propertyTitle
The text label that shall be displayed in the title bar of the annotation’s pop-up window when open and active. This entry shall identify the user who added the annotation.
(Inherited from MarkupAnnotation.)
Public propertyType
Gets the type.
(Inherited from Annotation.)
Public propertyUser
Gets or sets the user.
(Inherited from MarkupAnnotation.)
Top
Methods

  NameDescription
Public methodFindLocations
Finds the pages where the annotation is located.
(Inherited from Annotation.)
Public methodFlatten
Flattens this instance and removes from the parent collection.
(Inherited from Annotation.)
Public methodGetQuadPoints
Gets an array of 8 × n numbers specifying the coordinates of nquadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order: x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order. The text shall be oriented with respect to the edge connecting points (x1, y1) and (x2, y2).
Public methodSetQuadPoints(Double)
Sets an array of 8 × n numbers specifying the coordinates of nquadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order: x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order. The text shall be oriented with respect to the edge connecting points (x1, y1) and (x2, y2).
Public methodSetQuadPoints(Boundary)
Sets an array of 8 × n numbers specifying the coordinates of nquadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order: x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order. The text shall be oriented with respect to the edge connecting points (x1, y1) and (x2, y2).
Top
See Also

Reference