nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

ArcGIS10 - Add Ins and Dockable Window

DTMGIS

Been playing with Add-Ins in 10 using Visual Studio 10 for most of the day. Interesting stuff. I seem to be being pushed in this direction with the switch to .NET from VBA, so I'm just diving in.

I have a few examples of buttons, tools, toolbars, etc. up and running, but what I really need to figure out are the Dockable Windows as part of an Add-In. The documentation is pretty lean in this area other than saying the are "easy" using the new Add-Ins. I have a Dockable Window added to my Add In, but I am having a heck of a time figuring out how to get it to display. I'd like to simply click on a button and have the Dockable Window displayed. It appears that this window should be able to hold the gammut of .NET controls, so I should be able to migrate a bit of my existing VBA Forms over to these Dockable Windows.

Can anyone please point me in the right direction or give a sample?

Thanks much!

-Tony

Find more posts tagged with

Accepted answers

All comments

TomGiles

Richard and Jose,

Sounds like you may be missing the reference to ESRI.ArcGIS.Framework.

In VS in Solutions Explorer, double click My project and goto the References tab. Do you see the Framework reference loaded? The DockableWindowManager is part of ESRI.ArcGIS.Framework.IDockableWindowManager.

dubravko - Great, simple post. +1

jakc - I believe you need a button to launch it (at least that is the solution I have read about on multiple forums).

SimonJackson

Can I ask a fairly basic (stupid?) question?
Do you need to have a button to open the dockable window?
I have added a dockable window to my Add-In (v10) and I am launching it from VS2010.

I can see via the Add-in manager that this add-in is in there, but I cannot see any window at run-time.

Do I have to then add a button to load the window?

DubravkoAntonic

Guys get use to it to use SDK help, it it a great source of answers. For this problem with dockable window you have complete solutions already done in SDK samples and snippets

http://help.arcgis.com/en/sdk/10.0/arcobjects_net/componenthelp/0023/0023000000nq000000.htm

I hope you'll find SDK link helpful.

JoseSanchez

I am having the same problem and I am using VB 2008 and ArcGIS 10

RichardGwozdz

Here is the code in C#:

       
UID dockWinID = new UIDClass();
dockWinID.Value = ThisAddIn.IDs.DockableWindow1;

// Use GetDockableWindow directly as we want the client IDockableWindow not the internal class
IDockableWindow dockWindow = ArcMap.DockableWindowManager.GetDockableWindow(dockWinID);
dockWindow.Show(true);

Can't seem to get the above to work:

    public class CAD_Test_01_button : ESRI.ArcGIS.Desktop.AddIns.Button
    {
        public CAD_Test_01_button()
        {
        }

        protected override void OnClick()
        {

            UID dockWinID = new UIDClass();
            dockWinID.Value = ThisAddIn.IDs.DockableWindow1;

            // Use GetDockableWindow directly as we want the client IDockableWindow not the internal class
            IDockableWindow dockWindow = ArcMap.DockableWindowManager.GetDockableWindow(dockWinID);
            dockWindow.Show(true);

        }

        protected override void OnUpdate()
        {
        }
    }

But I get the errors:

Error: The type or namespace name 'IDockableWindow' could not be found (are you missing a using directive or an assembly reference?)

Error: The name 'ArcMap' does not exist in the current context

What references could I be missing?

Thx,

Rich

HenryGomez_Rocha

My pal can you share the complete solution?, my email is samario@gmail.com, I am doing that, but when I press the button the dockable windows it isn´t displayed. Please help me because I need to use this function. Thanks in advance.

Henry.-

Here is the code in C#:

       
UID dockWinID = new UIDClass();
dockWinID.Value = ThisAddIn.IDs.DockableWindow1;

// Use GetDockableWindow directly as we want the client IDockableWindow not the internal class
IDockableWindow dockWindow = ArcMap.DockableWindowManager.GetDockableWindow(dockWinID);
dockWindow.Show(true);

SteveFang

Look at IWindowPosition interface if you want to adjust the size of a dockable window programmatically.

CraigPerreault

I have the property Locked = True in my DockableWindow but the user can still resize it.
Can we control the size of the Dockable Window?

RyanClark

Is it possible to change the width of the dockable window programmatically once it has been initialized? I can change the width of the UserControl just fine, but the dockable window retains its size...

Thanks,
Ryan

RyanClark

When should the form itself be getting initialized? I've used the code provided here to open up my dockable window, but when it opens I don't see any of the controls that I placed in the UserControl. The InitializeComponent() method is never getting called...

...
    protected override void OnClick()
        {
            UID theUid = new UIDClass();            
            theUid.Value = ThisAddIn.IDs.dwnMapUnitLegendEditor;

            IDockableWindow mapUnitForm = ArcMap.DockableWindowManager.GetDockableWindow(theUid);           
            mapUnitForm.Show(true);
        }
...

    /// <summary>
    /// Designer class of the dockable window add-in. It contains user interfaces that
    /// make up the dockable window.
    /// </summary>
    public partial class dwnMapUnitLegendEditor : UserControl
    {
        public dwnMapUnitLegendEditor(object hook)
        {
            InitializeComponent();
            this.Hook = hook;
        }

        /// <summary>
        /// Host object of the dockable window
        /// </summary>
        private object Hook
        {
            get;
            set;
        }

        /// <summary>
        /// Implementation class of the dockable window add-in. It is responsible for 
        /// creating and disposing the user interface class of the dockable window.
        /// </summary>
        public class AddinImpl : ESRI.ArcGIS.Desktop.AddIns.DockableWindow
        {
            private dwnMapUnitLegendEditor m_windowUI;

            public AddinImpl()
            {
                Console.Write("Something");
            }

            protected override IntPtr OnCreateChild()
            {
                m_windowUI = new dwnMapUnitLegendEditor(this.Hook);
                return m_windowUI.Handle;
            }

            protected override void Dispose(bool disposing)
            {
                if (m_windowUI != null)
                    m_windowUI.Dispose(disposing);

                base.Dispose(disposing);
            }

        }

JohnHauck

Here is the code in C#:

       
UID dockWinID = new UIDClass();
dockWinID.Value = ThisAddIn.IDs.DockableWindow1;

// Use GetDockableWindow directly as we want the client IDockableWindow not the internal class
IDockableWindow dockWindow = ArcMap.DockableWindowManager.GetDockableWindow(dockWinID);
dockWindow.Show(true);

JasonMiller

Does anyone have this code in C#?

JMiller

DTMGIS

Hah! Got it! Just needed to add 'Imports ESRI.ArcGIS.esriSystem' to the top of the code.

Again, many thanks! Works like a charm.

-T

DTMGIS

Lesley-
Thanks much. Pretty simple now that I see an example. One question. I am getting an error regarding the UID (Type 'UID' is not defined.). I seem to be missing a reference to somenthing. Any ideas? See attached image.

-Tony

LesleyBross

Here is my code for popping a Dockable Window from a Button in and add-in where 'DockableWindow1' is the class name for the dockable window class generated by the ESRI add-in wizard.

    Protected Overrides Sub OnClick()
        Dim dockWindow As ESRI.ArcGIS.Framework.IDockableWindow

        ' Only get/create the dockable window if it's not there
        If dockWindow Is Nothing Then
            Dim dockWinID As UID = New UIDClass()
            dockWinID.Value = My.ThisAddIn.IDs.DockableWindow1
            dockWindow = My.ArcMap.DockableWindowManager.GetDockableWindow(dockWinID)
        End If
        dockWindow.Show((Not dockWindow.IsVisible()))
    End Sub

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.