ToolboxBitmapAttribute.GetImage Method

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

public:
 System::Drawing::Image ^ GetImage(System::Object ^ component);

public System.Drawing.Image? GetImage (object? component);

public System.Drawing.Image GetImage (object component);

member this.GetImage : obj -> System.Drawing.Image

Public Function GetImage (component As Object) As Image

Parameters

Returns

The small Image associated with this ToolboxBitmapAttribute object.

Examples

The following example demonstrates how to use the GetImage method.

private:
    static Image^ GetImageOfCustomControl(Control^ userControl)
    {
        Image^ controlImage = nullptr;
        AttributeCollection^ attrCol =
            TypeDescriptor::GetAttributes(userControl);
        ToolboxBitmapAttribute^ imageAttr = (ToolboxBitmapAttribute^)
            attrCol[ToolboxBitmapAttribute::typeid];
        if (imageAttr != nullptr)
        {
            controlImage = imageAttr->GetImage(userControl);
        }

        return controlImage;
    }

private Image GetImageOfCustomControl(Control userControl)
{
    Image controlImage = null;
    AttributeCollection attrCol = 
            TypeDescriptor.GetAttributes(userControl);
    ToolboxBitmapAttribute imageAttr = (ToolboxBitmapAttribute)
        attrCol[typeof(ToolboxBitmapAttribute)];
    if (imageAttr != null)
    {
        controlImage = imageAttr.GetImage(userControl);
    }

    return controlImage;
}

Private Function GetImageOfCustomControl(ByVal userControl As Control) As Image 
    Dim controlImage As Image = Nothing
    Dim attrCol As AttributeCollection = TypeDescriptor.GetAttributes(userControl)
    Dim imageAttr As ToolboxBitmapAttribute = _
        CType(attrCol(GetType(ToolboxBitmapAttribute)), ToolboxBitmapAttribute)
    If (imageAttr IsNot Nothing) Then
        controlImage = imageAttr.GetImage(userControl)
    End If
    
    Return controlImage

End Function

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.

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

public:
 System::Drawing::Image ^ GetImage(Type ^ type);

public System.Drawing.Image? GetImage (Type type);

public System.Drawing.Image GetImage (Type type);

member this.GetImage : Type -> System.Drawing.Image

Public Function GetImage (type As Type) As Image

Parameters

Returns

The small Image 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 specified by the type parameter. For example, suppose you pass typeof(ControlA) to the type parameter. If ControlA is in NamespaceA in AssemblyA.dll, then this method searches AssemblyA.dll for a resource named NamespaceA.ControlA.bmp.

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

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

public System.Drawing.Image? GetImage (object? component, bool large);

public System.Drawing.Image GetImage (object component, bool large);

member this.GetImage : obj * bool -> System.Drawing.Image

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

Parameters

Returns

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.

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

public:
 System::Drawing::Image ^ GetImage(Type ^ type, bool large);

public System.Drawing.Image? GetImage (Type type, bool large);

public System.Drawing.Image GetImage (Type type, bool large);

member this.GetImage : Type * bool -> System.Drawing.Image

Public Function GetImage (type As Type, large As Boolean) As Image

Parameters

Returns

An Image 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 specified by the type parameter. For example, suppose you pass an typeof(ControlA) to the type 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.

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

Source:

ToolboxBitmapAttribute.cs

public:
 System::Drawing::Image ^ GetImage(Type ^ type, System::String ^ imgName, bool large);

public System.Drawing.Image? GetImage (Type type, string? imgName, bool large);

public System.Drawing.Image GetImage (Type type, string imgName, bool large);

member this.GetImage : Type * string * bool -> System.Drawing.Image

Public Function GetImage (type As Type, imgName As String, large As Boolean) As Image

Parameters

Returns

An Image associated with this ToolboxBitmapAttribute object.

Remarks

This method searches for a resource named namespace.imgName, where namespace is the namespace containing the definition of the type specified by the type parameter. For example, suppose you pass typeof(ControlA) to the type parameter and that you passed "MyBitmap.bmp" to the imgName parameter. If ControlA is in NamespaceA in AssemblyA.dll, then this method searches AssemblyA.dll for a resource named NamespaceA.MyBitmap.bmp.

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