PreviewParametersViewModel Class

Provides information about the report parameters’ client-side model.

Declaration

export class PreviewParametersViewModel extends ParameterPanelItemBase<DevExpress.Reporting.Viewer.Parameters.IPreviewParametersViewModel>

Properties

prevParametersStateRequest Property

Declaration

prevParametersStateRequest: JQuery.Deferred<any>

Property Value

Type
Deferred<any>

submit Property

Initiates passing parameter values and generating the report document.

Declaration

submit: () => void

Property Value

Type	Description
() => void	An action that submits parameter values

Remarks

The following example shows a custom submit function implementation to hide the Parameters panel automatically after submitting parameter values.

JS

function WebDocumentViewerInit(s, e) {
    var parametersModel = s.GetParametersModel();
    if (!parametersModel) { return; }
    var doSubmit = parametersModel.submit;
    parametersModel.submit = function () {
        try {
            return doSubmit();
        } finally {
            s.GetPreviewModel().tabPanel.collapsed(true);
        }
    };
}

tabInfo Property

Provides information about the tab for specifying parameter values.

Declaration

tabInfo: DevExpress.Analytics.Utils.TabInfoWithPropertyGrid

Property Value

Type	Description
TabInfoWithPropertyGrid	An object that provides information about the Parameters tab.

Methods

createViewModel Method

Declaration

createViewModel(): DevExpress.Reporting.Viewer.Parameters.IPreviewParametersViewModel

Returns

Type
IPreviewParametersViewModel

onPropertyChanged(args) Method

Declaration

onPropertyChanged(
    args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs<PreviewParametersViewModel> | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs<PreviewParametersViewModel>
): void

Parameters

Name	Type
args	PropertyChangedEventArgs<PreviewParametersViewModel> | ArrayPropertyChangedEventArgs<PreviewParametersViewModel>

serializeParameters Method

Serializes report parameters before passing them to the server.

Declaration

serializeParameters(): Array<DevExpress.Reporting.IKeyValuePair<any>>

Returns

Type	Description
IKeyValuePair<any>[]	An array with keys and values that specify parameter names and values, respectively.

Remarks

The serializeParameters function serializes report parameters before passing them to the server. If you need to change parameter values, register a custom function as demonstrated below.

JS

function WebDocumentViewerInit(s, e) {
    var parametersModel = s.GetParametersModel();
    if (!parametersModel) { return; }
    var serializeParametersOriginal = parametersModel.serializeParameters;
    parametersModel.serializeParameters = function () {
        var serializedParameters = serializeParametersOriginal.apply(parametersModel);
        var reportParameter = serializedParameters.filter(function (p) { return p.Key === "MyParameterName" })[0];
        if (reportParameter) {
            reportParameter.Value = "my custom parameter value";
        }
        return serializedParameters;
    }
}

setParameterValue(parameterName, value) Method

Declaration

setParameterValue(
    parameterName: string,
    value: unknown
): void

Parameters

Name	Type
parameterName	string
value	unknown

updateParameters(changedParameter) Method

Declaration

updateParameters(
    changedParameter: DevExpress.Reporting.Viewer.Parameters.PreviewParameter
): void

Parameters

Name	Type
changedParameter	PreviewParameter

updateViewModel(args) Method

Declaration

updateViewModel(
    args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs<any> | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs<any>
): void

Parameters

Name	Type
args	PropertyChangedEventArgs<any> | ArrayPropertyChangedEventArgs<any>