SDK:IWidgetsProvider::GetWidgetByID

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

Member of SDK:IWidgetsProvider

Return the widget with the specified ID.

This is slightly slower than IWidgetsProvider::GetWidgetAt since it searches for widget.

virtual SWidgetDefinition* GetWidgetByID(
                     Sint32   widgetID) = 0;

Parameters

widgetID

Sint32

Widget identifier to search for.

Return Value

Returns pointer to SDK:SWidgetDefinition representing the widget. May return NULL if there is no widget with specified id.