GridExportCustomizeCellEventArgs.Hyperlink Property

Specifies the processed cell’s hyperlink.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public string Hyperlink { get; set; }

Property Value

Type	Description
String	The processed cell’s hyperlink.

Remarks

The CustomizeCell action allows you to customize a cell in the exported file. Use the Hyperlink property to add a hyperlink in the processed cell.

Set the Handled property to true to apply the changes made in the action handler to the cell.

The code sample below demonstrates how to add hyperlinks to the exported grid cell values.

Razor

<DxGrid @ref="Grid" Data="@Data" PagerVisible="false" >
    <Columns>
        <DxGridDataColumn FieldName=@nameof(TestModel.Name) Width="280" >
            <CellDisplayTemplate>
                @context.Value
            </CellDisplayTemplate>
        </DxGridDataColumn>
        <DxGridDataColumn FieldName=@nameof(TestModel.Universal) Width="100" />
        <DxGridDataColumn FieldName=@nameof(TestModel.DXperience) Width="100" />
        <DxGridDataColumn FieldName=@nameof(TestModel.WinForms) Width="100" />
        <DxGridDataColumn FieldName=@nameof(TestModel.WPF) Width="100" />
        <DxGridDataColumn FieldName=@nameof(TestModel.ASP) Caption= "ASP.NET and Blazor" Width="100" />
        <DxGridDataColumn FieldName=@nameof(TestModel.DevExtreme) Caption="DevExtreme Complete" Width="100" />
    </Columns>
    <DataColumnCellDisplayTemplate>
        @if((bool)context.Value == true) {
            <span class="grid-icon grid-icon-check"></span>
        }
    </DataColumnCellDisplayTemplate>
</DxGrid>
<DxButton Text="Export to XLSX" Click="ExportXlsx_Click" />

@code {
    object? Data { get; set; }
    IGrid Grid { get; set; }

    protected override async Task OnInitializedAsync() {
        Data = await _testModelService.GetDataSourceAsync();
    }
    async Task ExportXlsx_Click() {
        var options = new GridXlExportOptions();
        options.CustomizeCell = (e) => {
            if (e.AreaType == DevExpress.Export.SheetAreaType.DataArea && e.ColumnFieldName == "Name") {
                var product = e.DataItem as TestModel;
                e.Hyperlink = product.Url;
                e.Handled = true;
            }
        };
        await Grid.ExportToXlsxAsync("ExportResult", options);
    }
}

TestModel.cs

public class TestModel {
    public string Name { get; set; }
    public bool Universal { get; set; }
    public bool DXperience { get; set; }
    public bool WinForms { get; set; }
    public bool WPF { get; set; }
    public bool ASP { get; set; }
    public bool DevExtreme { get; set; }
    public string Url { get; set; }
}

TestModelService.cs

public class TestModelService {
    private List<TestModel> CreateDataSource() {
        List<TestModel> temp = new List<TestModel>();
        temp.Add(new TestModel() { Name = "WinForms Controls", Universal = true, DXperience = true, WinForms = true, WPF = false, ASP = false, DevExtreme = false, Url = "https://www.devexpress.com/products/net/controls/winforms/" });
        temp.Add(new TestModel() { Name = "WPF Controls", Universal = true, DXperience = true, WinForms = false, WPF = true, ASP = false, DevExtreme = false, Url = "https://www.devexpress.com/products/net/controls/wpf/" });
        temp.Add(new TestModel() { Name = "Blazor UI Components", Universal = true, DXperience = true, WinForms = false, WPF = false, ASP = true, DevExtreme = false, Url = "https://www.devexpress.com/blazor/" });
        temp.Add(new TestModel() { Name = "JavaScript - jQuery, Angular, React, Vue", Universal = true, DXperience = true, WinForms = false, WPF = false, ASP = true, DevExtreme = true, Url = "https://js.devexpress.com/" });
        temp.Add(new TestModel() { Name = "ASP.NET Web Forms Controls and MVC Extensions", Universal = true, DXperience = true, WinForms = false, WPF = false, ASP = true, DevExtreme = false, Url = "https://www.devexpress.com/products/net/controls/asp/" });
        temp.Add(new TestModel() { Name = "Reporting", Universal = true, DXperience = true, WinForms = true, WPF = true, ASP = true, DevExtreme = false, Url = "https://www.devexpress.com/subscriptions/reporting/" });
        temp.Add(new TestModel() { Name = "XPO - ORM Library", Universal = true, DXperience = true, WinForms = true, WPF = true, ASP = true, DevExtreme = true, Url = "https://www.devexpress.com/products/net/orm/" });
        temp.Add(new TestModel() { Name = "XAF - Cross-Platform .NET App UI", Universal = true, DXperience = false, WinForms = false, WPF = false, ASP = false, DevExtreme = false, Url = "https://www.devexpress.com/products/net/application_framework/" });
        return temp;
    }

    private List<TestModel> DataSource { get; set; }
    public TestModelService() {
        DataSource = CreateDataSource();
    }
    public Task<IEnumerable<TestModel>> GetDataSourceAsync(CancellationToken ct = default) {
        return Task.FromResult(DataSource.AsEnumerable());
    }
}