Back to Devexpress

DxExportSettings Class

blazor-devexpress-dot-blazor-a6822208.md

latest3.6 KB
Original Source

DxExportSettings Class

Contains the target component’s export and print settings.

Namespace : DevExpress.Blazor

Assembly : DevExpress.Blazor.v25.2.dll

NuGet Package : DevExpress.Blazor

Declaration

csharp
public class DxExportSettings :
    DxSettingsComponent<ExportSettingsModel>

Remarks

Use DxExportSettings object to configure export and print settings of the following components:

DxBarGaugeA component that visualizes data as circular bars where each bar indicates a single value.DxSankeyA component that depicts value flow between two entity sets.

Add a DxExportSettings object to target component markup and set the DxExportSettings.Enabled property to true to enable client-side export and printing functionality – the component displays the Export hamburger menu with export and print commands.

You can use the following properties of the DxExportSettings component to define the list of commands in the Export hamburger menu :

PrintingEnabledSet this property to true to display the Print command.FormatsAssign DataExportFormat values to this property to display corresponding commands.

You can also configure the following settings of the exported file:

FileNameSpecifies the file name.BackgroundColor | MarginSpecifies file appearance and layout.

Example

The following code snippet customizes the Export hamburger menu in the DxBarGauge component and specifies the name of the exported file:

razor
<DxBarGauge Width="100%"
            Height="500px"
            StartValue="-5"
            EndValue="5"
            BaseValue="0"
            Values="@Values">
    <DxExportSettings Enabled="true" FileName="My file" Formats="@exportFormats"/>
    @* ... *@
</DxBarGauge>

@code {
    DataExportFormat[] exportFormats = new DataExportFormat[] {
        DataExportFormat.Png,
        DataExportFormat.Pdf};

    double[] Values = new double[] { -2.13, 1.48, -3.09, 4.52, 4.9, 3.9 };
    // ...
}

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inheritance

Object ComponentBase DxSettingsComponent<DevExpress.Blazor.ClientComponents.Internal.ExportSettingsModel> DxExportSettings

See Also

DxExportSettings Members

DevExpress.Blazor Namespace