Table of Contents

Class ShowReportOptions

Namespace
GroupeIsa.Neos.Designer.UIAbstractions.Reporting
Assembly
GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the options for showing a report.

[ExcludeFromCodeCoverage]
[SuppressMessage("Minor Code Smell", "S2325:Methods and properties that don't access instance data should be static", Justification = "Abstraction for transpilation")]
public class ShowReportOptions : BaseReportOptions<ShowReportOptions>
Inheritance
ShowReportOptions
Inherited Members

Constructors

ShowReportOptions(ReportId)

Initializes a new instance of the ShowReportOptions class.

public ShowReportOptions(ReportId reportId)

Parameters

reportId ReportId

Report id.

ShowReportOptions(string)

Initializes a new instance of the ShowReportOptions class.

[Obsolete("Using string literals for report name is error-prone. Use new ShowReportOptions(Reports.MyReport) to benefit from compile-time safety.", false)]
public ShowReportOptions(string reportName)

Parameters

reportName string

Report name.

Methods

WithInitialViewerMode(ReportViewerMode)

Sets the initial report viewer mode (SinglePage, Continuous or MultiplePages).

public ShowReportOptions WithInitialViewerMode(ReportViewerMode mode)

Parameters

mode ReportViewerMode

Initial view mode.

Returns

ShowReportOptions

The options.

WithTitle(string)

Sets the frame title.

public ShowReportOptions WithTitle(string title)

Parameters

title string

Frame title.

Returns

ShowReportOptions

The options.

Remarks

This information will be part of the frame identifier and allows discriminating frames showing the same report but with different options.