Class BaseReportOptions<T>

Namespace

GroupeIsa.Neos.Designer.UIAbstractions.Reporting

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the base report options.

[ExcludeFromCodeCoverage]
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(ReportId)

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

protected BaseReportOptions(ReportId reportId)

Parameters

reportId ReportId

Report id.

BaseReportOptions(string)

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

protected BaseReportOptions(string reportName)

Parameters

reportName string

Report name.

Methods

WithCulture(string)

Adds a culture.

public virtual T WithCulture(string culture)

Parameters

culture string

Culture.

Returns

T

The options.

WithEntityViewParameter(string, object)

Adds one 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 multiple 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 one 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 multiple 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.

WithStylesCollection(ReportStyleId)

Sets the id of the bundle containing the collection of styles.

public virtual T WithStylesCollection(ReportStyleId reportStyleId)

Parameters

reportStyleId ReportStyleId

Id of the bundle containing the collection of styles.

Returns

T

The options.

Remarks

At the moment, there is only one parameter because we will always apply the 'AutomaticNeosStyles'.

WithStylesCollection(string?)

Sets the name of the bundle containing the collection of styles.

[Obsolete("Use the method with a ReportStyleId parameter instead.")]
public virtual T WithStylesCollection(string? stylesBundle)

Parameters

stylesBundle string

Name of the bundle containing the collection of styles.

Returns

T

The options.

Remarks

At the moment, there is only one parameter because we will always apply the 'AutomaticNeosStyles'.

WithTimeZone(string?)

Sets the name of the time zone to apply on the DateTime properties.

public virtual T WithTimeZone(string? timeZone)

Parameters

timeZone string

Name of the time zone.

Returns

T

The options.