Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

IReportWizardState Interface

If implemented, provides functionality for the Report Wizard‘s global state.

#Declaration

TypeScript
export interface IReportWizardState extends IDataSourceWizardState

#Remarks

The Report Wizard’s global state implements the IReportWizardState interface and stores all the settings required to create a data source.

When the wizard runs, the initialize method initializes the global state with the predefined settings. The wizard’s onFinish method generates a data source based on the resulting global state.

Each wizard page uses a specific subset of the global state (a page’s local state). The page updates its local state based on a user’s input, and then, commits this state to the global state.

See the following topics for more information:

#Inheritance

IDataSourceWizardState
IReportWizardState

#Properties

#colorScheme Property

Specifies the color scheme’s state.

#Declaration

TypeScript
colorScheme: DevExpress.Reporting.Designer.Wizard.IColorSchemeState

#Property Value

Type Description
IColorSchemeState

The color scheme’s state.

#crossTabColumnsFieldInfo Property

#Declaration

TypeScript
crossTabColumnsFieldInfo?: DevExpress.Reporting.Designer.Internal.ICrossTabGroupFieldInfo[]

#Property Value

Type
ICrossTabGroupFieldInfo[]

#crossTabDataFieldInfo Property

#Declaration

TypeScript
crossTabDataFieldInfo?: DevExpress.Reporting.Designer.Internal.ICrossTabDataFieldInfo[]

#Property Value

Type
ICrossTabDataFieldInfo[]

#crossTabFields Property

#Declaration

TypeScript
crossTabFields?: DevExpress.Analytics.Wizard.Internal.FieldTreeNode[]

#Property Value

Type
FieldTreeNode[]

#crossTabRowsFieldInfo Property

#Declaration

TypeScript
crossTabRowsFieldInfo?: DevExpress.Reporting.Designer.Internal.ICrossTabGroupFieldInfo[]

#Property Value

Type
ICrossTabGroupFieldInfo[]

#customData Property

#Declaration

TypeScript
customData?: string

#Property Value

Type
string

#dataMember Property

Specifies the data member.

#Declaration

TypeScript
dataMember?: string

#Property Value

Type Description
string

The data member.

#dataMemberInfo Property

#Declaration

TypeScript
dataMemberInfo?: DevExpress.Analytics.Utils.IDataMemberInfo

#Property Value

Type
IDataMemberInfo

#dataMemberPath Property

#Declaration

TypeScript
dataMemberPath?: string

#Property Value

Type
string

#dataSource Property

Specifies an existing data source.

#Declaration

TypeScript
dataSource?: string

#Property Value

Type Description
string

The data source.

#ignoreNullValuesForSummary Property

Specifies whether to ignore NULL values when calculate summary functions.

#Declaration

TypeScript
ignoreNullValuesForSummary?: boolean

#Property Value

Type Description
boolean

true, to ignore NULL values; otherwise, false.

#labelDetails Property

Specifies the label’s settings.

#Declaration

TypeScript
labelDetails?: DevExpress.Reporting.Designer.Wizard.ILabelDetails

#Property Value

Type Description
ILabelDetails

The label’s settings.

#masterDetailGroups Property

Specifies the collection of group settings.

#Declaration

TypeScript
masterDetailGroups?: any[]

#Property Value

Type Description
any[]

The collection of group settings.

#masterDetailInfoCollection Property

Specifies the collection of master-detail relationships.

#Declaration

TypeScript
masterDetailInfoCollection?: DevExpress.Reporting.Designer.Internal.IMasterDetailQueryInfo[]

#Property Value

Type Description
IMasterDetailQueryInfo[]

The collection of master-detail relationships.

#masterDetailSummariesInfo Property

Specifies the collection of summary settings.

#Declaration

TypeScript
masterDetailSummariesInfo?: {
    [key: string]: {
        column: DevExpress.Analytics.Utils.IDataMemberInfo;
        summaryFunctions: number[];
    }[];
}

#Property Value

Type Description
[key: string]: {column: IDataMemberInfo, summaryFunctions: number[]}[]

The collection of summary settings.

#masterDetailSummaryOptionsColumns Property

Specifies the collection of columns to calculate summaries.

#Declaration

TypeScript
masterDetailSummaryOptionsColumns?: any

#Property Value

Type Description
any

The collection of columns to calculate summaries.

#newDataSource Property

Specifies a newly created data source.

#Declaration

TypeScript
newDataSource?: string

#Property Value

Type Description
string

The newly created data source.

#pageSetup Property

Specifies the page settings.

#Declaration

TypeScript
pageSetup: DevExpress.Reporting.Designer.Wizard.IPageSetup

#Property Value

Type Description
IPageSetup

The page settings.

#reportTemplateID Property

#Declaration

TypeScript
reportTemplateID?: string

#Property Value

Type
string

#reportTitle Property

Specifies the report title.

#Declaration

TypeScript
reportTitle?: string

#Property Value

Type Description
string

The report title.

#reportType Property

Specifies the report type.

#Declaration

TypeScript
reportType?: ReportType

#Property Value

Type Description
ReportType

The report type.