ApiSessionCreateZonePolygon Method (UInt64, String, String, Point) |
Creates a new custom-shaped zone inside a location.
Namespace:
Articy.Api
Assembly:
ArticyApp (in ArticyApp.dll) Version: 1.0.0
Syntax public ObjectProxy CreateZonePolygon(
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 zone - aDisplayName
- Type: SystemString
the display name of the to-be-created zone - aTemplateTechName
- Type: SystemString
the technical name of a template, that will be assigned to the to-be-created zone or null to create without assigning a template - aVertices
- Type: System.WindowsPoint
a list of point coordinates that describe the polygonal shape of the to-be-created zone
Return Value
Type:
ObjectProxythe freshly created object; use this return value to further initialize the properties of the new zone
Remarks All coordinates are screen/pixel coordinates of the location's underlying background image.
See Also