Skip to main content
A newer version of this page is available. .

SvgImageCollection Members

Stores vector images added by you and provides these images to DevExpress controls.

Constructors

Name Description
SvgImageCollection() Initializes a new instance of the SvgImageCollection class with the default settings.
SvgImageCollection(IContainer) Initializes a new instance of the SvgImageCollection class 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 number of vector icons stored in this SvgImageCollection.
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 SvgImageInfo objects for all images owned by this SvgImageCollection.
ImageSize Gets or sets the default image size. If you do not manually set a control’s ImageOptions.SvgImageSize setting, an SvgImageCollection vector icon assigned to this control will have this default size.
Item[Int32] Returns the SvgImageCollection image located at the specific position.
Item[String] Returns the SvgImageCollection image with the specific name.
Keys Returns names for all images kept in this SvgImageCollection.
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(SvgImage) Adds an image to this SvgImageCollection.
Add(String, SvgImage) Adds an image to this SvgImageCollection and changes its name.
Add(String, String, Type) Adds an image from project resources to this SvgImageCollection.
Add(String, String) Adds an image to this SvgImageCollection.
AddRange(IEnumerable<SvgImage>) Adds multiple vector images to this SvgImageCollection.
BeginInit() Starts this SvgImageCollection‘s initialization.
Clear() Removes all images from this SvgImageCollection.
Contains(SvgImage) Returns whether or not this SvgImageCollection contains the specific image.
ContainsKey(String) Determines whether the SvgImageCollection.Keys sequence contains the specified element.
CopyTo(SvgImage[], Int32) Copies all SvgImageCollection image 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() Ends this SvgImageCollection‘s initialization.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FromResources(String, Assembly) static Generates a new SvgImageCollection instance filled with images from a project assembly.
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 System.ArgumentOutOfRangeException if the collection has no vector image with the given index.
GetImage(Int32, Nullable<Size>) Returns a regular raster image of the desired size. 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, Nullable<Size>) Returns a regular raster image of the desired size. 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(SvgImage) Returns the index of the specific image.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Insert(Int32, SvgImage) Adds a vector image to this SvgImageCollection and places it to the specific position.
Insert(Int32, String, SvgImage) Inserts a specific image to this SvgImageCollection and renames it.
Insert(Int32, String, String, Type) Adds a new vector image to this SvgImageCollection and places it to the specific position.
Insert(Int32, String, String) Adds a vector image from a DevExpress Image Gallery to this SvgImageCollection, places this image to the specific position and renames it.
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(SvgImage) Removes the specific image from this SvgImageCollection.
RemoveAt(Int32) Removes an image with the specific index from this SvgImageCollection.
RemoveAt(String) Removes an image with the specific name from this SvgImageCollection.
SetKeyName(SvgImage, 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