ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMPointSymbol Class / HaloSize Property

In This Topic
    HaloSize Property (CIMPointSymbol)
    In This Topic
    Gets or sets the size of the halo that extends beyond the symbol shape.
    public double HaloSize {get; set;}
    Public Property HaloSize As Double
    Set halo property of north arrow
    //Set the CIM halo properties of a north arrow.
    //Reference the first selected element (assumption is it is a north arrow)
    Element northArrow = LayoutView.Active.GetSelectedElements().First();
    //Perform on the worker thread
    QueuedTask.Run(() =>
      //Get definition of north arrow...
      var cim = northArrow.GetDefinition() as CIMMarkerNorthArrow;
      //this halo symbol is 50% transparent, no outline (i.e. 0 width)
      //First construct a polygon symbol to use in the Halo
      //Polygon symbol will need a fill and a stroke
      var polyFill = SymbolFactory.Instance.ConstructSolidFill(ColorFactory.Instance.CreateRGBColor(0, 0, 0, 50));
      var polyStroke = SymbolFactory.Instance.ConstructStroke(ColorFactory.Instance.BlackRGB, 0);
      var haloPoly = SymbolFactory.Instance.ConstructPolygonSymbol(polyFill, polyStroke);
      //Set the north arrow defintion of HaloSymbol and HaloSize 
      ((CIMPointSymbol)cim.PointSymbol.Symbol).HaloSymbol = haloPoly;
      ((CIMPointSymbol)cim.PointSymbol.Symbol).HaloSize = 3;//size of the halo
      //Apply the CIM changes back to the element

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3 or higher.
    See Also