GetBitmap(String) Method

Retrieves a bitmap stored in an assembly's resources section.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetBitmap( _
   ByVal bitmapName As String _
) As Bitmap

'Usage
 
Dim instance As ResourceData
Dim bitmapName As String
Dim value As Bitmap
 
value = instance.GetBitmap(bitmapName)

public Bitmap GetBitmap( 
   string bitmapName
)

Parameters

bitmapName: The name of the bitmap resource (without the .bmp suffix).

Return Value

The desired bitmap.

Remarks

This method provides a general utility function to retrieve a Bitmap stored as an embedded resource in an assembly. The parameter specifies the name of the resource (without the .bmp suffix). The full name for the resource is {resourceBaseName}.{resource name}.bmp where {resourceBaseName} is the parameter to the constructor for this class.

This method assumes that the caller does not wish to define a special transparent color for the bitmap. The CommandManager and the DockManager have a property (ImageTransparentColor) that defines the transparent color for Images. The default value is the standard Teal color, the same color used by the Icon editor of Visual Studio to define the transparent areas. If a different transparent color is desired, then use the overloaded method that takes the transparentPt parameter to specify the pixel containing the desired transparent color.

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

Reference

ResourceData Class
ResourceData Members
Overload List