CreateLineSegment(MapPoint,MapPoint,SpatialReference) Method

In This Topic

Convenience method to create a new instance of the LineSegment class.

Syntax

C#
Visual Basic (Declaration)

public static LineSegment CreateLineSegment( 
   MapPoint startPoint,
   MapPoint endPoint,
   SpatialReference spatialReference
)

Public Overloads Shared Function CreateLineSegment( _
   ByVal startPoint As MapPoint, _
   ByVal endPoint As MapPoint, _
   Optional ByVal spatialReference As SpatialReference _
) As LineSegment

Parameters

startPoint: The start point.
endPoint: The end point.
spatialReference: (Optional) The SpatialReference. The default value is null. The spatial references of the start point and end point are ignored.

Return Value

A LineSegment.

Exceptions

Exception	Description
System.ArgumentNullException	startPoint or endPoint is null or empty.

Remarks

The new instance will build a straight line segment between the start and end point. Attributes are inherited from the start and end points.

Line Segment

Example

Construct a LineSegment using two MapPoints

// Use a builderEx convenience method or use a builderEx constructor.

MapPoint startPt = MapPointBuilderEx.CreateMapPoint(1.0, 1.0);
MapPoint endPt = MapPointBuilderEx.CreateMapPoint(2.0, 1.0);

// BuilderEx convenience methods don't need to run on the MCT.
LineSegment lineFromMapPoint = LineBuilderEx.CreateLineSegment(startPt, endPt);

// coordinate2D
Coordinate2D start2d = (Coordinate2D)startPt;
Coordinate2D end2d = (Coordinate2D)endPt;

LineSegment lineFromCoordinate2D = LineBuilderEx.CreateLineSegment(start2d, end2d);

// coordinate3D
Coordinate3D start3d = (Coordinate3D)startPt;
Coordinate3D end3d = (Coordinate3D)endPt;

LineSegment lineFromCoordinate3D = LineBuilderEx.CreateLineSegment(start3d, end3d);

// lineSegment
LineSegment anotherLineFromLineSegment = LineBuilderEx.CreateLineSegment(lineFromCoordinate3D);


// builderEx constructors don't need to run on the MCT
LineBuilderEx lbEx = new LineBuilderEx(startPt, endPt);
lineFromMapPoint = lbEx.ToSegment() as LineSegment;

lbEx = new LineBuilderEx(start2d, end2d);
lineFromCoordinate2D = lbEx.ToSegment() as LineSegment;

lbEx = new LineBuilderEx(start3d, end3d);
lineFromCoordinate3D = lbEx.ToSegment() as LineSegment;

lbEx = new LineBuilderEx(startPt, endPt);
lineFromMapPoint = lbEx.ToSegment() as LineSegment;

lbEx = new LineBuilderEx(lineFromCoordinate3D);
anotherLineFromLineSegment = lbEx.ToSegment() as LineSegment;

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

LineBuilderEx Class
LineBuilderEx Members
Overload List

Send feedback