SvgImageCollection.GetImage(Int32, Nullable<Size>) Method

Returns a regular raster image of the desired size. The image is produced from a source vector image.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.2.dll

Declaration

C#

public Image GetImage(
    int index,
    Size? size = default(Size? )
)

VB.NET

Public Function GetImage(
    index As Integer,
    size As Size? = Nothing
) As Image

Parameters

Name	Type	Description
index	Int32	An Index of a source vector image within this SvgImageCollection.

Optional Parameters

Name	Type	Default	Description
size	Nullable<Size>	*null*	A Size structure that is the produced image size.

Returns

Type	Description
Image	An Image that is the raster image produced from a vector image.

Remarks

The code below illustrates how to create a 164x164-pixel raster image from a vector image stored in this SvgImageCollection.

C#

simpleButton1.ImageOptions.Image = collection.GetImage(5, new System.Drawing.Size(164, 164));

VB.NET

simpleButton1.ImageOptions.Image = collection.GetImage(5, New System.Drawing.Size(164, 164))

See the SvgImageCollection class description to learn more.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetImage(Int32, Nullable<Size>) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

filteringUiContext-how-to-replace-filtering-template/CS/Templates/TileList.cs#L35

if(e.Value is int) {
    tileElement.Image = Images.GetImage((int)e.Value, ImageSize);
    return;

VB.NET

filteringUiContext-how-to-replace-filtering-template/VB/Templates/TileList.vb#L41

If TypeOf e.Value Is Integer Then
    tileElement.Image = Images.GetImage(CInt(Math.Truncate(e.Value)), ImageSize)
    Return