GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureImaging Class / ClearImage Method / ClearImage(Int32,Int32) Method
A unique image identifier of the GdPicture image representing the image in use.
A required color value to be set as the new background color. Use the GdPictureImaging.ARGBI method to obtain this value.





In This Topic
ClearImage(Int32,Int32) Method
In This Topic
Paints the specified image, that is represented by its unique image identifier, with the required color. The defined color is used to completely paint the image surface.
Syntax
'Declaration
 
Public Overloads Function ClearImage( _
   ByVal ImageID As Integer, _
   ByVal Color As Integer _
) As GdPictureStatus
public GdPictureStatus ClearImage( 
   int ImageID,
   int Color
)
public function ClearImage( 
    ImageID: Integer;
    Color: Integer
): GdPictureStatus; 
public function ClearImage( 
   ImageID : int,
   Color : int
) : GdPictureStatus;
public: GdPictureStatus ClearImage( 
   int ImageID,
   int Color
) 
public:
GdPictureStatus ClearImage( 
   int ImageID,
   int Color
) 

Parameters

ImageID
A unique image identifier of the GdPicture image representing the image in use.
Color
A required color value to be set as the new background color. Use the GdPictureImaging.ARGBI method to obtain this value.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

See Also