All docs
V20.1
20.2 (EAP/Beta)
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

ImageCollection<TImage, TInfo> Members

A base class that provides API for the DevExpress.Utils.SvgImageCollection component.

Constructors

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

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.
Count Returns the current number of images in this collection.
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.
ImageInfos Returns the Info objects for all images owned by this collection.
ImageSize Gets or sets the default size for raster images rendered based on vector images. This setting is used if a control does not specify the size.
Item[Int32] Returns a collection image by its index.
Item[String] Returns a collection image by its name.
Keys Returns names for all images kept in this collection.
ScaledImageSize Returns the actual (DPI-aware) size of images stored in this SvgImageCollection.
Site Gets or sets the ISite of the Component. Inherited from Component.

Methods

Name Description
Add(TImage) Adds a specific image to this collection.
Add(String, TImage) Adds a specific image to this collection.
Add(String, String) Adds an image to this collection by its URI.
Add(String, String, String) Adds an image from the resource assembly to this collection.
Add(String, String, Type) Adds a resource image to this collection.
AddRange(IEnumerable<TImage>) Adds multiple images to this collection.
BeginInit() Starts the collection's initialization.
Clear() Removes all images from this collection.
Contains(TImage) Checks whether this collection contains the target image.
ContainsKey(String) Checks whether this collection has an image with the specific name.
CopyTo(TImage[], Int32) Copies all collection images to the specific array.
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.
Dispose() Releases all resources used by the Component. Inherited from Component.
Dispose(Boolean) protected Releases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
EndInit() Finalizes the collection initialization.
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.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetImage(Int32, ISvgPaletteProvider, Nullable<Size>) Returns a regular raster image of the specific size. This raster image is produced from a source vector image, and colorized according to the provided palette. Throws the ArgumentOutOfRangeException if the collection has no vector image with the given index.
GetImage(Int32, ISvgPaletteProvider, Single, Nullable<Size>) Returns a regular raster image of the specific size, scaled according to the size multiplier. This raster image is produced from a source vector image. Throws the System.ArgumentOutOfRangeException if the collection has no vector image with the given index.
GetImage(Int32, Nullable<Size>) Returns a regular raster image of the specified size. The image is produced from a source vector image. Throws the ArgumentOutOfRangeException if the collection has no vector image with the given index.
GetImage(Int32, Single, Nullable<Size>) Returns a regular raster image of the desired size, scaled according to the size multiplier. The image is produced from a source vector image.Throws the System.ArgumentOutOfRangeException if the collection has no vector image with the given index.
GetImage(String, ISvgPaletteProvider, Nullable<Size>) Returns a regular raster image of the specific size. This raster image is produced from a source vector image, and colorized according to the provided palette. Returns null if the collection has no vector image with the given name.
GetImage(String, ISvgPaletteProvider, Single, Nullable<Size>) Returns a regular raster image of the specific size, scaled according to the size multiplier. This raster image is produced from a source vector image and colorized according to the provided palette. Returns null if the collection has no vector image with the given name.
GetImage(String, Nullable<Size>) Returns a regular raster image of the specified size. The image is produced from a source vector image. Returns null if the collection has no vector image with the given name.
GetImage(String, Single, Nullable<Size>) Returns a regular raster image of the desired size, scaled according to the size multiplier. The image is produced from a source vector image. Returns null if the collection has no vector image with the given name.
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.
IndexOf(TImage) Returns the collection index of the specific image.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Insert(Int32, TImage) Adds the specific image to this collection, , and places this image to the specific position.
Insert(Int32, String, TImage) Adds the specific image to this collection, and places it to the specific position.
Insert(Int32, String, String) Adds an image to this collection by its URI, and places this image to the specific position.
Insert(Int32, String, String, String) Adds an image from the assembly to this collection, and places this image to the specific position.
Insert(Int32, String, String, Type) Adds an image from resources, and places this image to the specific position.
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.
Remove(TImage) Removes the image from this collection.
RemoveAt(Int32) Removes an image with the specific index from this collection.
RemoveAt(String) Removes an image with the specific name from this collection.
SetKeyName(TImage, String) Renames the target SvgImageCollection image.
SetKeyName(Int32, String) Renames the target SvgImageCollection image.
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 when the collection changes.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also