PdfStickyNoteAnnotation Class

Namespace:
GemBox.Pdf.Annotations
Assembly:
GemBox.Pdf.dll

A text annotation represents a "sticky note" attached to a point in the PDF document. When closed, the annotation shall appear as an icon; when open, it shall display a pop-up window containing the text of the note in a font and size chosen by the conforming reader.

public sealed class PdfStickyNoteAnnotation : PdfMarkupAnnotation
Public NotInheritable Class PdfStickyNoteAnnotation
    Inherits PdfMarkupAnnotation
Inheritance:
System.Object
PdfStickyNoteAnnotation

Properties

AnnotationType

Gets the Text value.

public override PdfAnnotationType AnnotationType { get; }
Public Overrides ReadOnly Property AnnotationType As PdfAnnotationType
Property Value
PdfAnnotationType

The Text value.

Overrides

Appearance

Gets the appearance settings for this PdfStickyNoteAnnotation.

public PdfStickyNoteAppearance Appearance { get; }
Public ReadOnly Property Appearance As PdfStickyNoteAppearance
Property Value
PdfStickyNoteAppearance

The appearance settings for this PdfStickyNoteAnnotation.

Content

(Optional) Text that shall be displayed for the annotation.

public string Content { get; set; }
Public Property Content As String
Property Value
System.String

Text that shall be displayed for the annotation.

See Also

IsOpened

(Optional) A flag specifying whether the annotation shall initially be displayed open. Default value: false (closed).

public bool IsOpened { get; set; }
Public Property IsOpened As Boolean
Property Value
System.Boolean

A flag specifying whether the annotation shall initially be displayed open.

See Also

Inherited Properties

AssociatedFiles

(Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfAnnotation.

(Inherited from PdfAnnotation)

Author

(Optional; PDF 1.1) 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 PdfMarkupAnnotation)

Bounds

(Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units.

(Inherited from PdfAnnotation)

InReplyTo

(Required if a ReplyType entry is present, otherwise optional; PDF 1.5) A reference to the PdfMarkupAnnotation that this PdfMarkupAnnotation is "in reply to". Both PdfMarkupAnnotations shall be on the same page of the document. The relationship between the two PdfMarkupAnnotations shall be specified by the ReplyType entry.

(Inherited from PdfMarkupAnnotation)

Intent

(Optional; PDF 1.6) 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.

PdfFreeTextAnnotations (Table 174), line annotations (Table 175), polygon annotations (Table 178), and (PDF 1.7) polyline annotations (Table 178) have defined intents.

(Inherited from PdfMarkupAnnotation)

Locked

(PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

(Inherited from PdfAnnotation)

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Page

Gets the page with which this annotation is associated.

(Inherited from PdfAnnotation)

ReplyType

(Optional; meaningful only if InReplyTo is present; PDF 1.6) A name specifying the relationship (the "reply type") between this PdfMarkupAnnotation and the one specified by the InReplyTo property.

Default value: Reply.

(Inherited from PdfMarkupAnnotation)

Subject

(Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation.

(Inherited from PdfMarkupAnnotation)

Inherited Methods

SetBounds(System.Double, System.Double)

Sets the size of the Bounds.

(Inherited from PdfAnnotation)

SetBounds(System.Double, System.Double, System.Double, System.Double)

Sets the Bounds.

(Inherited from PdfAnnotation)

Extension Methods

See Also