SvgImageBox.ExportSvgImage(String, SvgImageBoxOptionsExport) Method

Saves the current image to the specified file in SVG format.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

public void ExportSvgImage(
    string path,
    SvgImageBoxOptionsExport exportOptions = null
)

VB.NET

Public Sub ExportSvgImage(
    path As String,
    exportOptions As SvgImageBoxOptionsExport = Nothing
)

Parameters

Name	Type	Description
path	String	The path to the file to which the image is exported.

Optional Parameters

Name	Type	Default	Description
exportOptions	SvgImageBoxOptionsExport	null	An optional object that contains export options.

Remarks

The ExportSvgImage method does not save the items’ tags (SvgImageItem.Tag) to the output.

To save item apperance settings (SvgImageBox.ItemAppearance and SvgImageItem.Appearance), use the StoreAppearance property. This property is a combination of bit flags that specify whether to save the appearance settings applied to items in the normal, selected, hovered, and disabled states.

The ExportSvgImage method called without the optional exportOptions parameter takes into account the control’s SvgImageBox.OptionsExport.StoreAppearance setting.

C#

svgImageBox1.OptionsExport.StoreAppearance = DevExpress.XtraEditors.AppearanceTypes.All;
svgImageBox1.ExportSvgImage("svgimagebox.svg");

VB.NET

SvgImageBox1.OptionsExport.StoreAppearance = DevExpress.XtraEditors.AppearanceTypes.All
SvgImageBox1.ExportSvgImage("svgimagebox.svg")

You can also set the StoreAppearance setting using the ExportSvgImage method’s exportOptions parameter. In this case, the method ignores the control’s SvgImageBox.OptionsExport.StoreAppearance property.

C#

SvgImageBoxOptionsExport expOptions = new SvgImageBoxOptionsExport();
expOptions.StoreAppearance = AppearanceTypes.Normal | AppearanceTypes.Disabled;
svgImageBox1.ExportSvgImage("svgimagebox.svg", expOptions);

VB.NET

Dim expOptions As SvgImageBoxOptionsExport = New SvgImageBoxOptionsExport()
expOptions.StoreAppearance = AppearanceTypes.Normal Or AppearanceTypes.Disabled
SvgImageBox1.ExportSvgImage("svgimagebox.svg", expOptions)