Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Collapse DraftSight API HelpDraftSight API Help
Welcome
Getting Started
Release Notes
Access Diagram
Collapse Interop.dsAutomation NamespaceInterop.dsAutomation Namespace
Overview
Collapse InterfacesInterfaces
Expand IAlignedDimensionIAlignedDimension
Expand IAngularDimensionIAngularDimension
Expand IApplicationIApplication
Expand IApplicationOptionsIApplicationOptions
Expand IArcAlignedTextIArcAlignedText
Expand IArcLengthDimensionIArcLengthDimension
Expand IAttributeDefinitionIAttributeDefinition
Expand IAttributeInstanceIAttributeInstance
Expand IBlockDefinitionIBlockDefinition
Expand IBlockInstanceIBlockInstance
Expand ICircleICircle
Expand ICircleArcICircleArc
Expand IColorIColor
Expand IColorPickerIColorPicker
Expand ICommandICommand
Expand ICommandMessageICommandMessage
Expand IContextMenuItemIContextMenuItem
Expand ICurvedSettingsICurvedSettings
Expand ICustomCoordinateSystemICustomCoordinateSystem
Expand ICustomCoordinateSystemManagerICustomCoordinateSystemManager
Expand ICustomDataICustomData
Expand ICustomPropertyControlICustomPropertyControl
Expand IDgnDefinitionIDgnDefinition
Expand IDgnReferenceIDgnReference
Expand IDiameterDimensionIDiameterDimension
Expand IDictionaryIDictionary
Expand IDimensionStyleIDimensionStyle
Expand IDimensionStyleAngularDimensionOptionsIDimensionStyleAngularDimensionOptions
Expand IDimensionStyleArrowsOptionsIDimensionStyleArrowsOptions
Expand IDimensionStyleDualDimensionOptionsIDimensionStyleDualDimensionOptions
Expand IDimensionStyleFitOptionsIDimensionStyleFitOptions
Expand IDimensionStyleLinearDimensionOptionsIDimensionStyleLinearDimensionOptions
Expand IDimensionStyleLineOptionsIDimensionStyleLineOptions
Expand IDimensionStyleManagerIDimensionStyleManager
Expand IDimensionStyleRadialDiameterDimensionOptionsIDimensionStyleRadialDiameterDimensionOptions
Expand IDimensionStyleTextOptionsIDimensionStyleTextOptions
Expand IDimensionStyleToleranceOptionsIDimensionStyleToleranceOptions
Expand IDimensionStyleUserDataIDimensionStyleUserData
Expand IDocumentIDocument
Expand IDocumentExporterIDocumentExporter
Expand IDrawingPropertiesIDrawingProperties
Expand IDrawingSupportFilesIDrawingSupportFiles
Expand IDropDataIDropData
Expand IDSWindowIDSWindow
Expand IDynamicBlockInstancePropertyIDynamicBlockInstanceProperty
Expand IEllipseArcIEllipseArc
Expand IEmbeddedObjectIEmbeddedObject
Expand IEntityHelperIEntityHelper
Expand IExportSettingsIExportSettings
Expand IExternalReferenceIExternalReference
Expand IExtrudedSurfaceIExtrudedSurface
Expand IExtrusionIExtrusion
Expand IFaceIFace
Expand IGeneralDimensionIGeneralDimension
Expand IGradientBackgroundIGradientBackground
Expand IGroupIGroup
Expand IHatchIHatch
Expand IHatchBoundaryLoopIHatchBoundaryLoop
Expand IHatchPatternIHatchPattern
Expand IHighlightSetIHighlightSet
Expand IHyperLinkIHyperLink
Expand IImageBackgroundIImageBackground
Expand IImageDefinitionIImageDefinition
Expand IInfiniteLineIInfiniteLine
Expand IInterfaceFilesIInterfaceFiles
Expand IJoggedDimensionIJoggedDimension
Expand ILayerILayer
Expand ILayerManagerILayerManager
Expand ILayerPropertiesILayerProperties
Expand ILayerStateILayerState
Expand ILayerStateManagerILayerStateManager
Expand ILeaderILeader
Expand ILineILine
Expand ILineStyleILineStyle
Expand ILineStyleManagerILineStyleManager
Expand ILispFunctionILispFunction
Expand ILispParameterILispParameter
Expand ILoftILoft
Expand ILoftedSurfaceILoftedSurface
Expand IMacroManagerIMacroManager
Expand IMathCircArcIMathCircArc
Expand IMathEllipArcIMathEllipArc
Expand IMathLineIMathLine
Expand IMathPlaneIMathPlane
Expand IMathPointIMathPoint
Expand IMathTransformIMathTransform
Expand IMathUtilityIMathUtility
Expand IMathVectorIMathVector
Expand IMenuItemIMenuItem
Expand IModelIModel
Expand IModelNamedViewIModelNamedView
Expand INamedViewINamedView
Expand INoteINote
Expand IOrdinateDimensionIOrdinateDimension
Expand IPdfDefinitionIPdfDefinition
Expand IPdfReferenceIPdfReference
Expand IPointIPoint
Expand IPolyFaceMeshIPolyFaceMesh
Expand IPolygonMeshIPolygonMesh
Collapse IPolyLineIPolyLine
Expand IPolyLine3DIPolyLine3D
Expand IPrintManagerIPrintManager
Expand IPrintSpecificationIPrintSpecification
Expand IRadialDimensionIRadialDimension
Expand IRayIRay
Expand IReferenceImageIReferenceImage
Expand IReferenceManagerIReferenceManager
Expand IRegionIRegion
Expand IRevolveIRevolve
Expand IRevolvedSurfaceIRevolvedSurface
Expand IRibbonCommandButtonIRibbonCommandButton
Expand IRibbonPanelIRibbonPanel
Expand IRibbonQuickAccessBarIRibbonQuickAccessBar
Expand IRibbonQuickAccessBarItemIRibbonQuickAccessBarItem
Expand IRibbonRowIRibbonRow
Expand IRibbonRowItemIRibbonRowItem
Expand IRibbonRowPanelIRibbonRowPanel
Expand IRibbonSeparatorIRibbonSeparator
Expand IRibbonSplitButtonIRibbonSplitButton
Expand IRibbonSystemMenuIRibbonSystemMenu
Expand IRibbonSystemMenuItemIRibbonSystemMenuItem
Expand IRibbonTabIRibbonTab
Expand IRichLineIRichLine
Expand IRichLineStyleIRichLineStyle
Expand IRichLineStyleManagerIRichLineStyleManager
Expand IRotatedDimensionIRotatedDimension
Expand ISelectionFilterISelectionFilter
Expand ISelectionManagerISelectionManager
Expand IShapeIShape
Expand IShapeManagerIShapeManager
Expand ISheetISheet
Expand ISheetNamedViewISheetNamedView
Expand ISimpleNoteISimpleNote
Expand ISketchManagerISketchManager
Expand ISolidISolid
Expand ISolid3DISolid3D
Expand ISolidBackgroundISolidBackground
Expand ISplineISpline
Expand ISweepISweep
Expand ISweptSurfaceISweptSurface
Expand ISystemFilesISystemFiles
Expand ITableITable
Expand ITableStyleITableStyle
Expand ITableStyleManagerITableStyleManager
Expand ITextStyleITextStyle
Expand ITextStyleManagerITextStyleManager
Expand IToleranceITolerance
Expand IToolbarIToolbar
Expand IToolbarItemIToolbarItem
Expand ITraceITrace
Expand ITrackerITracker
Expand ITransparencyITransparency
Expand IUnknownEntityIUnknownEntity
Expand IUserCommandIUserCommand
Expand IViewManagerIViewManager
Expand IViewportIViewport
Expand IViewTileIViewTile
Expand IWorkspaceIWorkspace
Expand IXRecordIXRecord
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
IPolyLine Interface Members

The following tables list the members exposed by IPolyLine.

Public Properties

 NameDescription
PropertyClosedGets or sets whether to close the open 2D PolyLine.  
PropertyColorGets or sets the LineColor of this 2D PolyLine.  
PropertyElevationGets or sets the elevation of this 2D PolyLine.  
PropertyErasedGets or sets whether to erase or restore the 2D PolyLine.  
PropertyGlobalWidthGets the width of the entire length of the 2D PolyLine.  
PropertyHandleGets the value of the handle for the 2D PolyLine.  
PropertyLayerGets or sets the name of the Layer of the 2D PolyLine.  
PropertyLineScaleGets or sets the scale factor for the 2D PolyLine's LineStyle.  
PropertyLineStyleGets or sets the name of the LineStyle for the 2D PolyLine.  
PropertyLineStyleGenerationGets whether to use a continuous or dashed LineStyle around the vertices of the 2D PolyLine with a noncontinuous LineStyle.  
PropertyLineWeightGets or sets the LineWeight for the 2D PolyLine.  
PropertyPrintStyleGets or sets the name of the PrintStyle for this 2D PolyLine.  
PropertyThicknessGets or sets the thickness of this 2D PolyLine.  
PropertyTransparencyGets or sets the transparency object for this 2D PolyLine.  
PropertyTypeGets the type of 2D PolyLine.  
PropertyVisibleGets or sets whether to show the 2D PolyLine in the drawing.  
Top

Public Methods

 NameDescription
MethodAddVertexAfterAdds a vertex to the 2D PolyLine.  
MethodCreateExtensionDictionaryCreates a dictionary for the 2D PolyLine.  
MethodDecurveReverts the 2D PolyLine curve, created by IPolyLine::Fit or IPolyLine::Spline, to its original vertices.  
MethodDeleteCustomDataDeletes the specified custom data from the 2D PolyLine.  
MethodDeleteHyperLinkDeletes a hyperlink attached to the 2D PolyLine.  
MethodEvaluateAtDistanceGets the point on the 2D PolyLine closest to the specified distance from the start point. Also gets the corresponding U parameter and two derivatives at that point.  
MethodEvaluateAtParameterGets the point on the 2D PolyLine corresponding to the specified U parameter and gets the two derivatives at the point. Also gets the distance of the point from the start point.  
MethodEvaluateAtPointGets the corresponding U parameter, the distance from the start point, and the two derivatives at the specified point on the 2D PolyLine.  
MethodFitTurns the 2D PolyLine into a smooth curve consisting of Arcs joining each pair of vertices.  
MethodGetBoundingBoxGets the bounding box enclosing the 2D PolyLine.  
MethodGetClosestPointOnGets the point on the 2D PolyLine that is closest to the specified point.  
MethodGetCustomDataGets the specified custom data for the 2D PolyLine.  
MethodGetEndParamsGets the start and end parameters of the 2D PolyLine.  
MethodGetExtensionDictionaryGets the dictionary for the 2D PolyLine.  
MethodGetHyperLinkGets the hyperlink attached to the 2D PolyLine.  
MethodGetLengthGets the length of the 2D PolyLine.  
MethodGetNormalGets the vector normal to this 2D PolyLine.  
MethodGetSegmentAngleGets the angle at the specified vertex of this 2D PolyLine segment.  
MethodGetSegmentEndWidthGets the end width of the specified 2D PolyLine segment.  
MethodGetSegmentStartWidthGets the start width of the specified 2D PolyLine segment.  
MethodGetSegmentTypeGets the type of 2D PolyLine segment.  
MethodGetVertexCoordinateGets the coordinates of the specified vertex of this 2D PolyLine.  
MethodGetVerticesCountGets the number of vertices in the 2D PolyLine.  
MethodJoinCircleArcJoins the specified Arc with this 2D PolyLine.  
MethodJoinLineJoins the specified line with this 2D PolyLine.  
MethodJoinPolyLineJoins the specified 2D PolyLine with this 2D PolyLine.  
MethodReleaseExtensionDictionaryReleases and erases the dictionary for the 2D PolyLine, if the dictionary exists and is empty.  
MethodRemoveVertexRemoves the vertex corresponding to the specified index.  
MethodSelectAdds or removes the selected 2D PolyLine to or from the current selection set.  
MethodSetCustomDataSets the custom data for the 2D PolyLine.  
MethodSetHyperLinkAttaches the specified hyperlink to the 2D PolyLine.  
MethodSetNormalSets the vector normal to this 2D PolyLine.  
MethodSetSegmentAngleSets the angle at the specified vertex of this 2D PolyLine segment.  
MethodSetSegmentEndWidthSets the end width of the specified 2D PolyLine segment.  
MethodSetSegmentStartWidthSets the start width of the specified 2D PolyLine segment.  
MethodSetVertexCoordinateSets the coordinates of the specified vertex of this 2D PolyLine.  
MethodSplineTurns the 2D PolyLine into a curve using the vertices as control points.  
MethodSplitSplits the 2D PolyLine at the specified vertex and creates a new 2D PolyLine.  
MethodStraightenStraightens the 2D PolyLine between the two specified vertices.  
Top

See Also



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   IPolyLine Interface Members
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2021 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.21