PopupEntitySelection(EntityCapabilities,Boolean,Int32,Int32,String,String) Method
- Last UpdatedNov 06, 2025
- 2 minute read
The PopupEntitySelection() method opens the Entity dialog, which allows entities to be selected based on a specified capability.
For this overload of the method:
- All entities in the entity tree can be seen, but only entities with the specified capability can be selected.
- A flag specifies whether multiple entities can be selected.
- One entity can be singled out to be unselectable even if the entity has the specified capability.
'Declaration
Public Overloads Shared Function PopupEntitySelection( _
ByVal capability As Utility.EntityCapabilities, _
ByVal AllowMultipleEntitySelection As Boolean, _
ByVal excludedEntID As Integer, _
ByRef entID As Integer, _
ByRef entName As String, _
ByRef entList As String _
) As Boolean
public static bool PopupEntitySelection(
Utility.EntityCapabilities capability,
bool AllowMultipleEntitySelection,
int excludedEntID,
out int entID,
out string entName,
out string entList
)
Parameters
- capability
- Required. Holds the capability the entity must have to be selected.
- AllowMultipleEntitySelection
- Required. Holds a flag that, if set to true, specifies that multiple entities can be selected. If set to false, only one entity can be selected.
- excludedEntID
- Required. Holds the ID of the entity to be excluded from selection even if it holds the specified capability.
- entID
- Output. Returns the ID of the selected entity.
- entName
- Output. Returns the name of the selected entity.
- entList
- Output. If AllowMultipleEntitySelection is true, the method returns a comma-separated list of the entity IDs (ent_id) that are selected in the Entity tree. If AllowMultipleEntitySelection is false, then the ID of the selected entity is returned.
Return Value
Returns true if the user selects at least one entity.