CreateTableFrame Method

Creates a tableFrame element on a layout from an envelope geometry. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

TableFrame CreateTableFrame( 
   ILayoutElementContainer elementContainer,
   Envelope envelope,
   MapFrame mapFrame,
   MapMember mapMember,
   string[] fieldNames
)

Function CreateTableFrame( _
   ByVal elementContainer As ILayoutElementContainer, _
   ByVal envelope As Envelope, _
   ByVal mapFrame As MapFrame, _
   ByVal mapMember As MapMember, _
   ByVal fieldNames() As String _
) As TableFrame

Parameters

elementContainer: Layout or GroupElement
envelope: Envelope
mapFrame: MapFrame
mapMember
fieldNames

Return Value

Returns a TableFrame.

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 table frame.

//Construct on the worker thread
await QueuedTask.Run(() =>
{
  //Build 2D envelope geometry
  Coordinate2D rec_ll = new Coordinate2D(1.0, 3.5);
  Coordinate2D rec_ur = new Coordinate2D(7.5, 4.5);
  Envelope rec_env = EnvelopeBuilder.CreateEnvelope(rec_ll, rec_ur);

  //Reference map frame and layer
  MapFrame mf = layout.FindElement("Map Frame") as MapFrame;
  Map m = mf.Map;
  FeatureLayer lyr = m.FindLayers("GreatLakes").First() as FeatureLayer;

  //Build fields list
  var fields = new[] { "NAME", "Shape_Area", "Shape_Length" };

  //Construct the table frame
  TableFrame tabFrame = LayoutElementFactory.Instance.CreateTableFrame(layout, rec_env, mf, lyr, fields);
});

Requirements

Target Platforms: Windows 10, Windows 8.1

Reference

IElementFactory Interface
IElementFactory Members