topic Re: ArcObjects TextBox on Map Document in ArcObjects SDK Questions

ArcObjects TextBox on Map Document

JamariPowers — Mon, 07 Apr 2014 18:28:38 GMT

ArcMap 10.0
Arc Objects
Visual Studio 2010

I am new to using ArcObjects and have been getting more and more familiar with ArcMap. I am using Visual Studio and been having trouble creating / placing a simple textbox on an mxd. I am working in C#. I have a toolbar with buttons and hope to accomplish this on button click. The text box should be able to support text inside it as well.

Trying to start off small and work my way up. Any help on this topic would be greatly appreciated. Thanks in advance.

Re: ArcObjects TextBox on Map Document

AhmedEl-Sisi — Wed, 09 Apr 2014 04:52:04 GMT

You can place ITextElement on your map.
Check Text Element Snippt for Globe to get the idea.

Re: ArcObjects TextBox on Map Document

JamariPowers — Wed, 09 Apr 2014 13:32:24 GMT

Thanks for your input. I will take a look. I'm assuming the ITextElement, in simplistic terms, is a box that contains text? My confusion stems from wanting a text element or a textbox element. But again I assume they are essentially the same. Still getting used to Esri ArcObjects and training m mind to conform to their framework.

Re: ArcObjects TextBox on Map Document

LeoDonahue — Wed, 09 Apr 2014 14:51:10 GMT

I'm assuming the ITextElement, in simplistic terms, is a box that contains text?

Yes. That is why the previous post provided a link to the API documentation for ITextElement.

My confusion stems from wanting a text element or a textbox element. But again I assume they are essentially the same.

They are not the same. There is no such thing as a Textbox element in the ArcObjects API.

If "by the same" you mean they both provide a way to set and display text, then yes, they are essentially the same in that regard. You could check the ArcObjects API, but the .NET version is really impossible to find anything unless you are willing to click on every tree node in every namespace.

<sarcasm>Let's see, if I don't know what I'm looking for, perhaps it might be in the carto namespace, but maybe in A? or B? or C? Maybe it's cartoUI, but is it IA, or IB? or.. a list would be nice... </sarcasm>

Click this: http://resources.arcgis.com/en/help/arcobjects-java/api/arcobjects/index.html

Scroll through the frame on the lower left side of your browser. No Textbox elements.

Components that are provided by your IDE are usually added to a form or a dockable window and then displayed over the map document, or docked into one of the dockable areas.

Re: ArcObjects TextBox on Map Document

KenBuja — Wed, 09 Apr 2014 15:02:54 GMT

You could check the ArcObjects API, but the .NET version is really impossible to find anything unless you are willing to click on every tree node in every namespace.

<sarcasm>Let's see, if I don't know what I'm looking for, perhaps it might be in the carto namespace, but maybe in A? or B? or C? Maybe it's cartoUI, but is it IA, or IB? or.. a list would be nice... </sarcasm>

This is one reason I am using H3Viewer to browse through all the help documentation.

[ATTACH=CONFIG]32957[/ATTACH]

Re: ArcObjects TextBox on Map Document

LeoDonahue — Wed, 09 Apr 2014 15:14:28 GMT

That looks nice. Now they need to get that on the web.

Re: ArcObjects TextBox on Map Document

JamariPowers — Wed, 09 Apr 2014 17:26:53 GMT

If "by the same" you mean they both provide a way to set and display text, then yes, they are essentially the same in that regard. You could check the ArcObjects API, but the .NET version is really impossible to find anything unless you are willing to click on every tree node in every namespace.

Yes, that's what I meant. I think at this point, I've nearly gone through every tree node in every namespace. Completely new to this Esri ArcObjects thing. Clearly I'm still learning, but thanks so much for your assistance / help. I should be able to get somewhere now.

Re: ArcObjects TextBox on Map Document

JamariPowers — Thu, 10 Apr 2014 17:06:28 GMT

I am having some trouble. I have tried the following:

protected override void OnClick()
        {
            IElement _element;

            IMxDocument _mxDoc = ArcMap.Application.Document as IMxDocument;
            IMap _map = _mxDoc.FocusMap;
            IActiveView _activeView = _map as IActiveView;
            IPageLayout3 _pageLayout = _activeView as IPageLayout3;

            if (_activeView is IPageLayout3)
            {

                ITextElement _textElement = new TextElementClass();
                _element = _textElement as IElement;

                ITextSymbol _textSymbol = new TextSymbolClass();
                _textElement.Text = "Test me";
            }
            else
            {
                MessageBox.Show("This tool only functions in layout view");
            }
            _activeView.Refresh();

        }

But I am receiving the message box from the else statement. Am I even doing this right??

Please help??

Re: ArcObjects TextBox on Map Document

LeoDonahue — Sat, 11 Dec 2021 09:20:13 GMT

Apply this logic to whatever language you are programming in. I won't speak it's name. 🙂

package gov.gis.leo;

import java.io.IOException;

import javax.swing.JOptionPane;

import com.esri.arcgis.addins.desktop.Button;
import com.esri.arcgis.arcmapui.IMxDocument;
import com.esri.arcgis.carto.IActiveView;
import com.esri.arcgis.carto.IMap;
import com.esri.arcgis.carto.IPageLayout;
import com.esri.arcgis.framework.IApplication;
import com.esri.arcgis.interop.AutomationException;


public class Button1 extends Button {

    @Override
    public void init(IApplication arg0) throws IOException, AutomationException {
        super.init(arg0);
        this.app = arg0;
        
        // Initialize our map document
        mxDocument = (IMxDocument)app.getDocument();
    }

    /**
     * Called when the button is clicked.
     * 
     * @exception java.io.IOException if there are interop problems.
     * @exception com.esri.arcgis.interop.AutomationException if the component throws an ArcObjects exception.
     */
    @Override
    public void onClick() throws IOException, AutomationException {

        activeView = mxDocument.getActiveView();
        
        if(activeView instanceof IPageLayout){
            JOptionPane.showMessageDialog(null, "You are in Page Layout view");
        }
        
        if(activeView instanceof IMap){
            JOptionPane.showMessageDialog(null, "You are in data view");
        }
    }
    
    private IMxDocument mxDocument;
    private IApplication app;
    private IActiveView activeView;

}

Re: ArcObjects TextBox on Map Document

JamariPowers — Fri, 11 Apr 2014 15:46:18 GMT

Ok, I think I'm good until I hit the IF statement. I'm working in C# and not necessarily sure of how to write those statements in the "C#" way.

Wait,..scratch that. It worked. Using your logic and some syntax adjustments, I was able to determine which view I was in. Thank you so much.

Re: ArcObjects TextBox on Map Document

LeoDonahue — Fri, 11 Apr 2014 16:46:50 GMT

Well, thanks.

On the MSDN site, you can see the difference between using: is and typeof to compare types.

http://msdn.microsoft.com/en-us/library/scekt9xw.aspx

Re: ArcObjects TextBox on Map Document

JamariPowers — Tue, 15 Apr 2014 14:58:18 GMT

I am now working within a form. I've added a button to the form. I'm having trouble adding the 'ITextElement' to the mxd from clicking the button on the form. Is that possible?

My code snippet is below. Please help, again!!

namespace MapDecorator
{
    public partial class Form1 : Form
    {

        private IElement _element;
        private IGlobeGraphicsElementProperties _elementProperties;

        public Form1()
        {
            InitializeComponent();

        }

        private void Form1_Load(object sender, EventArgs e)
        {
            string[] files = System.IO.Directory.GetFiles(@"C:\This");

            this.comboBox1.Items.AddRange(files);
        }

        private void button1_Click(object sender, EventArgs e)
        {
            this.Close();
        }

        private void comboBox1_SelectedIndexChanged(object sender, EventArgs e)
        {

        }

        private void PlaceText_Click(object sender, EventArgs e)
        {
            ITextElement _textElement = new TextElementClass();
            _element = _textElement as IElement;
            ITextSymbol _textSymbol = new TextSymbolClass();
            _textElement.Text = "Test me";

            this._element = new TextElementClass();

        }
    }
}

Thanks in advance

Re: ArcObjects TextBox on Map Document

LeoDonahue — Tue, 15 Apr 2014 19:26:29 GMT

If you can wait long enough, ESRI will implement a form designer that lets non-programmers wire up GUI events to things like this.

Re: ArcObjects TextBox on Map Document

JamariPowers — Tue, 15 Apr 2014 19:43:57 GMT

eehhhh...I kinda need a solution to this asap. lol

Re: ArcObjects TextBox on Map Document

LeoDonahue — Tue, 15 Apr 2014 20:50:10 GMT

It is possible.

You add TextElements to a GraphicsContainer, which requires an ActiveView. Once you add the element of your choice to the GraphicsContainer, you refresh your ActiveView. TextElements also require that you set their text symbol and geometry so that they know where to go in the map.

If you want to do this from an IDE generated form and button, and not from an ESRI Add-In generated button, then you will need to find a way to get instances of your mxdocument from within your Form's instance.

Your most recent code sample is very sparse and is missing alot of this.

Try building a sample form with a button that when clicked returns properties of the mxdocument, such as the name or path of the document. Once you can do that, then building a TextElement and its dependencies and adding that to the Graphics Container will be easy.

Hint: if this "is" an Add-in project, then create a Button Add-in that launches your Form.

Re: ArcObjects TextBox on Map Document

JamariPowers — Wed, 16 Apr 2014 12:33:57 GMT

oooo000 I see....Ok. I'm beginning to get a better understanding of what needs to be done. Those ArcObjects sites don't explain things in dumb-downed terms for users who have never really used arcObjects (i.e. me).

Thanks again. I now have somewhat of a pseudo-coded plan of attack.

Re: ArcObjects TextBox on Map Document

LeoDonahue — Wed, 16 Apr 2014 12:52:47 GMT

Take this thread with a grain of salt, as there is no standard way of implementing this.

http://forums.arcgis.com/threads/101002-C-MVC-Add-in-pattern

Re: ArcObjects TextBox on Map Document

JamariPowers — Sat, 11 Dec 2021 09:20:16 GMT

So I think it's starting to come around. I was able to add a "box" to an mxd document. It was more so a legend but its a start. My code is below:

protected override void OnClick()
        {

            IMxDocument _mxDoc = ArcMap.Application.Document as IMxDocument;
            IMap _map = _mxDoc.FocusMap;

            IActiveView _activeView = _mxDoc.ActiveView;
           // IActiveView _activeView = _map as IActiveView;
            IPageLayout3 _pageLayout = _activeView as IPageLayout3;

            Double posX = 2.0;
            Double posY = 2.0;
            Double legW = 5.0;


            IGraphicsContainer _GraphContain = _pageLayout as IGraphicsContainer;
            IMapFrame _mapFrame = _GraphContain.FindFrame(_map) as IMapFrame;
            ESRI.ArcGIS.esriSystem.UID _uid = new UIDClass();
            _uid.Value = "esriCarto.Legend";
            IMapSurroundFrame _mapSurroundFrame = _mapFrame.CreateSurroundFrame((ESRI.ArcGIS.esriSystem.UID)_uid, null);
            
            IQuerySize _querySize = _mapSurroundFrame.MapSurround as IQuerySize;
            Double w = 0;
            Double h = 0;
            _querySize.QuerySize(ref w, ref h);
            Double aspectRatio = w / h;


            IEnvelope _envelope = new EnvelopeClass();
            _envelope.PutCoords(posX, posY, (posX * legW), (posY * legW / aspectRatio));
            IElement _element = _mapSurroundFrame as IElement;
            _element.Geometry = _envelope;
            _GraphContain.AddElement(_element, 0);

            _activeView = _mxDoc.ActiveView;

            if (_activeView is IPageLayout)
            
            {
                MessageBox.Show("You're in layout view");
            }
            else if (_activeView is IMap)
            {
                MessageBox.Show("You're in Data view");
                
            }
          
            _activeView.Refresh();

        }

I'm thinking I need to add a TextElement, as well as TextElement properties to the Graphics Container instead of just element properties. It is all grouped together with no real structure, but its a work in progress. What do you think?

Re: ArcObjects TextBox on Map Document

LeoDonahue — Sat, 11 Dec 2021 09:20:18 GMT

Review this. I think this is what you are after, except the group element.

import java.awt.event.MouseEvent;
import java.io.IOException;
import java.text.DecimalFormat;

import com.esri.arcgis.addins.desktop.Tool;
import com.esri.arcgis.arcmapui.IMxDocument;
import com.esri.arcgis.carto.GroupElement;
import com.esri.arcgis.carto.IActiveView;
import com.esri.arcgis.carto.IGraphicsContainer;
import com.esri.arcgis.carto.MarkerElement;
import com.esri.arcgis.carto.TextElement;
import com.esri.arcgis.display.IDisplayTransformation;
import com.esri.arcgis.display.IScreenDisplay;
import com.esri.arcgis.display.ITextSymbol;
import com.esri.arcgis.display.RgbColor;
import com.esri.arcgis.display.SimpleMarkerSymbol;
import com.esri.arcgis.display.TextSymbol;
import com.esri.arcgis.display.esriTextVerticalAlignment;
import com.esri.arcgis.framework.IApplication;
import com.esri.arcgis.geometry.IPoint;
import com.esri.arcgis.geometry.ISpatialReference;
import com.esri.arcgis.geometry.Point;
import com.esri.arcgis.geometry.SpatialReferenceEnvironment;
import com.esri.arcgis.interop.AutomationException;
import com.esri.arcgis.support.ms.stdole.StdFont;


public class Tool1 extends Tool {
    
    private IApplication app;
    private IActiveView av;
    private IMxDocument mxDocument;
    
    private String message;
    
    @Override
    public void activate() throws IOException, AutomationException {
        
    }

    @Override
    public void init(IApplication arg0) throws IOException, AutomationException {
        super.init(arg0);
        this.app = arg0;
        mxDocument = (IMxDocument) app.getDocument();
        av = mxDocument.getActiveView();
        
    }

    @Override
    public void mousePressed(MouseEvent mouseEvent) {
        super.mousePressed(mouseEvent);
        try{
            Point point1 = new Point();  // point where user clicks
            point1.putCoords((double)mouseEvent.getX(), (double)mouseEvent.getY());
            
            Point point2 = (Point) getMapCoordinatesFromScreenCoordinates(point1,av);
            double x = point2.getX();
            double y = point2.getY();
            DecimalFormat df = new DecimalFormat("#.####");
            message = "x: " + df.format(x) + " y: " + df.format(y);
            
            RgbColor color = new RgbColor();
            color.setRed(255);
            
            StdFont font = new StdFont();
            font.setName("Arial");
            
            SimpleMarkerSymbol sms = new SimpleMarkerSymbol();
            sms.setStyle(com.esri.arcgis.display.esriSimpleMarkerStyle.esriSMSCircle);
            sms.setColor(color);
            
            MarkerElement me = new MarkerElement();
            me.setSymbol(sms);
            me.setGeometry(point2);
            me.setName("me");
            
            ITextSymbol textSymbol = new TextSymbol();
            textSymbol.setColor(color);
            textSymbol.setFont(font);
            textSymbol.setSize(9);
            textSymbol.setVerticalAlignment(esriTextVerticalAlignment.esriTVACenter);
            
            TextElement textElement = new TextElement();
            textElement.setSymbol(textSymbol);
            textElement.setColor(color);
            textElement.setText(message);
            textElement.setGeometry(point2);
            textElement.setYOffset(11.27);
            textElement.setName("textElement");
            
            GroupElement gp = new GroupElement();
            gp.addElement(textElement);
            gp.addElement(me);
            gp.setName("click location");
            
            IGraphicsContainer graphicsContainer = av.getGraphicsContainer();
            graphicsContainer.addElement(gp, 0);
            av.partialRefresh(com.esri.arcgis.carto.esriViewDrawPhase.esriViewGraphics, gp, av.getExtent());
            
        } catch (IOException e) {
            e.printStackTrace();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    public IPoint getMapCoordinatesFromScreenCoordinates(IPoint screenPoint, IActiveView activeView)throws Exception{

        if (screenPoint == null || screenPoint.isEmpty() || activeView == null)
            return null;
        
        IScreenDisplay screenDisplay = activeView.getScreenDisplay();
        IDisplayTransformation displayTransformation = screenDisplay.getDisplayTransformation();

        return displayTransformation.toMapPoint((int)screenPoint.getX(), (int)
            screenPoint.getY());
    }

}

[ATTACH=CONFIG]33310[/ATTACH]

Re: ArcObjects TextBox on Map Document

JamariPowers — Thu, 24 Apr 2014 18:20:50 GMT

I appreciate your code snippet, but I still have no real understanding of all the misc other function calls (SimpleMarkerSymbol, MarkerElement, etc). I can look up their meaning but do not understand really why they are needed or why they should/would be needed. Like I said, I'm trying to understand and learn and create all from scratch. Code without explanation in my context won't really help

And because I am using C# and don't exaclty know of all the references needed to import, it makes it a tad bit more challenging. Thanks for the post though.