GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureImaging Class / SaveAsICO Method / SaveAsICO(Int32,String,Boolean,GdPictureColor,IconSize) Method
GdPicture image identifier.
A string that contains the name of the file to which to save the image. Can be an empty string. If empty, prompts the user to select a file. You can subsequently use the GetLastPath() method to retrieve the path of the selected file.
Whether the icon has a transparent color or not.
This parameter defines the transparent color of the icon. A suitable color value can be obtained by using the ARGB() method. This parameter will be ignored if HasTransparentColor is set to false.
A member of the IconSize enumeration. The icons size.





In This Topic
SaveAsICO(Int32,String,Boolean,GdPictureColor,IconSize) Method
In This Topic
Saves a GdPicture image as a window icon image format specifying whether it has a transparent color and the color to set as transparent if so.
Syntax
'Declaration
 
Public Overloads Function SaveAsICO( _
   ByVal ImageID As Integer, _
   ByVal FilePath As String, _
   ByVal HasTransparentColor As Boolean, _
   ByVal TransparentColor As GdPictureColor, _
   ByVal IconSize As IconSize _
) As GdPictureStatus
public function SaveAsICO( 
    ImageID: Integer;
    FilePath: String;
    HasTransparentColor: Boolean;
    TransparentColor: GdPictureColor;
    IconSize: IconSize
): GdPictureStatus; 
public function SaveAsICO( 
   ImageID : int,
   FilePath : String,
   HasTransparentColor : boolean,
   TransparentColor : GdPictureColor,
   IconSize : IconSize
) : GdPictureStatus;

Parameters

ImageID
GdPicture image identifier.
FilePath
A string that contains the name of the file to which to save the image. Can be an empty string. If empty, prompts the user to select a file. You can subsequently use the GetLastPath() method to retrieve the path of the selected file.
HasTransparentColor
Whether the icon has a transparent color or not.
TransparentColor
This parameter defines the transparent color of the icon. A suitable color value can be obtained by using the ARGB() method. This parameter will be ignored if HasTransparentColor is set to false.
IconSize
A member of the IconSize enumeration. The icons size.

Return Value

A member of the GdPictureStatus enumeration.
Remarks

This method requires the Image Documents component to run.

See Also