Reference Guide
GdPicture14 Namespace / GdPictureImaging Class / ClearImage Method / ClearImage(Int32,Color) Method
A unique image identifier of the GdPicture image representing the image in use.
A required color object to be set as the new background color. Use the ARGB(Byte,Byte,Byte,Byte) method to obtain this value.





In This Topic
    ClearImage(Int32,Color) 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 Color _
    ) As GdPictureStatus
    public GdPictureStatus ClearImage( 
       int ImageID,
       Color Color
    )
    public function ClearImage( 
        ImageID: Integer;
        Color: Color
    ): GdPictureStatus; 
    public function ClearImage( 
       ImageID : int,
       Color : Color
    ) : GdPictureStatus;
    public: GdPictureStatus ClearImage( 
       int ImageID,
       Color Color
    ) 
    public:
    GdPictureStatus ClearImage( 
       int ImageID,
       Color Color
    ) 

    Parameters

    ImageID
    A unique image identifier of the GdPicture image representing the image in use.
    Color
    A required color object to be set as the new background color. Use the ARGB(Byte,Byte,Byte,Byte) 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