Class BaseReportOptions<T>

Namespace

GroupeIsa.Neos.Designer.UIAbstractions.Reporting

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the base report options.

public abstract class BaseReportOptions<T>

Type Parameters

T

The type of the report options.

Inheritance

object

BaseReportOptions<T>

Derived

ExecuteReportOptions

ReportViewerOptions

ShowReportOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BaseReportOptions(string)

Initializes a new instance of the BaseReportOptions<T> class.

protected BaseReportOptions(string reportName)

Parameters

reportName string

Report name.

Properties

Culture

Gets or sets the culture.

public string Culture { get; set; }

Property Value

string

EntityViewParameters

Gets or sets the entity view parameters.

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

Property Value

Dictionary<string, object>

Filter

Gets or sets the filter to apply to the data.

public Filter? Filter { get; set; }

Property Value

Filter

LanguageCode

Gets or sets the language code.

[Obsolete("Use the Culture property instead.")]
public string LanguageCode { get; set; }

Property Value

string

Parameters

Gets or sets the parameters.

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

Property Value

Dictionary<string, object>

ReportName

Gets or sets the UI view name.

public string ReportName { get; set; }

Property Value

string

Methods

WithCulture(string)

Adds a culture.

public virtual T WithCulture(string culture)

Parameters

culture string

Culture.

Returns

T

The options.

WithEntityViewParameter(string, object)

Adds an entity view parameter.

public virtual T WithEntityViewParameter(string key, object value)

Parameters

key string

Parameter key.

value object

Parameter value.

Returns

T

The options.

WithEntityViewParameters(Dictionary<string, object>?)

Adds entity view parameters.

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

Parameters

entityViewParameters Dictionary<string, object>

Dictionary representing the key and value of each parameter.

Returns

T

The options.

WithFilter(Filter)

Adds a filter.

public virtual T WithFilter(Filter filter)

Parameters

filter Filter

Filter.

Returns

T

The options.

WithLanguageCode(string)

Adds a language code.

[Obsolete("Use the WithCulture method instead.")]
public virtual T WithLanguageCode(string languageCode)

Parameters

languageCode string

Language code.

Returns

T

The options.

WithParameter(string, object)

Adds a parameter.

public T WithParameter(string key, object value)

Parameters

key string

Parameter key.

value object

Parameter value.

Returns

T

The options.

WithParameters(Dictionary<string, object>?)

Adds parameters.

public virtual T WithParameters(Dictionary<string, object>? parameters)

Parameters

parameters Dictionary<string, object>

Dictionary representing the key and value of each parameter.

Returns

T

The options.