CreateEnvelope(MapPoint,MapPoint,SpatialReference) Method

In This Topic

Convenience method to create a new instance of the Envelope class.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Shared Function CreateEnvelope( _
   ByVal minPoint As MapPoint, _
   ByVal maxPoint As MapPoint, _
   Optional ByVal spatialReference As SpatialReference _
) As Envelope

public static Envelope CreateEnvelope( 
   MapPoint minPoint,
   MapPoint maxPoint,
   SpatialReference spatialReference
)

Parameters

minPoint: Lower left corner of the envelope.
maxPoint: Upper right corner of the envelope.
spatialReference: (Optional) The SpatialReference. The default value is null. The spatial reference of each point is ignored.

Return Value

An Envelope

Exceptions

Exception	Description
System.ArgumentNullException	minPoint or maxPoint is null.

Remarks

The spatial references of the two points must be the same or null.The spatial references of the input points are ignored. There is no check to see if the spatial references are equal. If either point has coordinates that are outside the domain of the spatial reference, then unexpected results will occur when using the geometry.

The resulting envelope is normalized to ensure its XMin <= XMax, YMin <= YMax, ZMin <= ZMax and MMin <= MMax. If either of the xy-coordinate values are NaN, then the envelope is set to empty.

The resulting envelope inherits attributes, Z, M and ID-values, from the input points. For example, if either minPoint or maxPoint HasZ property is true, then the envelope's HasZ property is true.

Example

Construct a Polygon - from an Envelope

{
  // Use a builderEx convenience method or use a builderEx constructor.

  MapPoint minPt = MapPointBuilderEx.CreateMapPoint(1.0, 1.0);
  MapPoint maxPt = MapPointBuilderEx.CreateMapPoint(2.0, 2.0);

  // Create an envelope
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(minPt, maxPt);

  Polygon polygonFromEnv = PolygonBuilderEx.CreatePolygon(env);

  PolygonBuilderEx polygonBuilderEx = new PolygonBuilderEx(env);
  polygonBuilderEx.SpatialReference = SpatialReferences.WGS84;
  polygonFromEnv = polygonBuilderEx.ToGeometry() as Polygon;
}

Create Rectangle Element

{
  //Note: Must be on QueuedTask.Run

  //Build geometry
  Coordinate2D ll = new Coordinate2D(1.0, 4.75);
  Coordinate2D ur = new Coordinate2D(3.0, 5.75);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
    ColorFactory.Instance.BlackRGB, 5.0, SimpleLineStyle.Solid);
  CIMPolygonSymbol polySym = SymbolFactory.Instance.ConstructPolygonSymbol(
    ColorFactory.Instance.GreenRGB, SimpleFillStyle.DiagonalCross, outline);

  var ge = GraphicFactory.Instance.CreateSimpleGraphic(env, polySym);
  var elemInfo = new ElementInfo()
  {
    Anchor = Anchor.CenterPoint,
    Rotation = 45.0,
    CornerRounding = 5.0
  };

  ElementFactory.Instance.CreateGraphicElement(
    layout, env, polySym, "New Rectangle", false, elemInfo);
}

Create rectangle graphic with simple symbology

{
  //Create a simple 2D rectangle graphic and apply simple fill and
  //outline symbols.

  //Note: Must be on QueuedTask.Run

  //Build 2D envelope geometry
  Coordinate2D rec_ll = new Coordinate2D(1.0, 4.75);
  Coordinate2D rec_ur = new Coordinate2D(3.0, 5.75);

  Envelope rec_env = EnvelopeBuilderEx.CreateEnvelope(rec_ll, rec_ur);

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
    ColorFactory.Instance.BlackRGB, 5.0, SimpleLineStyle.Solid);
  CIMPolygonSymbol polySym = SymbolFactory.Instance.ConstructPolygonSymbol(
    ColorFactory.Instance.GreenRGB, SimpleFillStyle.DiagonalCross, outline);


  GraphicElement recElm = ElementFactory.Instance.CreateGraphicElement(
    layout, rec_env, polySym, "New Rectangle");
  //Or use Predefined shape
  GraphicElement recElm2 = ElementFactory.Instance.CreatePredefinedShapeGraphicElement(
                            layout, PredefinedShape.Rectangle, rec_env, polySym,
                            "New Rectangle2");
}

Create Point Text Element 1

{
  //Create a simple point text element and assign basic symbology and text settings.

  //Note: Must be on QueuedTask.Run
  //Build 2D point geometry
  Coordinate2D coord2D = new Coordinate2D(3.5, 10);

  //Set symbology, create and add element to layout
  CIMTextSymbol sym = SymbolFactory.Instance.ConstructTextSymbol(
                ColorFactory.Instance.RedRGB, 32, "Arial", "Regular");
  string textString = "Point text";

  //use ElementInfo to set placement properties during create
  var elemInfo = new ElementInfo()
  {
    Anchor = Anchor.CenterPoint,
    Rotation = 45
  };
  var ptTxtElm = ElementFactory.Instance.CreateTextGraphicElement(
    layout, TextType.PointText, coord2D.ToMapPoint(), sym, textString,
                       "New Point Text", true, elemInfo);

  //Change additional text properties
  ptTxtElm.SetX(4.5);
  ptTxtElm.SetY(9.5);
}

Create Map Frame and Set Camera

{
  //Create a map frame and set its camera by zooming to the extent of an existing bookmark.
  //Construct on the worker thread

  //Build 2D envelope geometry
  Coordinate2D mf_ll = new Coordinate2D(6.0, 8.5);
  Coordinate2D mf_ur = new Coordinate2D(8.0, 10.5);
  Envelope mf_env = EnvelopeBuilderEx.CreateEnvelope(mf_ll, mf_ur);

  //Reference map, create MF and add to layout
  MapProjectItem mapPrjItem = Project.Current.GetItems<MapProjectItem>()
                       .FirstOrDefault(item => item.Name.Equals("Map"));
  Map mfMap = mapPrjItem.GetMap();
  Bookmark bookmark = mfMap.GetBookmarks().FirstOrDefault(
                        b => b.Name == "Great Lakes");

  MapFrame mfElm = ElementFactory.Instance.CreateMapFrameElement(
                       layout, mf_env, mfMap, "New Map Frame");

  //Zoom to bookmark
  mfElm.SetCamera(bookmark);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

EnvelopeBuilderEx Class
EnvelopeBuilderEx Members
Overload List

Send feedback