This documentation is archived and is not being maintained.

IToolboxUser.GetToolSupported Method

Gets a value indicating whether the specified tool is supported by the current designer.

[Visual Basic]
Function GetToolSupported( _
   ByVal tool As ToolboxItem _
) As Boolean
[C#]
bool GetToolSupported(
   ToolboxItem tool
);
[C++]
bool GetToolSupported(
   ToolboxItem* tool
);
[JScript]
function GetToolSupported(
   tool : ToolboxItem
) : Boolean;

Parameters

tool
The ToolboxItem to be tested for toolbox support.

Return Value

true if the tool is supported by the toolbox and can be enabled; false if the document designer does not know how to use the tool.

Remarks

If the specified tool is supported by the designer implementing the IToolboxUser interface, then the tool will be enabled in the toolbox when this designer has focus. Otherwise, it will be disabled. Once a tool is marked as enabled or disabled, it may not be tested for support with the same designer again.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

IToolboxUser Interface | IToolboxUser Members | System.Drawing.Design Namespace | ToolboxItem

Show: