| Name | Description | |
|---|---|---|
 | GcWicBitmap Constructor | Overloaded. |
GcWicBitmap Class Members
In This Topic
The following tables list the members exposed by GcWicBitmap.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | Brush | Gets an instance of the GrapeCity.Documents.DX.Direct2D.SolidColorBrush class.
The brush becomes available after executing the EnsureRenderTargetCreated method. |
| D2DFactory | Gets an instance of the GrapeCity.Documents.DX.Direct2D.Factory1 class.
The factory becomes available after executing the EnsureRenderTargetCreated method. |
| DpiX | Gets the x-axis dpi resolution. |
| DpiY | Gets the y-axis dpi resolution. |
| DWFactory | Gets an instance of the GrapeCity.Documents.DX.DirectWrite.Factory1 class.
The factory becomes available after initializing the font cache (see the SetFontCache method). |
| Graphics | Gets an instance of the GcWicBitmapGraphics class.
The Graphics becomes available after executing the CreateGraphics method. |
 | GraphicsSupported | Gets a value indicating if GcWicBitmap supports the CreateGraphics method on the current platform. |
| HasImage | Gets a value indicating whether the underlying image exists (has been loaded or created). If this property is false, call Load() or CreateImage() to load or create the underlying image. Calling any other method will throw an exception unless this property is true. |
| Height | Gets the height of the image, in DIPs. |
| ImagingFactory | Gets an instance of the GrapeCity.Documents.DX.WIC.ImagingFactory class. |
| IsDisposed | Gets a value indicating whether the GcWicBitmap has been disposed of. |
| IsSupported | Gets a value indicating if GcWicBitmap is available on the current platform.
Make sure that "Thread.CurrentThread.SetApartmentState(ApartmentState.MTA)" is executed at the beginning of the Program.Main() method. |
| NativeBitmap | Gets the internal image that is an IWICBitmap. |
| PixelFormat | Gets the pixel format of the image. |
| PixelHeight | Gets the pixel height of the image. |
| PixelWidth | Gets the pixel width of the image. |
| RenderTarget | Gets an instance of the GrapeCity.Documents.DX.Direct2D.RenderTarget class.
The render target becomes available after executing the EnsureRenderTargetCreated method. |
| Width | Gets the width of the image, in DIPs. |
Public Methods
| Name | Description | |
|---|---|---|
 | ApplyLicenseKey | Applies a license key to an instance of GcWicBitmap. |
| BitsPerPixel | Returns the number of bits-per-pixel (bpp) for the given value of the PixelFormat enumeration. |
| CanConvertTo | Determines if the current pixel format can be converted to the destination pixel format. |
| CreateGraphics | Creates an instance of the GcWicBitmapGraphics class. |
| CreateImage | Creates the image of the given size and resolution.
The content is not initialized and can contain any random data. |
| CreatePaletteFromBitmap | Creates a palette using a computed optimized values based on the bitmap. |
| CreatePredefinedPalette | Creates one of the pre-defined palettes specified by PaletteType and optionally adds a transparent color. |
| DiscardImage | Releases the internal image and clears all metadata. |
| Dispose | Clean up any resources being used. |
| EnsureRenderTargetCreated | Creates a render target for the internal WIC image, if it has not been created yet. |
| ExportFragment | Overloaded. Copies a fragment of the image to the specified GrapeCity.Documents.Imaging.GcBitmap object. |
| GetImageStride | Returns the image stride (bytes per row). |
| GetPalette | Retrieves the color table for indexed pixel formats, or null for other formats. |
| Import | Overloaded. Loads the image from another instance of GcWicBitmap. |
| ImportAsFragment | Overloaded. Loads another GcWicBitmap at the given destination within the image. |
| Load | Overloaded. Loads the image from a System.IO.Stream. JPEG, PNG, GIF, BMP, TIFF, ICO, JPEG XR formats are supported. |
| PixelFormatFromGuid | Converts a GUID of the WIC pixel format to the PixelFormat enumeration value. |
| PixelFormatToGuid | Returns a GUID of the corresponding WIC pixel format for the given value of the PixelFormat enumeration. |
| Save | Overloaded. Saves the image to a System.IO.Stream using the specified format and options. |
| SaveAsBmp | Overloaded. Saves the image to a System.IO.Stream in BMP format. |
| SaveAsGif | Overloaded. Saves the image to a System.IO.Stream in GIF format. |
| SaveAsJpeg | Overloaded. Saves the image to a System.IO.Stream in JPEG format. |
| SaveAsJpegXR | Overloaded. Saves the image to a System.IO.Stream in JPEG XR format. |
| SaveAsPng | Overloaded. Saves the image to a System.IO.Stream in PNG format. |
| SaveAsTiff | Overloaded. Saves the image to a System.IO.Stream in TIFF format. |
| SetDpi | Overloaded. Changes the physical resolution of the image. |
| SetFontCache | Assigns a shared instance of the FontCache object. |
| SetLicenseKey | Sets the license key. |
| SetPalette | Sets the new color table for the bitmap. |
| ToByteArray | Overloaded. Stores the image buffer to a byte array (without the palette and metadata information). |
| ToGcBitmap | Overloaded. Stores the image buffer to a GrapeCity.Documents.Imaging.GcBitmap. |
| Transform | Creates a new instance of GcWicBitmap as a copy of the current bitmap passed through the set of transformations. |
See Also