SetBorderStyle()

Summary

Sets the line style used to draw the border of area features.

Syntax

SetBorderStyle(string lyr_set_name, linestyle border_style)

Argument Contents
lyr_set_name Name of the layer or selection set
border_style The line style used to draw borders

Notes

  • When used on a selection set, a null value for border_style indicates that borders of selected features are drawn with the default border style for the layer.

  • If lyr_set_name is null, SetBorderStyle() operates on the current layer.

  • SetBorderStyle() normally operates on the current map. You can force it to operate on a different map by including the map name in lyr_set_name. For instance, "Map1|LayerA|" affects the display of LayerA in Map1.

Example

solid = LineStyle({{{1, -1, 0}}})
dashed = LineStyle({{{1, -1, 0, 1, 2}}})
SetBorderStyle("U.S. States|", solid)
SetBorderStyle("U.S. States|Selection", dashed)

Error Codes

Error Type Meaning
NotFound The layer or selection set does not exist

See Also

Function Summary
GetBorderStyle() Returns the style used to draw the border of area features
SetBorderColor() Sets the color used to draw the border of area features
SetBorderWidth() Sets the line width used to draw the border of area features