Show / Hide Table of Contents

# Class PolyLine

Polyline annotations (PDF 1.5) display (open or closed) shapes of multiple edges on the page. Such polylines may have any number of vertices connected by straight lines. For open polylines, which is the default type of polylines, the first and last vertex are not implicitly connected. Closed polylines are polygons, whose first and last vertex are connected.

##### Inheritance

object
Annot
Markup
Line
PolyLine
Polygon

##### Implements

IDisposable

##### Inherited Members

Line.GetStartPoint()
Line.SetStartPoint(Point)
Line.GetEndPoint()
Line.SetEndPoint(Point)
Line.GetStartStyle()
Line.SetStartStyle(Line.EndingStyle)
Line.GetEndStyle()
Line.SetEndStyle(Line.EndingStyle)
Line.GetLeaderLineLength()
Line.SetLeaderLineLength(double)
Line.GetLeaderLineExtensionLength()
Line.SetLeaderLineExtensionLength(double)
Line.GetShowCaption()
Line.SetShowCaption(bool)
Line.GetIntentType()
Line.SetIntentType(Line.IntentType)
Line.GetLeaderLineOffset()
Line.SetLeaderLineOffset(double)
Line.GetCaptionPosition()
Line.SetCaptionPosition(Line.CapPos)
Line.GetTextHOffset()
Line.SetTextHOffset(double)
Line.GetTextVOffset()
Line.SetTextVOffset(double)
Markup.GetTitle()
Markup.SetTitle(string)
Markup.GetPopup()
Markup.SetPopup(Popup)
Markup.GetOpacity()
Markup.SetOpacity(double)
Markup.GetSubject()
Markup.SetSubject(string)
Markup.GetCreationDates()
Markup.SetCreationDates(Date)
Markup.GetBorderEffect()
Markup.SetBorderEffect(Markup.BorderEffect)
Markup.GetBorderEffectIntensity()
Markup.SetBorderEffectIntensity(double)
Markup.GetInteriorColor()
Markup.GetInteriorColorCompNum()
Markup.SetInteriorColor(ColorPt, int)
Markup.GetContentRect()
Markup.SetContentRect(Rect)
Markup.GetPadding()
Markup.SetPadding(Rect)
Markup.RotateAppearance(double)
Annot.Dispose()
Annot.Dispose(bool)
Annot.GetHandleInternal()
Annot.GetRefHandleInternal()
Annot.CreateInternal(IntPtr, object)
Annot.Create(SDFDoc, Annot.Type, Rect)
Annot.op_Assign(Annot)
Annot.Equals(object)
Annot.IsValid()
Annot.GetSDFObj()
Annot.GetType()
Annot.IsMarkup()
Annot.GetRect()
Annot.GetVisibleContentBox()
Annot.SetRect(Rect)
Annot.GetContents()
Annot.SetContents(string)
Annot.GetPage()
Annot.SetPage(Page)
Annot.GetUniqueID()
Annot.SetUniqueID(string)
Annot.GetDate()
Annot.SetDate(Date)
Annot.GetFlag(Annot.Flag)
Annot.SetFlag(Annot.Flag, bool)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance()
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance(Annot.AnnotationState, string)
Annot.SetAppearance(Obj)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj, Annot.AnnotationState, string)
Annot.RemoveAppearance()
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance(Annot.AnnotationState, string)
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(string)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt, int)
Annot.SetColor(ColorPt)
Annot.GetStructParent()
Annot.SetStructParent(int)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(int)
Annot.RefreshAppearance()
Annot.GetCustomData(string)
Annot.SetCustomData(string, string)
Annot.DeleteCustomData(string)
object.Equals(object, object)
object.GetHashCode()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF.Annots

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class PolyLine : Line, IDisposable

### Constructors

#### PolyLine(Annot)

Creates a PolyLine annotation and initialize it using given annotation object.

##### Declaration

    public PolyLine(Annot ann)

##### Parameters

Type | Name | Description
--- | --- | ---
Annot | ann | the annot

##### Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### PolyLine(Obj)

Creates a PolyLine annotation and initialize it using given Cos/SDF object.

##### Declaration

    public PolyLine(Obj d)

##### Parameters

Type | Name | Description
--- | --- | ---
Obj | d | the d

##### Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

### Methods

#### Create(SDFDoc, Rect)

Creates a new PolyLine annotation, in the specified document.

##### Declaration

    public static PolyLine Create(SDFDoc doc, Rect pos)

##### Parameters

Type | Name | Description
--- | --- | ---
SDFDoc | doc | A document to which the PolyLine annotation is added.
Rect | pos | A rectangle specifying the PolyLine annotation's bounds, specified in user space coordinates.

##### Returns

Type | Description
--- | ---
PolyLine | A newly created blank PolyLine annotation.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### ~PolyLine()

Releases all resources used by the PolyLine

##### Declaration

    protected ~PolyLine()

#### GetIntentName()

Gets the Intent name as an entry from the enum "IntentName" of the annnotation type.

##### Declaration

    public PolyLine.IntentType GetIntentName()

##### Returns

Type | Description
--- | ---
PolyLine.IntentType | the intent name

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### GetVertex(int)

Gets the vertex(in Point object form) corresponding to the index within the VErtices array.

##### Declaration

    public Point GetVertex(int idx)

##### Parameters

Type | Name | Description
--- | --- | ---
int | idx | The index position where the vertex is located.

##### Returns

Type | Description
--- | ---
Point | A Point object corresponding to the vertex in the specified index position.

##### Remarks

The Vertices array is An array of numbers specifying the width and dash pattern that shall represent each vertex in default user space in Point form,

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### GetVertexCount()

Gets the number of vertices in the Vertices array.

##### Declaration

    public int GetVertexCount()

##### Returns

Type | Description
--- | ---
int | An int indicating the number of vertices.

##### Remarks

The Vertices array is An array of numbers specifying the width and dash pattern that shall represent each vertex in default user space in Point form,

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### SetIntentName(IntentType)

Sets the Intent name as an entry from the enum "IntentName" of the annnotation type. (Optional; PDF 1.6 )

##### Declaration

    public void SetIntentName(PolyLine.IntentType mode)

##### Parameters

Type | Name | Description
--- | --- | ---
PolyLine.IntentType | mode | The intent name of the annotation using an entry from the enum "IntentName".

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### SetVertex(int, Point)

Sets the vertex(in Point object form) corresponding to the index within the VErtices array.

##### Declaration

    public void SetVertex(int idx, Point pt)

##### Parameters

Type | Name | Description
--- | --- | ---
int | idx | The index position where the vertex is to be located.
Point | pt | A Point object corresponding to the vertex to be added to the array.

##### Remarks

The Vertices array is An array of numbers specifying the width and dash pattern that shall represent each vertex in default user space in Point form,

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

### Implements

IDisposable