TdxGPImage Class
The base class for all DevExpress image containers.
Declaration
TdxGPImage = class(
TdxCustomSmartImage
)Remarks
The TdxGPImage class implements base functionality for image containers with support for the following image formats:
- Device-independent bitmap (BMP or DIB)
- Graphics Interchange Format (GIF) with support for animation
- Joint Photographic Experts Group (JPG, JPEG, etc.)
- Portable Network Graphics (PNG)
- Tagged Image File Format (TIFF)
- Scalable Vector Graphics (SVG)
- Windows Metafile Formats (WMF and EMF)
Main API Members
The list below outlines key API members of the TdxGPImage class that allow you to work with images.
Image Container Creation
- Clone
- Creates a new image container populated with a copy of the stored image.
- CreateSize
- These overloaded methods create an image container filled with a specific color.
- CreateFromBitmap | CreateFromHBitmap | CreateFromBits | CreateFromStream
- Create an image container and populate it from the specified source.
- GetAsBitmap
- Creates a TBitmap container and populates it with the stored image.
Data Import and Export
- Assign | AssignFromGraphic | AssignFromSmartImage
- Repopulate the image container with an image from another image container.
- CopyToClipboard | CutToClipboard | PasteFromClipboard
- Move image data between the image container and the clipboard.
- GetBitmapBits
- Returns the stored image as an array of pixel data.
- LoadFromBits | LoadFromFieldValue | LoadFromResource | LoadFromStream
- Repopulate the image container from the specified source.
- SaveToStream | SaveToStreamByCodec
- Save the stored image to a stream.
- SaveToFile
- Saves the stored image to a file.
Content and Resource Management
- Clear
- Clears the image container.
- ChangeColor
- Fills all pixels of the stored image with a color.
- ConvertToBitmap
- Rasterizes the stored vector image.
- CreateCanvas | StretchDraw
- Draw the stored image.
- DefaultImageExifAutoRotation
Specifies the default automatic image rotation setting based on EXIF metadata.
This class property defines the default EXIF image rotation for all image editors[1] and containers in the application.
- Dormant | HandleNeeded
- Allow you to suspend and restore the image container to optimize GDI resource usage.
- ExifAutoRotation
- Allows you to explicitly enable or disable automatic image rotation based on EXIF metadata.
- Flip
- Flips the stored image horizontally or vertically.
- ImageCodec
- Specifies the format of the stored image. You can use this property to convert the stored image to any supported format, except for SVG.
- MakeComposition
- These overloaded functions blend two images from two image containers using the alpha channel.
- Resize | Scale
- Scale the source image.
Animation and Multi-Frame Image Settings
- ActiveFrame
- Specifies the currently displayed frame in a multi-frame image.
- AnimationFrameCount
- Returns the number of frames in a multi-frame image.
- Animation | AnimationLoop | AnimationLoopCount | AnimationLoopIndex | StartAnimation | StopAnimation
- Allow you to track and manage animation playback for the stored animated image.
General-Purpose API Members
- ClientRect | Size
- Return stored image dimensions.
- Compare
- Compares two image containers.
- GetHashCode
- Calculates a CRC32 hash code from stored image data.
- IsAlphaUsed
- Allows you to identify if the stored image has transparent pixels.
Terminal TdxGPImage Class Descendants
Do not use the TdxGPImage class directly. Use the following descendants instead:
Universal Image Containers
- TdxSmartGlyph
- A DPI-aware universal image container that can load an image from a DFM file.
- TdxSmartImage
- A universal container designed to store images in different formats.
- TdxOfficeImage
- A universal image container compatible with popular document formats.
Format-Specific Image Containers
- TdxBMPImage
- A Smart Image container designed to store BMP images.
- TdxGIFImage
- A Smart Image container designed to store GIF images.
- TdxJPEGImage
- A Smart Image container designed to store JPEG images.
- TdxPNGImage
- A Smart Image container designed to store PNG images.
Inheritance
Footnotes
-
The TcxImage editor supports EXIF image rotation when used as a standalone editor or as an in-place editor in Data Grid, Tree List, Vertical Grid, and Pivot Grid controls.
See Also