PdfLineAnnotation Class

Represents a line annotation

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.AnnotationsPdfAnnotation
      Patagames.Pdf.Net.AnnotationsPdfMarkupAnnotation
        Patagames.Pdf.Net.AnnotationsPdfLineAnnotation

Namespace: Patagames.Pdf.Net.Annotations
Assemblies: Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.55.2704
Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.55.2704

Syntax

C++

JavaScript

Copy

public class PdfLineAnnotation : PdfMarkupAnnotation

Public Class PdfLineAnnotation
	Inherits PdfMarkupAnnotation

public ref class PdfLineAnnotation : public PdfMarkupAnnotation

type PdfLineAnnotation =  
    class
        inherit PdfMarkupAnnotation
    end

public class PdfLineAnnotation extends PdfMarkupAnnotation

Patagames.Pdf.Net.Annotations.PdfLineAnnotation = function();

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfLineAnnotation',
	Patagames.Pdf.Net.Annotations.PdfMarkupAnnotation);

The PdfLineAnnotation type exposes the following members.

Constructors

	Name	Description
	PdfLineAnnotation(PdfPage)	Creates a new PdfLineAnnotation.
	PdfLineAnnotation(PdfPage, PdfTypeBase)	Initializes a new instance of the PdfLineAnnotation class based on the specified dictionary.

Top

Properties

	Name	Description
	Cap	Gets or set a flag specifying whether line has a caption.
	CaptionOffset	Gets or sets the value specifying the offset of the caption text from its normal position.
	CaptionPosition	Gets or sets a value describing the annotation’s caption positioning.
	Intent	Gets or sets a name describing the intent of the line annotation.
	InteriorColor	Gets or sets the interior color with which to fill the annotation’s line endings.
	LeaderLineExtension	A non-negative number representing the length of leader line extensions that extend from the line proper 180 degrees from the leader lines, as shown in Figure 8.5 in the remarks section of PdfLineAnnotation reference.
	LeaderLineLenght	The length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself, as shown in Figure 8.5 in the remarks section of PdfLineAnnotation reference.
	LeaderLineOffset	Gets or sets a non-negative number representing the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.
	Line	Gets or sets a collection of the FS_POINTF specifying the starting and ending coordinates of the line in default user space.
	LineEnding	Gets or sets a list of line ending styles to be used in drawing the Line.
	LineStyle	Gets or sets a line style (see PdfBorderStyle) specifying the line width and dash pattern to be used in drawing the line.

Top

Methods

	Name	Description
	RegenerateAppearances	Re-creates the appearance of the annotation based on its properties. (Overrides PdfMarkupAnnotationRegenerateAppearances.)

Top

Remarks

A line annotation (PDF 1.3) displays a single straight line on the page. When opened, it displays a pop-up window containing the text of the associated note.

FIGURE 8.5 Leader lines

Figure 8.6 illustrates the effect of including a caption to a line annotation, which is specified by setting Cap property to true.

FIGURE 8.6 Lines with captions appearing as part of the line

Figure 8.7 illustrates the effect of applying a caption to a line annotation that has a leader offset.

FIGURE 8.7 Line with a caption appearing as part of the offset

Reference

Patagames.Pdf.Net.Annotations Namespace