CreateScaleBar Method

Creates a scale bar element on a layout from a 2D coordinate geometry. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

ScaleBar CreateScaleBar( 
   ILayoutElementContainer elementContainer,
   Coordinate2D coord2D,
   MapFrame mapFrame,
   ScaleBarStyleItem styleItem
)

Function CreateScaleBar( _
   ByVal elementContainer As ILayoutElementContainer, _
   ByVal coord2D As Coordinate2D, _
   ByVal mapFrame As MapFrame, _
   Optional ByVal styleItem As ScaleBarStyleItem _
) As ScaleBar

Parameters

elementContainer: Layout or GroupElement
coord2D: Coordinate2D
mapFrame: Layout
styleItem: Map

Return Value

Returns a ScaleBar.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

If the element container is a Layout then the element gets added to the root level of the layout TOC at the top most position. If the element container is a GroupElement then it gets added to the group at the topmost position.

Example

//Create a scale bar for a specific map frame and assign a scale bar style item.

//Construct on the worker thread
await QueuedTask.Run(() =>
{
  //Reference a North Arrow in a style
  StyleProjectItem stylePrjItm = Project.Current.GetItems<StyleProjectItem>().FirstOrDefault(item => item.Name == "ArcGIS 2D");
  ScaleBarStyleItem sbStyleItm = stylePrjItm.SearchScaleBars("Double Alternating Scale Bar 1")[0];

  //Build geometry
  Coordinate2D center = new Coordinate2D(7, 8);

  //Reference MF, create north arrow and add to layout 
  MapFrame mf = layout.FindElement("New Map Frame") as MapFrame;
  if (mf == null)
  {
    ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show("Map frame not found", "WARNING");
    return;
  }
  ScaleBar sbElm = LayoutElementFactory.Instance.CreateScaleBar(layout, center, mf, sbStyleItm);
  sbElm.SetName("New Scale Bar");
  sbElm.SetWidth(2);
  sbElm.SetX(6);
  sbElm.SetY(7.5);
});

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

IElementFactory Interface
IElementFactory Members