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.
Implements
Inherited Members
Namespace: pdftron.PDF.Annots
Assembly: PDFNetiOS.dll
Syntax
public class PolyLine : Line, IDisposableConstructors
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 |
Finalize()
Releases all resources used by the PolyLine
Declaration
protected void Finalize()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(Int32)
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 |
|---|---|---|
| System.Int32 | 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 |
|---|---|
| System.Int32 | 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(PolyLine.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(Int32, 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 |
|---|---|---|
| System.Int32 | 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 |