KGy SOFT Drawing Libraries Help
Image
Saves the specified image as an Icon without relying on a built-in encoder in the operating system.
Unlike the Save(Stream, ImageFormat) method, this one supports every PixelFormat and does not save a PNG stream when no built-in Icon encoder can be found in the operating system.
See the Remarks section of the SaveAsIcon(Image, Stream, Boolean) overload for details.
See the Remarks section of the SaveAsIcon(Image, Stream, Boolean) overload for details.
Definition
Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
C#
public static void SaveAsIcon(
this Image image,
string fileName,
bool forceUncompressedResult = false
)VB
<ExtensionAttribute>
Public Shared Sub SaveAsIcon (
image As Image,
fileName As String,
Optional forceUncompressedResult As Boolean = false
)C++
public:
[ExtensionAttribute]
static void SaveAsIcon(
Image^ image,
String^ fileName,
bool forceUncompressedResult = false
)F#
[<ExtensionAttribute>]
static member SaveAsIcon :
image : Image *
fileName : string *
?forceUncompressedResult : bool
(* Defaults:
let _forceUncompressedResult = defaultArg forceUncompressedResult false
*)
-> unit Parameters
- image Image
- The image to save. If contains multiple images other than multi-resolution icon bitmaps, then only the current frame will be saved.
- fileName String
- The name of the file to which to save the image. The directory of the specified path is created if it does not exist.
- forceUncompressedResult Boolean (Optional)
- to force saving an uncompressed icon;
to allow PNG compression, which is supported by Windows Vista and above. This parameter is optional.
Default value: .