Class ServerDataExportOptions

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the server data export options.

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

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

OrderBy

Gets the sort.

public string? OrderBy { get; }

Property Value

string

Properties

Gets the properties.

public IEnumerable<string>? Properties { get; }

Property Value

IEnumerable<string>

Methods

WithCulture(string?)

Sets the culture.

public ServerDataExportOptions WithCulture(string? culture)

Parameters

culture string

The culture.

Returns

ServerDataExportOptions

The server data export options instance.

WithEntityViewParameters(Dictionary<string, object?>?)

Sets the entity view parameters.

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

Parameters

entityViewParameters Dictionary<string, object>

The entity view parameteers.

Returns

ServerDataExportOptions

The server data export options.

WithFilter(Filter?)

Sets the filter.

public ServerDataExportOptions WithFilter(Filter? filter)

Parameters

filter Filter

The filter.

Returns

ServerDataExportOptions

The server data export options.

WithFilter(string?)

Sets the $filter ODATA clause.

public ServerDataExportOptions WithFilter(string? filter)

Parameters

filter string

The $filter ODATA clause.

Returns

ServerDataExportOptions

The server data export options.

WithOrderBy(string?)

Sets the $orderby ODATA clause.

public ServerDataExportOptions WithOrderBy(string? orderBy)

Parameters

orderBy string

The $orderby ODATA clause.

Returns

ServerDataExportOptions

The server data export options.

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 server data export options.

WithSorts(Sort[])

Sets the sorts.

public ServerDataExportOptions WithSorts(Sort[] sorts)

Parameters

sorts Sort[]

The sorts.

Returns

ServerDataExportOptions

The server data export options.