ImageCollection Members

The collection of Image objects to be used within DevExpress controls. The ImageCollection is also used as a part of the SharedImageCollection component.

Constructors

Name Description
ImageCollection() Initializes a new instance of the ImageCollection class.
ImageCollection(Boolean) Initializes a new instance of the ImageCollection class with the specified settings.
ImageCollection(IContainer) Initializes a new instance of the ImageCollection class with the specified container.

Properties

Name Description
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Container Gets the IContainer that contains the Component. Inherited from Component.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Images Provides access to the collection of images.
ImageSize Gets or sets the size of images in the image collection. For the SharedImageCollection, this property specifies the size of images fetched from an image strip (at design time or via the ImageCollection.AddImageStrip and ImageCollection.AddImageStripVertical methods).
ImageStream Gets or sets the handle to the ImageListStreamer associated with the current image collection.
IsDpiAware Gets or sets the value that specifies that when requesting an image from the ImageCollection, another DPI-specific image corresponding to the requested image is returned instead.
RegisteredAssemblies Provides access to external image-containing assemblies, registered by this ImageCollection.
Site Gets or sets the ISite of the Component. Inherited from Component.
TransparentColor Gets or sets the color to treat as transparent.

Methods

Name Description
AddImage(Image) Appends the specified image to the collection.
AddImage(Image, String) Adds an image with the specified name to the collection.
AddImage(Object, Image) static Appends the specified image to the specified list.
AddImageStrip(Image) Adds the images from the specified horizontal image strip to the collection.
AddImageStripVertical(Image) Adds the images from the specified vertical image strip to the collection.
AllowDPIAware() This member supports the internal infrastructure, and is not intended to be used directly from your code.
BeginInit() Notifies the image collection that initialization is starting.
Clear() Removes all images from the collection.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
DestroyImageListImage(Image) static This member supports the internal infrastructure, and is not intended to be used directly from your code.
Dispose() Releases all resources used by the Component. Inherited from Component.
DrawImageListImage(GraphicsCache, Image, Object, Int32, Rectangle, Boolean) static Draws the image.
DrawImageListImage(GraphicsCache, Image, Object, Int32, Rectangle, ImageAttributes) static Draws the specified image using the specified paint settings.
DrawImageListImage(GraphicsCache, Object, Int32, Rectangle) static Draws the specified image at the specified location.
DrawImageListImage(GraphicsCache, Object, Int32, Rectangle, ISvgPaletteProvider) static Draws the specified image using the specified paint settings.
DrawImageListImage(GraphicsCache, Object, Int32, Rectangle, Boolean) static Draws the image.
DrawImageListImage(GraphicsCache, Object, Int32, Rectangle, Boolean, ISvgPaletteProvider) static Draws the specified image using the specified paint settings.
DrawImageListImage(GraphicsCache, Object, Int32, Rectangle, ImageAttributes) static Draws the specified image using the specified paint settings.
DrawImageListImage(GraphicsCache, Object, Int32, Rectangle, ImageAttributes, ISvgPaletteProvider) static Draws the specified image using the specified paint settings.
DrawImageListImage(GraphicsInfoArgs, Object, Int32, Rectangle, Boolean) static Draws the specified image in the specified state and at the specified location.
EndInit() Notifies the image collection that initialization is complete.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
ExportToFile(String) Saves the contents of the current collection to a file.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetImageListImage(Object, Int32, ISvgPaletteProvider, Nullable<Size>, Nullable<Single>) static Returns the image at the specified position in the specified image list.
GetImageListImage(Object, Int32, Nullable<Single>) static Returns the image at the specified position in the specified image list.
GetImageListImage(Object, String, Nullable<Single>) static Returns the image with the specified key in the specified image list.
GetImageListImageCount(Object) static Returns the number of images within the specified source of images.
GetImageListImageSize(Object, Int32, Nullable<Single>) static Returns the size of the image at the specified position in the image list.
GetImageListSize(Image, Object, Int32) static Returns the size of the specified image or of an image in the image list addressed by a specific index.
GetImageListSize(Object, Nullable<Single>) static Returns the size of the images in the specified image list.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
ImageFromFile(String) static Returns the image stored in the specified file.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InsertGalleryImage(String, String, Image, Int32) This member supports the internal infrastructure, and is not intended to be used directly from your code.
InsertImage(Image, String, Type, Int32) Inserts an image from project resources.
InsertImage(Image, String, Type, Int32, String) Inserts an image from project resources.
InsertImage(Int32, String, String, Int32) This member supports the internal infrastructure, and is not intended to be used directly from your code.
IsImageExists(Image, Object, Int32) static This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IsImageListImageClone(Image) static This member supports the internal infrastructure, and is not intended to be used directly from your code.
IsImageListImageExists(Object, Int32) static Determines whether the image exists at the specified position within the specified source of images.
IsImageListImageScaled(Object) static This member supports the internal infrastructure, and is not intended to be used directly from your code.
IsImageListImageScaled(Object, Int32) static Returns whether the specified collection contains DPI-specific images.
IsSvgImageExists(Object, Int32) static Returns whether an image with the specified index exists in the specified collection.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterAssemblies(String[]) Registers specific external image-containing assemblies within your application.
SupportAnimation(Object, Int32) static This member supports the internal infrastructure, and is not intended to be used directly from your code.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
Changed Fires after the image collection has been changed.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
GetImageSize When the ImageCollection.IsDpiAware option is enabled, the GetImageSize event allows you to customize the size of images returned by the ImageCollection. This event is fired on finishing an ImageCollection object initialization.
ResolveImage When requesting an image from the ImageCollection, the ResolveImage event fires when the project resources do not contain a DPI-specific image that matches the requested image and allows you to provide this DPI-specific image manually. This event is in effect when the ImageCollection.IsDpiAware option is enabled and the requested image was loaded into the ImageCollection from the project resources.
See Also