Click or drag to resize

ApiSessionCreatePath Method (UInt64, String, String, Point)

Creates a new path inside a location.

Namespace:  Articy.Api
Assembly:  ArticyApp (in ArticyApp.dll) Version: 1.0.0
Syntax
C#
public ObjectProxy CreatePath(
	ulong aParentId,
	string aDisplayName,
	string aTemplateTechName,
	params Point[] aVertices
)

Parameters

aParentId
Type: SystemUInt64
the ID of the location or location group object that should serve as parent for the new created path
aDisplayName
Type: SystemString
the display name of the to-be-created path
aTemplateTechName
Type: SystemString
the technical name of a template, that will be assigned to the to-be-created path or null to create without assigning a template
aVertices
Type: System.WindowsPoint
a list of point coordinates that describe the course of the to-be-created path inside the location

Return Value

Type: ObjectProxy
the freshly created object; use this return value to further initialize the properties of the new path
Remarks
All coordinates are screen/pixel coordinates of the location's underlying background image.
See Also