DashboardToolbarItem.SvgImage Property

Gets or sets a vector image displayed within the item.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public SvgImage SvgImage { get; set; }

VB.NET

Public Property SvgImage As SvgImage

Property Value

Type	Description
SvgImage	A DevExpress.Utils.Svg.SvgImage object that is the vector image displayed within the element located in the dashboard title or dashboard item caption.

Remarks

The specified image is located before text.

The default custom image is displayed if the SvgImage or ButtonImage properties are not set and the item’s Caption is an empty string.

An image specified using the ButtonImage property has priority over the SvgImage property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SvgImage property.

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#

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/CS/DashboardNextPrevTab/ViewerForm.cs#L34

nextTabItem.Tag = NextPrevValue.Next;
nextTabItem.SvgImage = imageCollection["Next"];
e.Items.Insert(0, nextTabItem);

winforms-dashboard-customize-title-and-item-captions/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L50

toolbarItemRoot.Caption = @"Show/Hide Dashboard Item Captions";
toolbarItemRoot.SvgImage = svgImageCollection1["title"];
foreach (var item in viewer.Dashboard.Items) {

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DesignerForm.cs#L64

DashboardToolbarItem mergeItem = new DashboardToolbarItem("Open the dashboard(s) to merge", MergeDashboard);
mergeItem.SvgImage = (SvgImage)Properties.Resources.MergeIcon;
mergeItem.Caption = "Merge Dashboard";

win-designer-pivot-as-master-filter/CS/DesignerSample/Form1.cs#L79

showDataItem.Enabled = IsAnyFilterSet();
showDataItem.SvgImage = svgImageCollection1[0];
e.Items.Insert(0, showDataItem);

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/DashboardDescriptionModule.cs#L84

    }));
showDataItem.SvgImage = titleDescriptionImage;
e.Items.Insert(0, showDataItem);

VB.NET

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/VB/DashboardNextPrevTab/ViewerForm.vb#L39

nextTabItem.Tag = NextPrevValue.Next
nextTabItem.SvgImage = imageCollection("Next")
e.Items.Insert(0, nextTabItem)

winforms-dashboard-customize-title-and-item-captions/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L53

toolbarItemRoot.Caption = "Show/Hide Dashboard Item Captions"
toolbarItemRoot.SvgImage = svgImageCollection1("title")
For Each item In viewer.Dashboard.Items

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DesignerForm.vb#L68

Dim mergeItem As New DashboardToolbarItem("Open the dashboard(s) to merge", AddressOf MergeDashboard)
mergeItem.SvgImage = CType(My.Resources.MergeIcon, SvgImage)
mergeItem.Caption = "Merge Dashboard"

win-designer-pivot-as-master-filter/VB/DesignerSample/Form1.vb#L76

showDataItem.Enabled = IsAnyFilterSet()
showDataItem.SvgImage = svgImageCollection1(0)
e.Items.Insert(0, showDataItem)

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/DashboardDescriptionModule.vb#L83

End Sub))
showDataItem.SvgImage = titleDescriptionImage
e.Items.Insert(0, showDataItem)