Windows Form in a Revit Addin

Question

I have written quite a few different add-ins now but I keep struggling to get a windows form working on Revit. The program builds fine and I have the dll set up for Revit to access.

Here are the different sections of my code. The program is more extensive than what is seen but I believe that the problem is a reference issue or a problem with my ADDIN file. Maybe there is a different way I need to set up my ADDIN file since I have a windows form in it?? Let me know.

Here is a Dropbox folder with the screenshots in it.

Let me know if there is anything else you need to see. The error in Revit says it has to do with the FullName but I believe I put it in the ADDIN file correctly, and I did it the same as I had for other ADDINs.

Thank you for your help!

[TransactionAttribute(TransactionMode.Manual)]
[RegenerationAttribute(RegenerationOption.Manual)]
public class CicuitChecker : IExternalCommand
{

    public Result Execute(
      ExternalCommandData commandData,
      ref string message,
      ElementSet elements)
    {
        //set document variable
        Document document = commandData.Application.ActiveUIDocument.Document;

        using (Transaction trans = new Transaction(document))
        {
            trans.Start("Circuit Checker");
            UIApplication uiApp = commandData.Application;
            Document doc = uiApp.ActiveUIDocument.Document;
            //run through looped form in case of user not selecting needed fields, and store what family the user wants the program to check
            Boolean messedUp = false;
            Boolean All = false, lightF = false, recep = false, elecEquip = false, equipCon = false, junc = false, panels = false;
            FilteredElementCollector collector = new FilteredElementCollector(doc), collector2 = new FilteredElementCollector(doc);
            while (messedUp)
            { 
                CircuitChecker.CircuitCheckerForm form = new CircuitChecker.CircuitCheckerForm();
                form.ShowDialog();
                //Get application and document objects


                foreach (String item in form.getSelectionElementsLB())
                {
                    if (item.Equals("All"))
                    {
                        All = true;
                        break;
                    }
                    else if (item.Equals("Lighting Fixtures"))
                    {
                        lightF = true;
                    }
                    else if (item.Equals("Recepticales"))
                    {
                        recep = true;
                    }
                    else if (item.Equals("Electrical Equipment (including Panels)"))
                    {
                        elecEquip = true;
                    }
                    else if (item.Equals("Junctions"))
                    {
                        junc = true;
                    }
                    else
                    {
                        messedUp = true;
                        TaskDialog.Show("Error", "At least one element must be selected.");

                    }
                }

                if (form.getSelectionPlaceLB().Equals("Entire Project"))
                {
                    collector
                        = new FilteredElementCollector(doc)
                        .WhereElementIsNotElementType();
                    collector2
                        = new FilteredElementCollector(doc)
                        .WhereElementIsNotElementType();
                }
                else if (form.getSelectionPlaceLB().Equals("Elements in Current View"))
                {
                    collector
                        = new FilteredElementCollector(doc, document.ActiveView.Id)
                        .WhereElementIsNotElementType();
                    collector2
                        = new FilteredElementCollector(doc, document.ActiveView.Id)
                        .WhereElementIsNotElementType();
                }
                else
                {
                    messedUp = true;
                    TaskDialog.Show("Error", "A place must be selected.");
                }
            }


            Color color = new Color(138, 43, 226); // RGB
            OverrideGraphicSettings ogs = new OverrideGraphicSettings();
            OverrideGraphicSettings ogsOriginal = new OverrideGraphicSettings();
            ogs.SetProjectionLineColor(color);
            int notCircuited = 0;
            //ElementId symbolId = family
            ElementCategoryFilter lightFilter = new ElementCategoryFilter(BuiltInCategory.OST_LightingFixtures);
            ElementCategoryFilter recepFilter = new ElementCategoryFilter(BuiltInCategory.OST_ElectricalFixtures);
            ElementCategoryFilter elecEquipFilter = new ElementCategoryFilter(BuiltInCategory.OST_ElectricalEquipment);
            //ElementClassFilter filter = new ElementClassFilter(typeof("Junction Boxes - Load"));
            //FamilyInstanceFilter juncFilter1 = new FamilyInstanceFilter(doc, );
            LogicalOrFilter first = new LogicalOrFilter(lightFilter, recepFilter);

            if (All)
            {


                collector.WherePasses(first);
                IList<Element> allArr = collector.ToElements();
                foreach (Element e in allArr)
                {
                    int cirNum = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_NUMBER).AsInteger();
                    String panel = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_PANEL_PARAM).AsString();
                    if (!(IsNumeric(cirNum)) || (panel.Equals("")) || (panel.Equals("<unnamed>")))
                    {
                        doc.ActiveView.SetElementOverrides(e.Id, ogs);
                        notCircuited++;
                    }
                    else
                    {
                        doc.ActiveView.SetElementOverrides(e.Id, ogsOriginal);
                    }
                }
                collector2.WherePasses(elecEquipFilter);
                IList<Element> elecEquipArr = collector.ToElements();
                foreach (Element e in elecEquipArr)
                {
                    String panel = e.get_Parameter(BuiltInParameter.RBS_ELEC_PANEL_SUPPLY_FROM_PARAM).AsString();
                    if ((panel.Equals("")))
                    {
                        doc.ActiveView.SetElementOverrides(e.Id, ogs);
                        notCircuited++;
                    }
                    else
                    {
                        doc.ActiveView.SetElementOverrides(e.Id, ogsOriginal);
                    }
                }
                TaskDialog.Show("Circuit Checker", notCircuited + " lighting fixtures are not circuited in this view.");
                trans.Commit();
            }

            if (!trans.HasEnded())
            {
                if (lightF)
                {
                    collector.WherePasses(lightFilter);
                    IList<Element> lightArr = collector.ToElements();
                    foreach (Element e in lightArr)
                    {
                        int cirNum = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_NUMBER).AsInteger();
                        String panel = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_PANEL_PARAM).AsString();
                        if (!(IsNumeric(cirNum)) || (panel.Equals("")) || (panel.Equals("<unnamed>")))
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogs);
                            notCircuited++;
                        }
                        else
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogsOriginal);
                        }
                    }
                }

                if (recep)
                {
                    collector.WherePasses(recepFilter);
                    IList<Element> recepArr = collector.ToElements();
                    foreach (Element e in recepArr)
                    {
                        int cirNum = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_NUMBER).AsInteger();
                        String panel = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_PANEL_PARAM).AsString();
                        if (!(IsNumeric(cirNum)) || (panel.Equals("")) || (panel.Equals("<unnamed>")))
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogs);
                            notCircuited++;
                        }
                        else
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogsOriginal);
                        }
                    }
                }
                if (elecEquip)
                {
                    collector.WherePasses(elecEquipFilter);
                    IList<Element> elecEquipArr = collector.ToElements();
                    foreach (Element e in elecEquipArr)
                    {
                        String panel = e.get_Parameter(BuiltInParameter.RBS_ELEC_PANEL_SUPPLY_FROM_PARAM).AsString();
                        if ((panel.Equals("")))
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogs);
                            notCircuited++;
                        }
                        else
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogsOriginal);
                        }
                    }
                }
                if (junc)
                {
                    collector.WherePasses(recepFilter);
                    IList<Element> juncArr = collector.ToElements();
                    foreach (Element e in juncArr)
                    {
                        int cirNum = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_NUMBER).AsInteger();
                        String panel = e.get_Parameter(BuiltInParameter.RBS_ELEC_CIRCUIT_PANEL_PARAM).AsString();
                        if (!(IsNumeric(cirNum)) || (panel.Equals("")) || (panel.Equals("<unnamed>")))
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogs);
                            notCircuited++;
                        }
                        else
                        {
                            doc.ActiveView.SetElementOverrides(e.Id, ogsOriginal);
                        }
                    }
                }

                TaskDialog.Show("Circuit Checker", notCircuited + " lighting fixtures are not circuited in this view.");
                trans.Commit();
            }
        }
        return Result.Succeeded;
    }
    public static Boolean IsNumeric(Object Expression)
    {
        if (Expression == null || Expression is DateTime)
            return false;

        if (Expression is Int16 || Expression is Int32 || Expression is Int64 || Expression is Decimal || Expression is Single || Expression is Double || Expression is Boolean)
            return true;

        try
        {
            if (Expression is string)
                Double.Parse(Expression as string);
            else
                Double.Parse(Expression.ToString());
            return true;
        }
        catch { } // just dismiss errors but return false
        return false;
    }
}

This code is having the functionality in the 'main class.' I have since moved the functionality to the form class as konrad suggested but am still receiving the FullClassName error in Revit. Please Help!

Answer 1

Here's how I usually set up my Windows Forms based External Commands. Remember that you have to create an External Command, and your addin manifest must point at this class. Then from this class you can launch the Form like so:

    [Transaction(TransactionMode.Manual)]
    public class SomeCommand : IExternalCommand
    {
        public Result Execute(
            ExternalCommandData commandData,
            ref string message,
            ElementSet elements)
        {
            // Get application and document objects
            UIApplication uiApp = commandData.Application;
            Document doc = uiApp.ActiveUIDocument.Document;
            UIDocument uidoc = uiApp.ActiveUIDocument;

            try
            {
                SomeNamespace.SomeForm form = new SomeNamespace.SomeForm(doc);
                form.ShowDialog();

                return Result.Succeeded;
            }
            // Catch any exceptions and display them
            catch (Autodesk.Revit.Exceptions.OperationCanceledException)
            {
                return Result.Cancelled;
            }
            catch (Exception ex)
            {
                message = ex.Message;
                return Result.Failed;
            }
        }
    }

So I have a Form class that I instantiate from my ExternalCommand and pass Document to its constructor. That way I have access to document when I am interacting with the form later. I wire up all functionality in code behind of the Form.

Answer 2

The schedule data add-in provides a full Visual Studio solution demonstrating how to display a Windows form in a Revit add-in, including the generation of the Windows form on the fly:

http://thebuildingcoder.typepad.com/blog/2012/05/the-schedule-api-and-access-to-schedule-data.html

Answer 3

Agree, the OP's question is why doesn't the addin work... From looking at the images, it seems like the issue is that Revit is not properly finding the full class name of the command.

It's a little unusual that you don't have your command class wrapped in a namespace (your form class is, for example).

I would recommend wrapping it in a namespace like "circuitchecker" - like your form class.

Then the "full name" in the addin file would become "circuitchecker.circuitchecker"

(the namespace.classname) - this helps Revit distinguish different classes that might have the same name.

side note: I don't believe that putting a URL into the Image/LargeImage fields in the addin will work - but not positive.