ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.Geometry Namespace / SpatialReferenceBuilder Class / ToSpatialReference Method
Example

In This Topic
    ToSpatialReference Method
    In This Topic
    Returns a SpatialReference instance representing the current state of the builder. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public SpatialReference ToSpatialReference()
    Public Function ToSpatialReference() As SpatialReference

    Return Value

    Exceptions
    ExceptionDescription
    This method or property must be called within the lambda passed to QueuedTask.Run.
    Example
    Construct a SpatialReference - from a well-known ID
    {
      // Use a builder convenience method or use a builder constructor.
    
      // SpatialReferenceBuilder convenience methods don't need to run on the MCT.
      SpatialReference sr3857 = SpatialReferenceBuilder.CreateSpatialReference(3857);
    
      // SpatialReferenceBuilder constructors need to run on the MCT.
      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
      {
        using (SpatialReferenceBuilder srBuilder = new SpatialReferenceBuilder(3857))
        {
          // do something with the builder
    
          sr3857 = srBuilder.ToSpatialReference();
        }
      });
    }
    Construct a SpatialReference - from a string
    {
      // Use a builder convenience method or use a builder constructor.
    
      string wkt = "GEOGCS[\"MyGCS84\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Radian\",1.0]]";
    
      // SpatialReferenceBuilder convenience methods don't need to run on the MCT.
      SpatialReference sr = SpatialReferenceBuilder.CreateSpatialReference(wkt);
    
      // SpatialReferenceBuilder constructors need to run on the MCT.
      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
      {
        using (SpatialReferenceBuilder builder = new SpatialReferenceBuilder(wkt))
        {
          // do something with the builder
          SpatialReference anotherSR = builder.ToSpatialReference();
        }
      });
    }
    Construct a SpatialReference with a vertical coordinate system - from well-known IDs
    {
      // Use a builder convenience method or use a builder constructor.
      // see a list of vertical coordinate systems at http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Vertical_coordinate_systems/02r3000000rn000000/
    
      // Builder convenience methods don't need to run on the MCT.
      // 4326 = GCS_WGS_1984
      // 115700 = vertical WGS_1984
      SpatialReference sr4326_115700 = SpatialReferenceBuilder.CreateSpatialReference(4326, 115700);
    
      // SpatialReferenceBuilder constructors need to run on the MCT.
      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
      {
        using (SpatialReferenceBuilder sb = new SpatialReferenceBuilder(4326, 115700))
        {
          // SpatialReferenceBuilder properties
          //   sb.wkid == 4326
          //   sb.Wkt == "GEOGCS["MyGCS84",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],PRIMEM["Greenwich",0.0],UNIT[\"Radian\",1.0]]"
          //   sb.name == GCS_WGS_1984
          //   sb.vcsWkid == 115700
          //   sb.VcsWkt == "VERTCS["WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],PARAMETER["Vertical_Shift",0.0],PARAMETER["Direction",1.0],UNIT["Meter",1.0]]
    
          // do something with the builder
    
          sr4326_115700 = sb.ToSpatialReference();
        }
      });
    }
    Construct a SpatialReference with a vertical coordinate system - from a string
    {
      // Use a builder convenience method or use a builder constructor.
    
      // custom VCS - use vertical shift of -1.23 instead of 0
      string custom_vWkt = @"VERTCS[""SHD_height"",VDATUM[""Singapore_Height_Datum""],PARAMETER[""Vertical_Shift"",-1.23],PARAMETER[""Direction"",-1.0],UNIT[""Meter"",1.0]]";
    
      // Builder convenience methods don't need to run on the MCT.
      SpatialReference sr4326_customVertical = SpatialReferenceBuilder.CreateSpatialReference(4326, custom_vWkt);
      // SpatialReferenceBuilder properties
      //   sr4326_customVertical.wkid == 4326
      //   sr4326_customVertical.vert_wkid == 0
      //   sr4326_customVertical.vert_wkt == custom_vWkt
      //   sr4326_customVertical.hasVcs == true
    
      // SpatialReferenceBuilder constructors need to run on the MCT.
      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
      {
        using (SpatialReferenceBuilder sb = new SpatialReferenceBuilder(4326, custom_vWkt))
        {
          // do something with the builder
    
          sr4326_customVertical = sb.ToSpatialReference();
        }
      });
    }
    Construct a SpatialReference with a custom PCS - from a string
    {
      // Use a builder convenience method or use a builder constructor.
    
      // Custom PCS, Predefined GCS
      string customWkt = "PROJCS[\"WebMercatorMile\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Mercator_Auxiliary_Sphere\"],PARAMETER[\"False_Easting\",0.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",0.0],PARAMETER[\"Standard_Parallel_1\",0.0],PARAMETER[\"Auxiliary_Sphere_Type\",0.0],UNIT[\"Mile\",1609.344000614692]]";
    
      // Builder convenience methods don't need to run on the MCT.
      SpatialReference spatialReference = SpatialReferenceBuilder.CreateSpatialReference(customWkt);
      // SpatialReferenceBuilder properties
      //   spatialReference.Wkt == customWkt
      //   spatialReference.Wkid == 0
      //   spatialReference.VcsWkid == 0
      //   spatialReference.GcsWkid == 4326
    
      SpatialReference gcs = spatialReference.Gcs;
      // gcs.Wkid == 4326
      // gcs.IsGeographic == true
      // spatialReference.GcsWkt == gcs.Wkt
    
      // SpatialReferenceBuilder constructors need to run on the MCT.
      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
      {
        using (SpatialReferenceBuilder sb = new SpatialReferenceBuilder(customWkt))
        {
          // do something with the builder
    
          spatialReference = sb.ToSpatialReference();
        }
      });
    }
    SpatialReference Properties
    {
      // SpatialReferenceBuilder constructors need to run on the MCT.
      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
      {
        // use the builder constructor
        using (SpatialReferenceBuilder srBuilder = new SpatialReferenceBuilder(3857))
        {
          // spatial reference builder properties
          int builderWkid = srBuilder.Wkid;
          string builderWkt = srBuilder.Wkt;
          string builderName = srBuilder.Name;
    
          double xyScale = srBuilder.XYScale;
          double xyTolerance = srBuilder.XYTolerance;
          double xyResolution = srBuilder.XYResolution;
          Unit unit = srBuilder.Unit;
    
          double zScale = srBuilder.ZScale;
          double zTolerance = srBuilder.ZTolerance;
          Unit zUnit = srBuilder.ZUnit;
    
          double mScale = srBuilder.MScale;
          double mTolerance = srBuilder.MTolerance;
    
          double falseX = srBuilder.FalseX;
          double falseY = srBuilder.FalseY;
          double falseZ = srBuilder.FalseZ;
          double falseM = srBuilder.FalseM;
    
          // get the spatial reference
          SpatialReference sr3857 = srBuilder.ToSpatialReference();
    
          // spatial reference properties
          int srWkid = sr3857.Wkid;
          string srWkt = sr3857.Wkt;
          string srName = sr3857.Name;
    
          xyScale = sr3857.XYScale;
          xyTolerance = sr3857.XYTolerance;
          xyResolution = sr3857.XYResolution;
          unit = sr3857.Unit;
    
          zScale = sr3857.ZScale;
          zTolerance = sr3857.ZTolerance;
          zUnit = sr3857.ZUnit;
    
          mScale = sr3857.MScale;
          mTolerance = sr3857.MTolerance;
    
          falseX = sr3857.FalseX;
          falseY = sr3857.FalseY;
          falseZ = sr3857.FalseZ;
          falseM = sr3857.FalseM;
    
          bool hasVcs = sr3857.HasVcs;
        }
      });
    }
    Requirements

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

    ArcGIS Pro version: 3.0 or higher.
    See Also