PopupEntitySelection(EntityCapabilities,Boolean,Int32,String) Method
- Last UpdatedNov 06, 2025
- 1 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.
- An empty node can optionally be inserted at the beginning of the tree (to allow for selection of 'No Entity').
'Declaration
Public Overloads Shared Function PopupEntitySelection( _
ByVal capability As Utility.EntityCapabilities, _
ByVal includeEmptyNode As Boolean, _
ByRef entID As Integer, _
ByRef entName As String _
) As Boolean
public static bool PopupEntitySelection(
Utility.EntityCapabilities capability,
bool includeEmptyNode,
out int entID,
out string entName
)
Parameters
- capability
- Required. Holds the capability the entity must have in order to be selected.
- includeEmptyNode
- Required. Holds a flag that, if set to true, causes an empty node to be included at the top of the entity tree in the dialog. This allows for 'No Entity' to be selected by the user.
- entID
- Output. Returns the ID of the selected entity.
- entName
- Output. Returns the name of the selected entity.
Return Value
Returns true if the user selects an entity.