ComboBox

Public Class

This class represents a selection control with a drop-down list that can be shown or hidden by clicking the arrow.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.RibbonItem
Autodesk.Revit.UI.ComboBox

Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class ComboBox : RibbonItem

The ComboBox type exposes the following members.

Properties

Name

Description

Public Property
Current

Gets or sets the current checked ComboBox member of the ComboBox.

Public Property
Enabled

Gets or sets a value indicating whether the item is enabled.
(Inherited from RibbonItem)

Public Property
Image

The image shown on the ComboBox.

Public Property
ItemText

Gets or sets the text displayed on the item.
(Inherited from RibbonItem)

Public Property

ItemType

Gets the item type.
(Inherited from RibbonItem)

Public Property
LongDescription

Long description of the command tooltip
(Inherited from RibbonItem)

Public Property

Name

The name of the item.
(Inherited from RibbonItem)

Public Property
ToolTip

The description that appears as a ToolTip for the item.
(Inherited from RibbonItem)

Public Property
ToolTipImage

The image to show as a part of the button extended tooltip
(Inherited from RibbonItem)

Public Property
Visible

Gets or sets a value indicating whether the item is visible.
(Inherited from RibbonItem)

Methods

Name

Description

Public Method

AddItem

Adds a new item to the ComboBox.

Public Method

AddItems

Adds a new items to the ComboBox.

Public Method
AddSeparator

Adds a separator to the drop-down list.

Public Method

Equals

Determines whether the specified Object is equal to the current Object.
(Inherited from RibbonItem)

Public Method

GetContextualHelp

Gets the contextual help bound with this control.
(Inherited from RibbonItem)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetItems

Gets the copy of a collection of the ComboBoxMembers assigned to the ComboBox.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

SetContextualHelp

Sets the contextual help bound with this button.
(Inherited from RibbonItem)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Events

Name

Description

Public Event

CurrentChanged

Subscribe to this event to be notified when the current item of the ComboBox is changed.

Public Event

DropDownClosed

Subscribe to this event to be notified when the drop-down of the ComboBox is closed.

Public Event

DropDownOpened

Subscribe to this event to be notified when the drop-down of the ComboBox is opened.

Remarks

The order of items shown in the ComboBox depends upon the order which they were added, unless the ComboBoxMembers have been assigned to groups. If the members have been assigned groups, they will be sorted to fall under their groups regardless of the order in which they were added. Use of this class is not supported in Revit Macros.