Class ServerDataExportOptions

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the server data export options.

[ExcludeFromCodeCoverage]
[SuppressMessage("Minor Code Smell", "S2325:Methods and properties that don't access instance data should be static", Justification = "Transpilation")]
public class ServerDataExportOptions

Inheritance

object

ServerDataExportOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ServerDataExportOptions(string, string, ExportFormat)

Initializes a new instance of the ServerDataExportOptions class.

public ServerDataExportOptions(string entityViewName, string fileName, ExportFormat format)

Parameters

entityViewName string

The entity view name.

fileName string

The file name.

format ExportFormat

The format.

Properties

CsvOptions

Gets the CSV-specific options.

public CsvOptions? CsvOptions { get; }

Property Value

CsvOptions

Culture

Gets the culture.

public string? Culture { get; }

Property Value

string

EntityViewName

Gets the entity view name.

public string EntityViewName { get; }

Property Value

string

EntityViewParameters

Gets the entity view parameters.

public Dictionary<string, object?>? EntityViewParameters { get; }

Property Value

Dictionary<string, object>

FileName

Gets the file name.

public string FileName { get; }

Property Value

string

Filter

Gets the filter.

public string? Filter { get; }

Property Value

string

Format

Gets the format.

public ExportFormat Format { get; }

Property Value

ExportFormat

Header

Gets a value indicating whether to generate the header row.

public bool Header { get; }

Property Value

bool

OrderBy

Gets the sort.

public string? OrderBy { get; }

Property Value

string

Properties

Gets the properties.

public IEnumerable<string>? Properties { get; }

Property Value

IEnumerable<string>

TimeZone

Gets the (optional) destination time-zone as a valid Windows or IANA time zone identifier and used for localizing DateTime properties.

public string? TimeZone { get; }

Property Value

string

UIViewName

Gets the UI view name.

public string? UIViewName { get; }

Property Value

string

Methods

WithCsvOptions(CsvOptions?)

Sets the CSV-specific options.

public ServerDataExportOptions WithCsvOptions(CsvOptions? csvOptions)

Parameters

csvOptions CsvOptions

The CSV-specific options.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithCulture(string?)

Sets the culture.

public ServerDataExportOptions WithCulture(string? culture)

Parameters

culture string

The culture.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithEntityViewParameters(Dictionary<string, object?>?)

Sets the entity view parameters.

public ServerDataExportOptions WithEntityViewParameters(Dictionary<string, object?>? entityViewParameters)

Parameters

entityViewParameters Dictionary<string, object>

The entity view parameters.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithFilter(Filter?)

Sets the filter.

public ServerDataExportOptions WithFilter(Filter? filter)

Parameters

filter Filter

The filter.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithFilter(string?)

Sets the $filter ODATA clause.

public ServerDataExportOptions WithFilter(string? filter)

Parameters

filter string

The $filter ODATA clause.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithHeader(bool)

Sets the value indicating whether to generate the header row.

public ServerDataExportOptions WithHeader(bool header)

Parameters

header bool

The value indicating whether to generate the header row.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithOrderBy(string?)

Sets the $orderby ODATA clause.

public ServerDataExportOptions WithOrderBy(string? orderBy)

Parameters

orderBy string

The $orderby ODATA clause.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithProperties(IEnumerable<string>)

Sets the properties to export.

public ServerDataExportOptions WithProperties(IEnumerable<string> properties)

Parameters

properties IEnumerable<string>

The properties to export.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithSorts(Sort[])

Sets the sorts.

public ServerDataExportOptions WithSorts(Sort[] sorts)

Parameters

sorts Sort[]

The sorts.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithTimeZone(string?)

Sets the time-zone.

public ServerDataExportOptions WithTimeZone(string? timeZone)

Parameters

timeZone string

The time-zone.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).

WithUIViewName(string?)

Sets the UI view name.

public ServerDataExportOptions WithUIViewName(string? uiViewName)

Parameters

uiViewName string

The UI view name.

Returns

ServerDataExportOptions

The updated server data export options instance (not a new one).