PDFFreeTextAnnotation¶
Namespace: O2S.Components.PDF4NET.Annotations
Defines a PDF free text annotation.
Inheritance Object → PDFAnnotation → PDFMarkupAnnotation → PDFFreeTextAnnotation
Constructors¶
PDFFreeTextAnnotation()¶
Initializes a new PDFFreeTextAnnotation object.
Properties¶
AppearanceFont¶
Gets or sets the annotation appearance font.
Property Value
PDFFont
The font used for displaying the annotation content.
Remarks
If this property is null, the PDFFreeTextAnnotation.Font property is used for displaying the annotation content.
Author¶
Gets or sets the annotation author.
Property Value
String
The user who added the annotation.
BorderColor¶
Gets or sets the annotation border color.
Property Value
PDFColor
A PDFColor specifying the border color with which to stroke the annotation's border.
Exceptions
ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.
Remarks
For free text annotations the border color will always match the text color and viceversa.
BorderWidth¶
Gets or sets the border width.
Property Value
Double
The width of the square outline drawn in the annotation.
Exceptions
ArgumentOutOfRangeException
Thrown when this property is set to a negative value.
Contents¶
Gets or sets the annotation contents.
Property Value
String
Text to be displayed for the annotation.
CosDictionary¶
Gets the COS dictionary asssociated with this object.
Property Value
PDFCosDictionary
The internal COS dictionary.
Remarks
Incorrect manipulation of the information in the COS dictionary can lead to invalid PDF files.
CreationDate¶
Gets or sets the annotation creation date.
Property Value
DateTime
The date and time when the annotation was created.
DisplayRectangle¶
Gets or sets the visual rectangle of this annotation object.
Property Value
PDFDisplayRectangle
A PDFDisplayRectangle that represents the position and size of the annotation.
Remarks
The visual rectangle is relative to the top left corner of the page and can be set only after the annotation has been added to the page.
Font¶
Gets or sets the annotation font.
Property Value
PDFFont
The font used for displaying the annotation PDFFreeTextAnnotation.Contents.
Guid¶
Gets the annotation GUID.
Property Value
Guid
A Guid object that uniquely identifies the annotation.
HasStandardAppearance¶
Gets a flag indicating whether the annotation appearance has been created by the library internally or it has been set externally.
Property Value
Hidden¶
Gets or sets a value indicating whether to display the annotation or not.
Property Value
Boolean
If true, do not display or print the annotation or allow it to
interact with the user.
ID¶
Gets or sets the annotation ID.
Property Value
String
A unique value representing the ID
InReplyTo¶
Gets or sets the annotation that this annotation is "in reply to".
Property Value
PDFAnnotation
A reference to the annotation that this annotation is "in reply to."
InteriorColor¶
Gets or sets the annotation interior color.
Property Value
PDFColor
A PDFColor specifying the color to fill the annotation interior.
Exceptions
ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.
Invisible¶
Gets or sets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types.
Property Value
Locked¶
Gets or sets a value indicating whether the annotation should be modified.
Property Value
Boolean
If true, 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.
LockedContents¶
Gets or sets a value indicating whether the annotation contents should be modified.
Property Value
Boolean
If true, do not allow the contents of the annotation to be modified by the user.
This flag does not restrict deletion of the annotation or changes to other
annotation properties, such as position and size.
ModifiedDate¶
Gets or sets the annotation modified date.
Property Value
DateTime
The date and time when the annotation was most recently modified.
MouseDown¶
Gets or sets the mouse down action.
Property Value
PDFAction
An action to be performed when the mouse button is pressed inside the annotation's active area.
MouseEnter¶
Gets or sets the mouse enter action.
Property Value
PDFAction
An action to be performed when the cursor enters the annotation's active area.
MouseLeave¶
Gets or sets the mouse leave action.
Property Value
PDFAction
An action to be performed when the cursor exits the annotation's active area.
MouseUp¶
Gets or sets the mouse up action.
Property Value
PDFAction
An action to be performed when the mouse button is released inside the annotation's active area.
NormalAppearance¶
Gets or sets the annotation normal appearance.
Property Value
PDFAnnotationAppearance
A PDFAnnotationAppearance specifying how the annotation is presented visually on the page.
NoRotate¶
Gets or sets a value indicating whether the annotation should be rotated when the page is rotated.
Property Value
Boolean
If true, do not rotate the annotation's appearance to match the rotation of the page.
NoView¶
Gets or sets a value indicating whether the annotation should be displayed.
Property Value
Boolean
If true, do not display the annotation on the screen or allow it
to interact with the user. The annotation may be printed (depending on
the PDFAnnotation.Print property), but should be considered hidden for the purposes
of onscreen display and user interaction.
NoZoom¶
Gets or sets a value indicating whether the annotation should be scaled to current page zoom.
Property Value
Boolean
If true, do not scale the annotation's appearance to match the zoom of the page.
Opacity¶
Gets or sets the annotation opacity.
Property Value
Double
A value in the range [0, 1] that represents the constant opacity value to be used in painting the annotation.
Page¶
Gets the annotation page.
Property Value
PDFPage
A PDFPage that represents the page contianing the annotation.
PageClose¶
Gets or sets the page close action.
Property Value
PDFAction
An action to be performed when the page containing the annotation is closed
(for example, when the user navigates to the next or previous page, or follows
a link annotation or outline item).
PageInvisible¶
Gets or sets the page invisible action.
Property Value
PDFAction
An action to be performed when the page containing the annotation
is no longer visible in the viewer application's user interface.
PageOpen¶
Gets or sets the page open action.
Property Value
PDFAction
An action to be performed when the page containing the annotation is opened
(for example, when the user navigates to it from the next or previous page or by means
of a link annotation or outline item).
PageVisible¶
Gets or sets the page visible action.
Property Value
PDFAction
An action to be performed when the page containing the annotation
becomes visible in the viewer application's user interface.
Popup¶
Gets or sets the associated popup annotation.
Property Value
PDFPopupAnnotation
A PDFPopupAnnotation used for editing the content of the annotation.
Print¶
Gets or sets a value indicating whether the annotation should be printed.
Property Value
Boolean
If true, print the annotation when the page is printed. If clear,
never print the annotation, regardless of whether it is displayed
on the screen.
ReadOnly¶
Gets or sets a value indicating whether the annotation is read only.
Property Value
Boolean
If true, do not allow the annotation to interact with the user.
Rotation¶
Gets or sets the annotation rotation angle.
Property Value
Int32
The annotation rotation angle in degrees.
Exceptions
ArgumentOutOfRangeException
Thrown when the value being set is not one of the accepted values.
Remarks
The accepted values for this property are 0, 90, 180 and 270 degrees.
Subject¶
Gets or sets the annotation subject.
Property Value
String
Text representing a short description of the subject being addressed by the annotation.
TextColor¶
Gets or sets the text color.
Property Value
PDFColor
A PDFColor specifying the color used to display the annotation content.
TextDirection¶
Gets or sets the text direction.
Property Value
PDFTextDirection
A PDFTextDirection enum member specifying the direction of the text displayed in the annotation.
ToggleNoView¶
Gets or sets a value indicating whether the interpretation of NoView property should be reversed.
Property Value
Boolean
If true, invert the interpretation of the NoView property for certain events.
Type¶
Gets the type of the annotation.
Property Value
PDFAnnotationType
A PDFAnnotationType that represents the annotation type.