ToolboxBitmapAttribute.GetImage Method (Object, Boolean) (System.Drawing)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

ToolboxBitmapAttribute.GetImage Method (Object, Boolean)

Gets the small or large Image associated with this ToolboxBitmapAttribute object.

Namespace: System.Drawing
Assembly: System.Drawing (in System.Drawing.dll)

Syntax

Visual Basic

Public Function GetImage ( _
	component As Object, _
	large As Boolean _
) As Image

public Image GetImage(
	Object component,
	bool large
)

Visual C++

public:
Image^ GetImage(
	Object^ component, 
	bool large
)

member GetImage : 
        component:Object * 
        large:bool -> Image

Parameters

component: Type: System.Object
If this ToolboxBitmapAttribute object does not already have a small image, this method searches for a bitmap resource in the assembly that defines the type of the object specified by the component parameter. For example, if you pass an object of type ControlA to the component parameter, then this method searches the assembly that defines ControlA.

large: Type: System.Boolean
Specifies whether this method returns a large image (true) or a small image (false). The small image is 16 by 16, and the large image is 32 by 32.

Return Value

Type: System.Drawing.Image
An Image object associated with this ToolboxBitmapAttribute object.

Remarks

This method searches for a resource named namespace.classname.bmp, where namespace is the namespace containing the definition of the type of the object specified by the component parameter. For example, suppose you pass an object of type ControlA to the component parameter. If ControlA is in NamespaceA in AssemblyA.dll, then this method searches AssemblyA.dll for a resource named NamespaceA.ControlA.bmp.

If this ToolboxBitmapAttribute object does not already have a large image, this method creates a large image by scaling the small image.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

ToolboxBitmapAttribute Class

GetImage Overload

System.Drawing Namespace