Back to Devexpress

SvgImageCollection Members

windowsforms-devexpress-dot-utils-dot-svgimagecollection-dot-underscore-members.md

latest22.1 KB
Original Source

SvgImageCollection Members

A collection of vector (SVG) images used in WinForms applications.

Constructors

NameDescription
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

NameDescription
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CountReturns the current number of images in this collection. Inherited from ImageCollection<TImage, TInfo>.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ImageColorizationModeGets or sets colorization mode for SVG images in the current collection. Inherited from ImageCollection<TImage, TInfo>.
ImageInfosReturns the SvgImageInfo objects for all images owned by this SvgImageCollection.
ImageSizeGets 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. Inherited from ImageCollection<TImage, TInfo>.
Item[Int32]Returns a collection image by its index. Inherited from ImageCollection<TImage, TInfo>.
Item[String]Returns a collection image by its name. Inherited from ImageCollection<TImage, TInfo>.
KeysReturns names for all images kept in this collection. Inherited from ImageCollection<TImage, TInfo>.
ScaledImageSizeReturns the actual (DPI-aware) size of images stored in this SvgImageCollection. Inherited from ImageCollection<TImage, TInfo>.
SiteGets or sets the ISite of the Component. Inherited from Component.

Methods

NameDescription
Add(TImage)Adds a specific image to this collection. Inherited from ImageCollection<TImage, TInfo>.
Add(String, TImage)Adds a specific image to this collection. Inherited from ImageCollection<TImage, TInfo>.
Add(String, String, String)Adds an image from the resource assembly to this collection. Inherited from ImageCollection<TImage, TInfo>.
Add(String, String, Type)Adds a resource image to this collection. Inherited from ImageCollection<TImage, TInfo>.
Add(String, String)Adds an image to this collection by its URI. Inherited from ImageCollection<TImage, TInfo>.
AddRange(IEnumerable<TImage>)Adds multiple images to this collection. Inherited from ImageCollection<TImage, TInfo>.
BeginInit()Starts the collection’s initialization. Inherited from ImageCollection<TImage, TInfo>.
Clear()Removes all images from this collection. Inherited from ImageCollection<TImage, TInfo>.
Clear(Boolean)Clears this collection and optionally disposes of its images.
Contains(TImage)Checks whether this collection contains the target image. Inherited from ImageCollection<TImage, TInfo>.
ContainsKey(String)Checks whether this collection has an image with the specific name. Inherited from ImageCollection<TImage, TInfo>.
CopyTo(TImage[], Int32)Copies all collection images to the specific array. Inherited from ImageCollection<TImage, TInfo>.
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) protectedReleases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
EndInit()Finalizes the collection initialization. Inherited from ImageCollection<TImage, TInfo>.
Equals(Object, Object) staticDetermines 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(Assembly) staticGenerates a new SvgImageCollection instance filled with images from a project assembly.
FromResources(String, Assembly) staticGenerates 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>, Nullable<SvgImageColorizationMode>)Returns a regular raster image of a 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. Inherited from ImageCollection<TImage, TInfo>.
GetImage(Int32, ISvgPaletteProvider, Single, Nullable<Size>, Nullable<SvgImageColorizationMode>)Returns a regular raster image of a specific size, scaled according to the size multiplier. This raster image is produced from a source vector image. Throws the ArgumentOutOfRangeException if the collection has no vector image with the given index. Inherited from ImageCollection<TImage, TInfo>.
GetImage(Int32, Nullable<Size>, Nullable<SvgImageColorizationMode>)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. Inherited from ImageCollection<TImage, TInfo>.
GetImage(Int32, Single, Nullable<Size>, Nullable<SvgImageColorizationMode>)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 ArgumentOutOfRangeException if the collection has no vector image with the given index. Inherited from ImageCollection<TImage, TInfo>.
GetImage(String, ISvgPaletteProvider, Nullable<Size>, Nullable<SvgImageColorizationMode>)Returns a regular raster image of a 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. Inherited from ImageCollection<TImage, TInfo>.
GetImage(String, ISvgPaletteProvider, Single, Nullable<Size>, Nullable<SvgImageColorizationMode>)Returns a regular raster image of a 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. Inherited from ImageCollection<TImage, TInfo>.
GetImage(String, Nullable<Size>, Nullable<SvgImageColorizationMode>)Returns a regular raster image of a specified size. The image is produced from a source vector image. Returns null if the collection has no vector image with the given name. Inherited from ImageCollection<TImage, TInfo>.
GetImage(String, Single, Nullable<Size>, Nullable<SvgImageColorizationMode>)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. Inherited from ImageCollection<TImage, TInfo>.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protectedReturns 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. Inherited from ImageCollection<TImage, TInfo>.
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. Inherited from ImageCollection<TImage, TInfo>.
Insert(Int32, String, TImage)Adds the specific image to this collection, and places it to the specific position. Inherited from ImageCollection<TImage, TInfo>.
Insert(Int32, String, String, String)Adds an image from the assembly to this collection, and places this image to the specific position. Inherited from ImageCollection<TImage, TInfo>.
Insert(Int32, String, String, Type)Adds an image from resources, and places this image to the specific position. Inherited from ImageCollection<TImage, TInfo>.
Insert(Int32, String, String)Adds an image to this collection by its URI, and places this image to the specific position. Inherited from ImageCollection<TImage, TInfo>.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Remove(TImage)Removes the image from this collection. Inherited from ImageCollection<TImage, TInfo>.
RemoveAt(Int32)Removes an image with the specific index from this collection. Inherited from ImageCollection<TImage, TInfo>.
RemoveAt(String)Removes an image with the specific name from this collection. Inherited from ImageCollection<TImage, TInfo>.
SetKeyName(TImage, String)Renames the target SvgImageCollection image. Inherited from ImageCollection<TImage, TInfo>.
SetKeyName(Int32, String)Renames the target SvgImageCollection image. Inherited from ImageCollection<TImage, TInfo>.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
ChangedFires when the collection changes. Inherited from ImageCollection<TImage, TInfo>.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

SvgImageCollection Class

DevExpress.Utils Namespace