UI.MultipleInputForm ++

Those who have paid attention to my previous post might have noticed that there was a new Form creation node in the Data-Shapes package called “UI.MultipleInputForm++” .

Edit: all the forms of the Data-Shapes Package now handle all screen resolution. 

The UI.MultipleInputForm++ node may have the exact same purpose as the previous UI.MultipleInputForm (which still works like this), but it allows more customization and offers the possibility to use ListView inputs. Here’s how it works :

What is new :

This new node has more inputs than UI.MultipleInputForm :


let’s go through the function of each input :

  • Description input (optional): the description input allows to add a description of what the workflow does at to top of the form :


The description is optional, in case you don’t add any input it will create a form without a header:


  • The Logo input (optional): This input allows to add your personnal logo at the bottom left of the form. The input must be an image. You don’t have to worry about the resolution or the size of your logo, the code has been made in such way that it will be automatically resized. You can obtain image inputs using filepath, File.FromPath and Image.ReadFromFile nodes. Your custon logo will also be converted to an icon and override the window icon :


The logo input is optional. In case you don’t add an image input, you’ll see the default Data-Shapes logo.

  • Button Text input (optional): UI.MultipleFormInput++ is all about customization! The “ButtonText” input allows you to change the text on the Form validation button:


This input is optional too and the default ButtonText value is “Set Values”.

The inputs:

UI.MultipleInputForm++ has a very different way to take inputs than UI.MultipleInputForm. Setting the user inputs asks for a little more work but it allows more flexibility and, once again, costumization. Let’s go through all the types of input:

  • TextBox input: In order to add a textbox input the form, you need to use the “UI.TextBox Data” node. This new method of creation allows to set the text box label and also the default value :


In case you don’t specify an InputName and DefaultText, a generic TextBox will be created :


  • Boolean input : Boolean inputs can be added in a similar way, using the           “UI.Boolean Data” node. Here too you can set the InputName and Default Value, or create a generic boolean input:


  • Filepath and DirectoryPath inputs : You will need “UI.FilePath Data” and “UI.DirectoryPath Data” nodes to add FilePaths and DirectoryPaths to the form. Once again you can customize the input label and also the default value if you want to:


In case you don’t enter default values, the buttons will read “FilePath” and “DirectoryPath”.

  • Revit selection inputs : For those types of input, you’ll need “UI.SelectModelElements Data”, “UI.SelectFaces Data” and “UI.SelectEdges Data” nodes. You can set the input label and the text that will be written on the buttons. If you don’t specify anything, generic texts (“Input”, “Select Face(s)”…) will be used.


  • Color selection input – Only with Revit 2017In order to add a color selection input to the form, you need to use UI.ColorSelection Data. — This input was inspired by Adrien_P’s comment on my previous post, which I think is great. This kind of interaction is really what I intended this blog to be about.– It uses the same method as Rhythm’s UI.ColorPicker by John Pierson. It calls the UI colors selection interface directly from a form button. Here too you can specify the label and button texts :


The form outputs a revit colour so, in case you need it, you can use Clockwork’s RevitColor.ToDynamoColor to convert it:


When used with Revit 2016 or previous version, you’ll get this message if you try and add a ColorInput :


  • DropDown and ListView inputs: These are created with “UI.DropDown Data” and “UI.ListView Data” nodes. The “Keys” are the elements that will be shown to the user, and the “Values” are the elements that will be returned accordingly to the keys. The keys must be strings ! The UI.ListView Data node allows you to set the height of the list window (notice the difference of list windows height in the following image):


  • TextNote : This input has been inspired by Micah (@kraftwerk15). It allows to add a textual note to the form. You can also add a title for the note (optional):



I hope this will further help people adopt dynamo workflows in your workplaces !

Here’s the code of this node:

#Copyright (c) mostafa el ayoubi , 2016
#Data-Shapes http://www.data-shapes.net , elayoubi.mostafa@gmail.com
import clr
from System.Drawing import Point , Size , Graphics, Bitmap, Image, Font, FontStyle, Icon, Color
from System.Windows.Forms import Application, Button, Form, Label, ColumnHeader, TextBox, CheckBox, FolderBrowserDialog, OpenFileDialog, DialogResult, ComboBox, FormBorderStyle, ListView, ListViewItem , SortOrder, Panel, ImageLayout, GroupBox
from System.Collections.Generic import *
from System.Windows.Forms import View as vi
from System import IntPtr
import sys
pyt_path = r'C:\Program Files (x86)\IronPython 2.7\Lib'
import os
from Autodesk.Revit.UI import Selection
importcolorselection = 0
from Autodesk.Revit.UI import ColorSelectionDialog
importcolorselection = 1
import Revit
from RevitServices.Persistence import DocumentManager
doc = DocumentManager.Instance.CurrentDBDocument
uidoc = DocumentManager.Instance.CurrentUIApplication.ActiveUIDocument
#getting screen resolution and creating resolution factor to handle high res screens
import ctypes
user32 = ctypes.windll.user32
resolutionX = user32.GetSystemMetrics(0)
resolutionY = user32.GetSystemMetrics(1)
resfactX = resolutionX/1920
resfactY = resolutionY/1080
class MultiTextBoxForm(Form):
def __init__(self):
self.Text = 'Data-Shapes | Multi Input UI ++'
self.output = []
self.values = []
def setclose(self, sender, event):
cbindexread = 0
for f in self.output:
if f.GetType() == TextBox:
if f.GetType() == CheckBox:
if f.GetType() == Button:
if f.Tag == None :
if f.GetType() == ComboBox:
key = f.Text
if f.GetType() == mylistview:
self.values.append([f.Values[i.Text] for i in f.CheckedItems])
def reset(self, sender, event):
def openfile(self, sender, event):
ofd = OpenFileDialog()
dr = ofd.ShowDialog()
if dr == DialogResult.OK:
sender.Text = ofd.FileName
def opendirectory(self, sender, event):
fbd = FolderBrowserDialog()
dr = fbd.ShowDialog()
if dr == DialogResult.OK:
sender.Text = fbd.SelectedPath
def pickobjects(self, sender, event):
sel = uidoc.Selection.PickObjects(Selection.ObjectType.Element,'')
selelem = [doc.GetElement(s.ElementId) for s in sel]
sender.Tag = (selelem)
def pickfaces(self, sender, event):
selface = uidoc.Selection.PickObjects(Selection.ObjectType.Face,'')
faces = [uidoc.Document.GetElement(s).GetGeometryObjectFromReference(s).ToProtoType(True) for s in selface]
sender.Tag = [i for f in faces for i in f]
def pickedges(self, sender, event):
seledge = uidoc.Selection.PickObjects(Selection.ObjectType.Edge,'')
edges = [uidoc.Document.GetElement(s).GetGeometryObjectFromReference(s).AsCurve().ToProtoType(True) for s in seledge]
sender.Tag = edges
def colorpicker(self, sender, event):
dialog = ColorSelectionDialog()
selection = ColorSelectionDialog.Show(dialog)
selected = dialog.SelectedColor
sender.Tag = selected
sender.BackColor = Color.FromArgb(selected.Red,selected.Green,selected.Blue)
sender.ForeColor = Color.FromArgb(selected.Red,selected.Green,selected.Blue)
def topmost(self):
self.TopMost = True
def lvadd(self, sender, event):
sender.Tag = [i for i in sender.CheckedItems]
class mylistview(ListView):
def __init__(self):
self.Values = []
#Form initialization
form = MultiTextBoxForm()
xlabel = 25*resfactX
xinput = 150*resfactX
y = 10*resfactY
inputheight = 20*resfactY
inputwidth = 160*resfactX
fields = []
error = 0
if IN[3] != "":
des = Label()
des.Font = Font("Arial", 15,FontStyle.Bold)
des.Location = Point(xlabel,y)
des.AutoSize = True
des.MaximumSize = Size(300*resfactX,0)
des.Text = IN[3]
y = des.Bottom + 40*resfactY
#Input form
if isinstance(IN[0],list):
inputtypes = IN[0]
inputtypes = [IN[0]]
for j in inputtypes:
label = Label()
label.Location = Point(xlabel,y+4)
label.AutoSize = True
label.MaximumSize = Size(120*resfactX,0)
label.Text = j.inputname
if j.__class__.__name__ == 'dropdown':
cb = ComboBox()
cb.Location = Point(xinput,y)
cb.Width = inputwidth
cb.Height = inputheight
[cb.Items.Add(i) for i in j.keys() if not (i == 'inputname' or i == 'height')]
cb.Tag = j
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'listview':
lv = mylistview()
lv.Values = j
lv.CheckBoxes = True
lv.View = vi.List
lv.Sorting = SortOrder.Ascending
[lv.Items.Add(i) for i in j.keys() if not (i == 'inputname' or i == 'height')]
lv.Location = Point(xinput,y)
lv.Width = inputwidth
lv.Height = j.height
lv.Scrollable = True
y = lv.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uitext':
tb = TextBox()
tb.Text = j.defaultvalue
tb.Width = inputwidth
tb.Height = inputheight
tb.Location = Point(xinput,y)
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uitextnote':
gb = GroupBox()
gb.Text = j.title
gb.Parent = form
gb.BackColor = Color.Transparent
gb.Location = Point(xlabel, y)
tn = Label()
tn.Location = Point(xlabel*resfactX,18*resfactY)
tn.AutoSize = True
tn.MaximumSize = Size(260*resfactX,0)
tn.Text = j.textnote
gb.Size = Size(285*resfactX, tn.Bottom-tn.Top+25*resfactY)
y = gb.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uibool':
yn = CheckBox()
yn.Width = inputwidth
yn.Height = inputheight
yn.Location = Point(xinput,y)
yn.Text = j.booltext
yn.Checked = j.defaultvalue
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uifilepath':
fp = Button()
fp.Width = inputwidth
fp.Height = inputheight
fp.Text = j.defaultvalue
fp.Location = Point(xinput,y)
fp.Click += form.openfile
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uidirectorypath':
dp = Button()
dp.Width = inputwidth
dp.Height = inputheight
dp.Text = j.defaultvalue
dp.Location = Point(xinput,y)
dp.Click += form.opendirectory
y = label.Bottom + 30*resfactY
elif j.__class__.__name__ == 'uiselectelements':
se = Button()
se.Width = inputwidth
se.Heigth = inputheight
se.Text = j.buttontext
se.Location = Point(xinput,y)
se.Click += form.pickobjects
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uiselectfaces':
sf = Button()
sf.Width = inputwidth
sf.Height = inputheight
sf.Text = j.buttontext
sf.Location = Point(xinput,y)
sf.Click += form.pickfaces
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uiselectedges':
sed = Button()
sed.Width = inputwidth
sed.Height = inputheight
sed.Text = j.buttontext
sed.Location = Point(xinput,y)
sed.Click += form.pickedges
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uicolorpick' and importcolorselection == 0:
cp = Button()
cp.Width = inputwidth
cp.Height = inputheight
cp.Text = j.buttontext
cp.Location = Point(xinput,y)
cp.Click += form.colorpicker
y = label.Bottom + 25*resfactY
elif j.__class__.__name__ == 'uicolorpick' and importcolorselection == 1:
importcolorselection = 2
#Adding validation button
button = Button()
button.Text = IN[1]
button.Width = inputwidth
button.Location = Point (150*resfactX,y+60*resfactY)
button.Click += form.setclose
form.MaximizeBox = False
form.MinimizeBox = False
form.FormBorderStyle = FormBorderStyle.FixedSingle
#Adding Logo
#default logo in case no input
#There won't be a default logo if your package folder is not the default one
deflogopath = os.getenv('APPDATA')+"\\Dynamo\Dynamo Revit\\1.2\packages\Data-Shapes\extra\\a.png"
if IN[4] == '':
ima = Image.FromFile(deflogopath)
else :
ima = IN[4]
logo = Panel()
logo.Size = Size(100*resfactX,100*resfactX)
ratio = (ima.Height)/(ima.Width)
h = float(ima.Height)
w = float(ima.Width)
ratio = h/w
scaledimage = Bitmap(100*resfactX,(100*ratio)*resfactY)
gr = Graphics.FromImage(scaledimage)
logo.BackgroundImage = scaledimage
logo.BackgroundImageLayout = ImageLayout.Center
logo.Location = Point(20*resfactX,y+20*resfactY)
#Setting icon
if IN[4] == '':
bmp = Bitmap.FromFile(deflogopath)
bmp = Bitmap(IN[4])
thumb = bmp.GetThumbnailImage(64*resfactX, 64*resfactX, bmp.GetThumbnailImageAbort,IntPtr.Zero)
icon = Icon.FromHandle(thumb.GetHicon())
form.Icon = icon
form.ShowIcon = False
form.Height = y + 180*resfactY
form.Width = 350*resfactX
if IN[2]:
if importcolorselection != 2:
result = form.values
OUT = result,True
OUT = ['ColorSelection input is only available With Revit 2017'] , False
else :
OUT = ['Set toggle to true!'] , False
import traceback
OUT = traceback.format_exc() , "error"

30 thoughts on “UI.MultipleInputForm ++

  1. I just had my first chance to try these out and using the dropdown node with lists I get “IronPython.Runtime.List” showing up in the userform dropdown instead of my list of keys. Any thoughts on what I’m doing wrong? Thanks.


  2. When I tried the “Revit selection inputs” I get the window as shown and it let me select the elements but when I try to select the faces I get an error messages:
    “Unhandled exception has occured in your application. If you click Continue, the application will ignore this error and attempt to continue. “


    1. Hi Cesare,
      After checking the revit API, it turns out ColorSelectionDialog is only exposed since Revit 2017:

      Thanks for pointing this out!! I fixed it so it doesn’t keep the form from working with previous revit versions. It will just let you know that the ColorSelection input is only available for Revit 2017. You can upload the package to version 2017.01.03 . Please let me know if it runs well.


    1. I thought the same. It can be solved by changing the python code:
      Adding the following to ‘from System.Windows.Forms import’ – “, ColumnHeaderAutoResizeStyle, ColumnHeaderStyle”

      and After line 185 ‘ ‘
      replace ‘lv.View = vi.List’ with ‘lv.View = vi.Details’

      Before the line ‘[lv.Items.Add(i) for i in j.keys() if not (i == ‘inputname’ or i == ‘height’)]’ add the lines ‘lv.Columns.Add(“Data”, 160)’ and ‘lv.HeaderStyle = ColumnHeaderStyle.None’

      After the line ‘[lv.Items.Add(i) for i in j.keys() if not (i == ‘inputname’ or i == ‘height’)]’ add the line ‘lv.AutoResizeColumns(ColumnHeaderAutoResizeStyle.ColumnContent)’

      That should get you a vertical list and horizontal scrollbars if the content is too wide to fit in th listbox.


  3. What a great improvement!

    Furthermore, I saw that there was added an integer slider to the newest update of the package – is there any way to insert a ‘step-value’ for this slider? I haven’t been succesful in doing so.

    With kind regards


  4. I can’t get the player to run my routine over and over and over again.
    “Traceback (most recent call last): File “”, line 474, in Indexerror: index out of range: 0″

    Any clues?


  5. Geart work !

    i was trying to duplicate the example “DropDown and ListView inputs” from above. i get the drop down menues as sh0wn, but the only problem ist that the categories names appear as “Autodesk.Revit.DB.Categories” instead of showing the real name of the category, i tried to figure it out but could not get the reason behind it.


  6. are your dialogue boxes able to be active…most of the time I use them it is for a single-function input. I would like to have a UI while running in Automatic mode.


  7. I am having an Issue where I cannot get the last example to work with two inputs, I can only run one input at a time, but when I combine them in a list, only the TextNote Data input comes through.

    Liked by 1 person

  8. Thanks for your reply. I was actually able to resolve my issue. When using the ‘List Create’ node in my program, the resulting list had to be flattened for the UI node to recognize both inputs. I am not sure if my ‘List Create” is different than your List.Create but adding a List.Flatten to the output worked for me.


  9. Hi
    First of all thank you for developing this package, It is increible useful.
    I’m having a problem with the selection element input. I select all the elemens that I want but it doesn’t let me to set the values and continue. I mean, the set values is blocked.
    Thank you


  10. Hi
    Thank you for developing this, It is amazing.
    I’m having a problem with changing the colors input. I am using Revit 2020. It is not working i select and then run but nothing happens
    Thank you


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.