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

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.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v19.1.dll

Declaration

C#

public Image GetImage(
    string name,
    Size? size = default(Size? )
)

VB.NET

Public Function GetImage(
    name As String,
    size As Size? = Nothing
) As Image

Parameters

Name	Type	Description
name	String	A String value that is the vector image name within the SvgImageCollection.

Optional Parameters

Name	Type	Default	Description
size	Nullable<Size>	*null*	A Size structure that is the produced image’s 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("SaveAll", new System.Drawing.Size(164, 164));

VB.NET

simpleButton1.ImageOptions.Image = collection.GetImage("SaveAll", 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(String, 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#L31

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

VB.NET

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

If TypeOf e.Value Is System.Enum Then
    tileElement.Image = Images.GetImage(e.Value.ToString().ToLowerInvariant(), ImageSize)
    Return