Class ListingConfigurationExportExtensions

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Extension methods enabling the export of a listing.

public static class ListingConfigurationExportExtensions

Inheritance

object

ListingConfigurationExportExtensions

Remarks

The export is available for the ListingPage<TClientProperties> and DataContainerListingPage pages, which retrieve their data via a single primitive serving both the table and the export. Other ListingPageBase<TPageConfiguration, TClientProperties> descendants ignore the export configuration.

Methods

EnableExport(ListingConfiguration)

Enables the export action of the listing with the default configuration: the exported file is named after the listing page, up to 50,000 rows are exported, and the export requires the same permission as viewing the listing.

public static ListingConfiguration EnableExport(this ListingConfiguration configuration)

Parameters

configuration ListingConfiguration

Listing configuration.

Returns

ListingConfiguration

The configuration for chaining.

EnableExport(ListingConfiguration, ListingExportConfiguration)

Enables the export action of the listing with the given exportConfiguration.

public static ListingConfiguration EnableExport(this ListingConfiguration configuration, ListingExportConfiguration exportConfiguration)

Parameters

configuration ListingConfiguration

Listing configuration.

exportConfiguration ListingExportConfiguration

Configuration of the export action.

Returns

ListingConfiguration

The configuration for chaining.

Exceptions

ArgumentNullException

Thrown when configuration or exportConfiguration is null.