The purpose of a line annotation is to display a single straight line on the page. More...

Inheritance diagram for iText.Kernel.Pdf.Annot.PdfLineAnnotation:

Public Member Functions
	PdfLineAnnotation (Rectangle rect, float[] line)
	Creates a PdfLineAnnotation instance. More...

override PdfName	GetSubtype ()
	Gets a iText.Kernel.Pdf.PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types. More...

virtual PdfArray	GetLine ()
	An array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line in default user space. More...

virtual PdfDictionary	GetBorderStyle ()
	The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetBorderStyle (PdfDictionary borderStyle)
	Sets border style dictionary that has more settings than the array specified for the Border entry ( PdfAnnotation.GetBorder() ). See ISO-320001, Table 166 and GetBorderStyle() for more info. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetBorderStyle (PdfName style)
	Setter for the annotation's preset border style. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetDashPattern (PdfArray dashPattern)
	Setter for the annotation's preset dashed border style. More...

virtual PdfArray	GetLineEndingStyles ()
	An array of two names specifying the line ending styles that is used in drawing the line. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetLineEndingStyles (PdfArray lineEndingStyles)
	Sets the line ending styles that are used in drawing the line. More...

virtual Color	GetInteriorColor ()
	The interior color which is used to fill the annotation's line endings. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetInteriorColor (PdfArray interiorColor)
	An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetInteriorColor (float[] interiorColor)
	An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings. More...

virtual float	GetLeaderLineLength ()
	The length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetLeaderLineLength (float leaderLineLength)
	Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. More...

virtual float	GetLeaderLineExtension ()
	A non-negative number that represents the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetLeaderLineExtension (float leaderLineExtension)
	Sets the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. More...

virtual float	GetLeaderLineOffset ()
	A non-negative number that represents 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. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetLeaderLineOffset (float leaderLineOffset)
	Sets 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. More...

virtual bool	GetContentsAsCaption ()
	If true, the text specified by the iText.Kernel.Pdf.PdfName.Contents or iText.Kernel.Pdf.PdfName.RC entries (see PdfAnnotation.GetContents() and PdfMarkupAnnotation.GetRichText() ) is replicated as a caption in the appearance of the line. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetContentsAsCaption (bool contentsAsCaption)
	If set to true, the text specified by the iText.Kernel.Pdf.PdfName.Contents or iText.Kernel.Pdf.PdfName.RC entries (see PdfAnnotation.GetContents() and PdfMarkupAnnotation.GetRichText() ) will be replicated as a caption in the appearance of the line. More...

virtual PdfName	GetCaptionPosition ()
	A name describing the annotation's caption positioning. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetCaptionPosition (PdfName captionPosition)
	Sets annotation's caption positioning. More...

virtual PdfDictionary	GetMeasure ()
	A measure dictionary (see ISO-320001, Table 261) that specifies the scale and units that apply to the line annotation. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetMeasure (PdfDictionary measure)
	Sets a measure dictionary that specifies the scale and units that apply to the line annotation. More...

virtual PdfArray	GetCaptionOffset ()
	An array of two numbers that specifies the offset of the caption text from its normal position. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetCaptionOffset (PdfArray captionOffset)
	Sets the offset of the caption text from its normal position. More...

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation	SetCaptionOffset (float[] captionOffset)
	Sets the offset of the caption text from its normal position. More...

Public Member Functions inherited from iText.Kernel.Pdf.Annot.PdfMarkupAnnotation
virtual PdfString	GetText ()
	The text label that will be displayed in the title bar of the annotation's pop-up window when open and active. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetText (PdfString text)
	Sets the text label that will be displayed in the title bar of the annotation's pop-up window when open and active. More...

virtual PdfNumber	GetOpacity ()
	The constant opacity value that will be used in painting the annotation. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetOpacity (PdfNumber ca)
	Sets the constant opacity value that will be used in painting the annotation. More...

virtual PdfObject	GetRichText ()
	A rich text string (see ISO-320001 12.7.3.4, "Rich Text Strings") that shall be displayed in the pop-up window when the annotation is opened. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetRichText (PdfObject richText)
	Sets a rich text string (see ISO-320001 12.7.3.4, "Rich Text Strings") that shall be displayed in the pop-up window when the annotation is opened. More...

virtual PdfString	GetCreationDate ()
	The date and time when the annotation was created. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetCreationDate (PdfString creationDate)
	Sets the date and time when the annotation was created. More...

virtual PdfDictionary	GetInReplyToObject ()
	An annotation object that this annotation is "in reply to." Both annotations shall be on the same page of the document. More...

virtual PdfAnnotation	GetInReplyTo ()
	An annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetInReplyTo (PdfAnnotation inReplyTo)
	Sets an annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetPopup (PdfPopupAnnotation popup)
	Sets a pop-up annotation for entering or editing the text associated with this annotation. More...

virtual PdfDictionary	GetPopupObject ()
	An associated pop-up annotation object. More...

virtual PdfPopupAnnotation	GetPopup ()
	An associated pop-up annotation for entering or editing the text associated with this annotation. More...

virtual PdfString	GetSubject ()
	Text representing a short description of the subject being addressed by the annotation. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetSubject (PdfString subject)
	Sets the text representing a short description of the subject being addressed by the annotation. More...

virtual PdfName	GetReplyType ()
	A name specifying the relationship (the "reply type") between this annotation and one specified by IRT entry (see GetInReplyTo() ). Valid values are: More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetReplyType (PdfName replyType)
	Sets the relationship (the "reply type") between this annotation and one specified by IRT entry (see SetInReplyTo(PdfAnnotation) ). For valid values see GetInReplyTo() More...

virtual PdfName	GetIntent ()
	A name describing the intent of the markup annotation. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetIntent (PdfName intent)
	Sets a name describing the intent of the markup annotation. More...

virtual PdfDictionary	GetExternalData ()
	An external data dictionary specifying data that shall be associated with the annotation. More...

virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation	SetExternalData (PdfName exData)
	Sets an external data dictionary specifying data that shall be associated with the annotation. More...

Public Member Functions inherited from iText.Kernel.Pdf.Annot.PdfAnnotation
virtual void	SetLayer (IPdfOCG layer)
	Sets the layer this annotation belongs to. More...

virtual PdfString	GetContents ()
	Gets the 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. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetContents (PdfString contents)
	Sets the 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. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetContents (String contents)
	Sets the 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. More...

virtual PdfDictionary	GetPageObject ()
	Gets a iText.Kernel.Pdf.PdfDictionary that represents a page of the document on which annotation is placed, i.e. which has this annotation in it's /Annots array. More...

virtual PdfPage	GetPage ()
	Gets a iText.Kernel.Pdf.PdfPage on which annotation is placed. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetPage (PdfPage page)
	Method that modifies annotation page property, which defines to which page annotation belongs. More...

virtual PdfString	GetName ()
	Gets the annotation name, a text string uniquely identifying it among all the annotations on its page. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetName (PdfString name)
	Sets the annotation name, a text string uniquely identifying it among all the annotations on its page. More...

virtual PdfString	GetDate ()
	The date and time when the annotation was most recently modified. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetDate (PdfString date)
	The date and time when the annotation was most recently modified. More...

virtual int	GetFlags ()
	A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetFlags (int flags)
	Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetFlag (int flag)
	Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	ResetFlag (int flag)
	Resets a flag that specifies a characteristic of the annotation to disabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual bool	HasFlag (int flag)
	Checks if the certain flag that specifies a characteristic of the annotation is in enabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual PdfDictionary	GetAppearanceDictionary ()
	An appearance dictionary specifying how the annotation shall be presented visually on the page during its interactions with the user (see ISO-320001 12.5.5, "Appearance Streams"). More...

virtual PdfDictionary	GetAppearanceObject (PdfName appearanceType)
	Specific appearance object corresponding to the specific appearance type. More...

virtual PdfDictionary	GetNormalAppearanceObject ()
	The normal appearance is used when the annotation is not interacting with the user. More...

virtual PdfDictionary	GetRolloverAppearanceObject ()
	The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button. More...

virtual PdfDictionary	GetDownAppearanceObject ()
	The down appearance is used when the mouse button is pressed or held down within the annotation’s active area. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetAppearance (PdfName appearanceType, PdfDictionary appearance)
	Sets a specific type of the appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetNormalAppearance (PdfDictionary appearance)
	Sets normal appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetRolloverAppearance (PdfDictionary appearance)
	Sets rollover appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetDownAppearance (PdfDictionary appearance)
	Sets down appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetAppearance (PdfName appearanceType, PdfAnnotationAppearance appearance)
	Sets a specific type of the appearance using PdfAnnotationAppearance wrapper. This method is used to set only an appearance subdictionary. See GetAppearanceObject(iText.Kernel.Pdf.PdfName) and GetAppearanceDictionary() for more info. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetNormalAppearance (PdfAnnotationAppearance appearance)
	Sets normal appearance using PdfAnnotationAppearance wrapper. This method is used to set only appearance subdictionary. See GetNormalAppearanceObject() and GetAppearanceDictionary() for more info. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetRolloverAppearance (PdfAnnotationAppearance appearance)
	Sets rollover appearance using PdfAnnotationAppearance wrapper. This method is used to set only appearance subdictionary. See GetRolloverAppearanceObject() and GetAppearanceDictionary() for more info. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetDownAppearance (PdfAnnotationAppearance appearance)
	Sets down appearance using PdfAnnotationAppearance wrapper. This method is used to set only appearance subdictionary. See GetDownAppearanceObject() and GetAppearanceDictionary() for more info. More...

virtual PdfName	GetAppearanceState ()
	The annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary if there is such. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetAppearanceState (PdfName @as)
	Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary. More...

virtual PdfArray	GetBorder ()
	An array specifying the characteristics of the annotation’s border. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetBorder (PdfAnnotationBorder border)
	Sets the characteristics of the annotation’s border. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetBorder (PdfArray border)
	Sets the characteristics of the annotation’s border. More...

virtual PdfArray	GetColorObject ()
	An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes: More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetColor (PdfArray color)
	Sets an annotation color. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetColor (float[] color)
	Sets an annotation color. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetColor (Color color)
	Sets an annotation color. More...

virtual int	GetStructParentIndex ()
	The integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetStructParentIndex (int structParentIndex)
	Sets he integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetTitle (PdfString title)
	Sets annotation title. More...

virtual PdfString	GetTitle ()
	Annotation title. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetRectangle (PdfArray array)
	The annotation rectangle, defining the location of the annotation on the page in default user space units. More...

virtual PdfArray	GetRectangle ()
	The annotation rectangle, defining the location of the annotation on the page in default user space units. More...

virtual String	GetLang ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetLang (String lang)
	PDF 2.0. More...

virtual PdfName	GetBlendMode ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetBlendMode (PdfName blendMode)
	PDF 2.0. More...

virtual float	GetNonStrokingOpacity ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetNonStrokingOpacity (float nonStrokingOpacity)
	PDF 2.0. More...

virtual float	GetStrokingOpacity ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetStrokingOpacity (float strokingOpacity)
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	Put (PdfName key, PdfObject value)
	Inserts the value into into the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation and associates it with the specified key. If the key is already present in this PdfAnnotation , this method will override the old value with the specified one. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	Remove (PdfName key)
	Removes the specified key from the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation More...

virtual void	AddAssociatedFile (PdfFileSpec fs)

virtual PdfArray	GetAssociatedFiles (bool create)
	Returns files associated with PDF annotation. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call iText.Kernel.Pdf.PdfObjectWrapper.MakeIndirect(iText.Kernel.Pdf.PdfDocument)For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual bool	IsFlushed ()

Additional Inherited Members
Static Public Member Functions inherited from iText.Kernel.Pdf.Annot.PdfAnnotation
static iText.Kernel.Pdf.Annot.PdfAnnotation	MakeAnnotation (PdfObject pdfObject)
	Factory method that creates the type specific PdfAnnotation from the given iText.Kernel.Pdf.PdfObject that represents annotation object. This method is useful for property reading in reading mode or modifying in stamping mode. See derived classes of this class to see possible specific annotation types created. More...

Static Public Attributes inherited from iText.Kernel.Pdf.Annot.PdfAnnotation
const int	INVISIBLE = 1
	Annotation flag. More...

const int	HIDDEN = 2
	Annotation flag. More...

const int	PRINT = 4
	Annotation flag. More...

const int	NO_ZOOM = 8
	Annotation flag. More...

const int	NO_ROTATE = 16
	Annotation flag. More...

const int	NO_VIEW = 32
	Annotation flag. More...

const int	READ_ONLY = 64
	Annotation flag. More...

const int	LOCKED = 128
	Annotation flag. More...

const int	TOGGLE_NO_VIEW = 256
	Annotation flag. More...

const int	LOCKED_CONTENTS = 512
	Annotation flag. More...

static readonly PdfName	HIGHLIGHT_NONE = PdfName.N
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_INVERT = PdfName.I
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_OUTLINE = PdfName.O
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_PUSH = PdfName.P
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_TOGGLE = PdfName.T
	Widget annotation highlighting mode. More...

static readonly PdfName	STYLE_SOLID = PdfName.S
	Annotation border style. More...

static readonly PdfName	STYLE_DASHED = PdfName.D
	Annotation border style. More...

static readonly PdfName	STYLE_BEVELED = PdfName.B
	Annotation border style. More...

static readonly PdfName	STYLE_INSET = PdfName.I
	Annotation border style. More...

static readonly PdfName	STYLE_UNDERLINE = PdfName.U
	Annotation border style. More...

static readonly PdfString	Marked = new PdfString("Marked")
	Annotation state. More...

static readonly PdfString	Unmarked = new PdfString("Unmarked")
	Annotation state. More...

static readonly PdfString	Accepted = new PdfString("Accepted")
	Annotation state. More...

static readonly PdfString	Rejected = new PdfString("Rejected")
	Annotation state. More...

static readonly PdfString	Canceled = new PdfString("Cancelled")
	Annotation state. More...

static readonly PdfString	Completed = new PdfString("Completed")
	Annotation state. More...

static readonly PdfString	None = new PdfString("None")
	Annotation state. More...

static readonly PdfString	MarkedModel = new PdfString("Marked")
	Annotation state model. More...

static readonly PdfString	ReviewModel = new PdfString("Review")
	Annotation state model. More...

Detailed Description

The purpose of a line annotation is to display a single straight line on the page.

The purpose of a line annotation is to display a single straight line on the page. When opened, it displays a pop-up window containing the text of the associated note. See also ISO-320001 12.5.6.7 "Line Annotations".

Constructor & Destructor Documentation

◆ PdfLineAnnotation()

iText.Kernel.Pdf.Annot.PdfLineAnnotation.PdfLineAnnotation	(	Rectangle	rect,
		float[]	line
	)

inline

Creates a PdfLineAnnotation instance.

Parameters

rect	the annotation rectangle, defining the location of the annotation on the page in default user space units. See PdfAnnotation.SetRectangle(iText.Kernel.Pdf.PdfArray)
line	an array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line in default user space. See also GetLine()

Member Function Documentation

◆ GetBorderStyle()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetBorderStyle ( )

inlinevirtual

The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.

The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry. That entry specifies a border style dictionary that has more settings than the array specified for the Border entry (see PdfAnnotation.GetBorder() ). If an annotation dictionary includes the BS entry, then the Border entry is ignored. If annotation includes AP (see PdfAnnotation.GetAppearanceDictionary() ) it takes precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.

Returns

iText.Kernel.Pdf.PdfDictionary which is a border style dictionary or null if it is not specified.

◆ GetCaptionOffset()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetCaptionOffset ( )

inlinevirtual

An array of two numbers that specifies the offset of the caption text from its normal position.

An array of two numbers that specifies the offset of the caption text from its normal position. The first value is the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. The second value is the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.

Returns: a iText.Kernel.Pdf.PdfArray of two numbers that specifies the offset of the caption text from its normal position, or null if caption offset is not explicitly specified (in this case a default value is used, which is [0, 0]).

◆ GetCaptionPosition()

virtual PdfName iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetCaptionPosition ( )

inlinevirtual

A name describing the annotation's caption positioning.

A name describing the annotation's caption positioning. Valid values are iText.Kernel.Pdf.PdfName.Inline , meaning the caption is centered inside the line, and iText.Kernel.Pdf.PdfName.Top , meaning the caption is on top of the line.

Returns: a name describing the annotation's caption positioning, or null if the caption positioning is not explicitly defined (in this case the default value is used, which is iText.Kernel.Pdf.PdfName.Inline ).

◆ GetContentsAsCaption()

virtual bool iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetContentsAsCaption ( )

inlinevirtual

If true, the text specified by the iText.Kernel.Pdf.PdfName.Contents or iText.Kernel.Pdf.PdfName.RC entries (see PdfAnnotation.GetContents() and PdfMarkupAnnotation.GetRichText() ) is replicated as a caption in the appearance of the line.

Returns: true, if the annotation text is replicated as a caption, false otherwise. If this property is not set, default value is used which is false.

◆ GetInteriorColor()

virtual Color iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetInteriorColor ( )

inlinevirtual

The interior color which is used to fill the annotation's line endings.

Returns

iText.Kernel.Colors.Color of either iText.Kernel.Colors.DeviceGray , iText.Kernel.Colors.DeviceRgb or iText.Kernel.Colors.DeviceCmyk type which defines interior color of the annotation, or null if interior color is not specified.

◆ GetLeaderLineExtension()

virtual float iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetLeaderLineExtension ( )

inlinevirtual

A non-negative number that represents the length of leader line extensions that extend from the line proper 180 degrees from the leader lines.

Returns: a non-negative float that represents the length of leader line extensions; or if the leader line extension is not explicitly set, returns the default value, which is 0.

◆ GetLeaderLineLength()

virtual float iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetLeaderLineLength ( )

inlinevirtual

The length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself.

The length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point (as specified by iText.Kernel.Pdf.PdfName.L (see GetLine() ); a negative value indicates the opposite direction.

Returns: a float specifying the length of leader lines in default user space.

◆ GetLeaderLineOffset()

virtual float iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetLeaderLineOffset ( )

inlinevirtual

A non-negative number that represents 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.

Returns: a non-negative number that represents the length of the leader line offset, or null if leader line offset is not set.

◆ GetLine()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetLine ( )

inlinevirtual

An array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line in default user space.

An array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line in default user space. If the iText.Kernel.Pdf.PdfName.LL entry is present, this value represents the endpoints of the leader lines rather than the endpoints of the line itself.

Returns: An array of four numbers specifying the starting and ending coordinates of the line in default user space.

◆ GetLineEndingStyles()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetLineEndingStyles ( )

inlinevirtual

An array of two names specifying the line ending styles that is used in drawing the line.

An array of two names specifying the line ending styles that is used in drawing the line. The first and second elements of the array shall specify the line ending styles for the endpoints defined, respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the iText.Kernel.Pdf.PdfName.L array (see GetLine() . For possible values see SetLineEndingStyles(iText.Kernel.Pdf.PdfArray)

Returns: An array of two names specifying the line ending styles that is used in drawing the line; or null if line endings style is not explicitly defined, default value is [/None /None].

◆ GetMeasure()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetMeasure ( )

inlinevirtual

A measure dictionary (see ISO-320001, Table 261) that specifies the scale and units that apply to the line annotation.

Returns: a iText.Kernel.Pdf.PdfDictionary that represents a measure dictionary.

◆ GetSubtype()

override PdfName iText.Kernel.Pdf.Annot.PdfLineAnnotation.GetSubtype ( )

inlinevirtual

Gets a iText.Kernel.Pdf.PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.

Implements iText.Kernel.Pdf.Annot.PdfAnnotation.

◆ SetBorderStyle() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetBorderStyle ( PdfDictionary borderStyle )

inlinevirtual

Sets border style dictionary that has more settings than the array specified for the Border entry ( PdfAnnotation.GetBorder() ). See ISO-320001, Table 166 and GetBorderStyle() for more info.

Parameters

borderStyle a border style dictionary specifying the line width and dash pattern that shall be used in drawing the annotation’s border.

Returns: this PdfLineAnnotation instance.

◆ SetBorderStyle() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetBorderStyle ( PdfName style )

inlinevirtual

Setter for the annotation's preset border style.

Setter for the annotation's preset border style. Possible values are

PdfAnnotation.STYLE_SOLID
- A solid rectangle surrounding the annotation.
PdfAnnotation.STYLE_DASHED
- A dashed rectangle surrounding the annotation.
PdfAnnotation.STYLE_BEVELED
- A simulated embossed rectangle that appears to be raised above the surface of the page.
PdfAnnotation.STYLE_INSET
- A simulated engraved rectangle that appears to be recessed below the surface of the page.
PdfAnnotation.STYLE_UNDERLINE
- A single line along the bottom of the annotation rectangle.

◆ SetCaptionOffset() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetCaptionOffset ( float[] captionOffset )

inlinevirtual

Sets the offset of the caption text from its normal position.

Parameters

captionOffset an array of two floats that specifies the offset of the caption text from its normal position. The first value defines the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. The second value defines the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.

Returns: this PdfLineAnnotation instance.

◆ SetCaptionOffset() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetCaptionOffset ( PdfArray captionOffset )

inlinevirtual

Sets the offset of the caption text from its normal position.

Parameters

captionOffset a iText.Kernel.Pdf.PdfArray of two numbers that specifies the offset of the caption text from its normal position. The first value defines the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. The second value defines the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.

Returns: this PdfLineAnnotation instance.

◆ SetCaptionPosition()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetCaptionPosition ( PdfName captionPosition )

inlinevirtual

Sets annotation's caption positioning.

Sets annotation's caption positioning. Valid values are iText.Kernel.Pdf.PdfName.Inline , meaning the caption is centered inside the line, and iText.Kernel.Pdf.PdfName.Top , meaning the caption is on top of the line.

Parameters

captionPosition a name describing the annotation's caption positioning.

Returns: this PdfLineAnnotation instance.

◆ SetContentsAsCaption()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetContentsAsCaption ( bool contentsAsCaption )

inlinevirtual

If set to true, the text specified by the iText.Kernel.Pdf.PdfName.Contents or iText.Kernel.Pdf.PdfName.RC entries (see PdfAnnotation.GetContents() and PdfMarkupAnnotation.GetRichText() ) will be replicated as a caption in the appearance of the line.

Parameters

contentsAsCaption true, if the annotation text should be replicated as a caption, false otherwise.

Returns: this PdfLineAnnotation instance.

◆ SetDashPattern()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetDashPattern ( PdfArray dashPattern )

inlinevirtual

Setter for the annotation's preset dashed border style.

Setter for the annotation's preset dashed border style. This property has affect only if PdfAnnotation.STYLE_DASHED style was used for the annotation border style (see SetBorderStyle(iText.Kernel.Pdf.PdfName)See ISO-320001 8.4.3.6, "Line Dash Pattern" for the format in which dash pattern shall be specified.

Parameters

dashPattern a dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.

Returns: this PdfLineAnnotation instance.

◆ SetInteriorColor() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetInteriorColor ( float[] interiorColor )

inlinevirtual

An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings.

Parameters

interiorColor an array of floats in the range 0.0 to 1.0.

Returns: this PdfLineAnnotation instance.

◆ SetInteriorColor() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetInteriorColor ( PdfArray interiorColor )

inlinevirtual

An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings.

Parameters

interiorColor a iText.Kernel.Pdf.PdfArray of numbers in the range 0.0 to 1.0. The number of array elements determines the colour space in which the colour is defined: 0 - No colour, transparent; 1 - DeviceGray, 3 - DeviceRGB, 4 - DeviceCMYK. For the PdfRedactAnnotation number of elements shall be equal to 3 (which defines DeviceRGB colour space).

Returns: this PdfLineAnnotation instance.

◆ SetLeaderLineExtension()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetLeaderLineExtension ( float leaderLineExtension )

inlinevirtual

Sets the length of leader line extensions that extend from the line proper 180 degrees from the leader lines.

Sets the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. This value shall not be set unless iText.Kernel.Pdf.PdfName.LL is set.

Parameters

leaderLineExtension a non-negative float that represents the length of leader line extensions.

Returns: this PdfLineAnnotation instance.

◆ SetLeaderLineLength()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetLeaderLineLength ( float leaderLineLength )

inlinevirtual

Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself.

Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point (as specified by iText.Kernel.Pdf.PdfName.L (see GetLine() ); a negative value indicates the opposite direction.

Parameters

leaderLineLength a float specifying the length of leader lines in default user space.

Returns: this PdfLineAnnotation instance.

◆ SetLeaderLineOffset()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetLeaderLineOffset ( float leaderLineOffset )

inlinevirtual

Sets 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.

Parameters

leaderLineOffset a non-negative number that represents the length of the leader line offset.

Returns: this PdfLineAnnotation instance.

◆ SetLineEndingStyles()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetLineEndingStyles ( PdfArray lineEndingStyles )

inlinevirtual

Sets the line ending styles that are used in drawing the line.

Sets the line ending styles that are used in drawing the line. The first and second elements of the array shall specify the line ending styles for the endpoints defined, respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the iText.Kernel.Pdf.PdfName.L array (see GetLine() . Possible values for styles are:

iText.Kernel.Pdf.PdfName.Square
- A square filled with the annotation's interior color, if any;
iText.Kernel.Pdf.PdfName.Circle
- A circle filled with the annotation's interior color, if any;
iText.Kernel.Pdf.PdfName.Diamond
- A diamond shape filled with the annotation's interior color, if any;
iText.Kernel.Pdf.PdfName.OpenArrow
- Two short lines meeting in an acute angle to form an open arrowhead;
iText.Kernel.Pdf.PdfName.ClosedArrow
- Two short lines meeting in an acute angle as in the iText.Kernel.Pdf.PdfName.OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation's interior color, if any;
iText.Kernel.Pdf.PdfName.None
- No line ending;
iText.Kernel.Pdf.PdfName.Butt
- A short line at the endpoint perpendicular to the line itself;
iText.Kernel.Pdf.PdfName.ROpenArrow
- Two short lines in the reverse direction from iText.Kernel.Pdf.PdfName.OpenArrow ;
iText.Kernel.Pdf.PdfName.RClosedArrow
- A triangular closed arrowhead in the reverse direction from iText.Kernel.Pdf.PdfName.ClosedArrow ;
iText.Kernel.Pdf.PdfName.Slash
- A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself;

see also ISO-320001, Table 176 "Line ending styles".

Parameters

lineEndingStyles An array of two names specifying the line ending styles that is used in drawing the line.

Returns: this PdfLineAnnotation instance.

◆ SetMeasure()

virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation iText.Kernel.Pdf.Annot.PdfLineAnnotation.SetMeasure ( PdfDictionary measure )

inlinevirtual

Sets a measure dictionary that specifies the scale and units that apply to the line annotation.

Parameters

measure a iText.Kernel.Pdf.PdfDictionary that represents a measure dictionary, see ISO-320001, Table 261 for valid contents specification.

Returns: this PdfLineAnnotation instance.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfLineAnnotation()

Member Function Documentation

◆ GetBorderStyle()

◆ GetCaptionOffset()

◆ GetCaptionPosition()

◆ GetContentsAsCaption()

◆ GetInteriorColor()

◆ GetLeaderLineExtension()

◆ GetLeaderLineLength()

◆ GetLeaderLineOffset()

◆ GetLine()

◆ GetLineEndingStyles()

◆ GetMeasure()

◆ GetSubtype()

◆ SetBorderStyle() [1/2]

◆ SetBorderStyle() [2/2]

◆ SetCaptionOffset() [1/2]

◆ SetCaptionOffset() [2/2]

◆ SetCaptionPosition()

◆ SetContentsAsCaption()

◆ SetDashPattern()

◆ SetInteriorColor() [1/2]

◆ SetInteriorColor() [2/2]

◆ SetLeaderLineExtension()

◆ SetLeaderLineLength()

◆ SetLeaderLineOffset()

◆ SetLineEndingStyles()

◆ SetMeasure()