SetBorderWidth()
Summary
Sets the line width used to draw the border of area features.
Syntax
SetBorderWidth(string lyr_set_name, real border_width)
| Argument | Contents |
|---|---|
| lyr_set_name | Name of the layer or selection set |
| border_width | The border width in points |
Notes
-
A border width of zero indicates the narrowest possible line (hairline).
-
You should set a border width of at least 0.25 if you plan to print the map.
-
When used on a selection set, a null value for border_width indicates that borders of selected features are drawn with the default border width for the layer.
-
If lyr_set_name is null, SetBorderWidth() operates on the current layer.
-
SetBorderWidth() 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
SetBorderWidth("U.S. States|", 0.25)
SetBorderWidth("U.S. States|Selection", 2.5)Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The layer or selection set does not exist |
See Also
| Function | Summary |
|---|---|
| GetBorderWidth() | Returns the width used to draw the border of area features |
| SetBorderColor() | Sets the color used to draw the border of area features |
| SetBorderStyle() | Sets the line style used to draw the border of area features |