DataIslandSetup Command

Purpose

Opens a standard dialog box that is used to set up data area parameters.

Parameters of Use

Command parameters are passed in the Data property. Executing the command requires to specify an array of the Variant type in this property, the elements of this array contain the following values:

Value type	Description
Element 1: IPrxDataIsland	The data area, for which the parameter setup dialog box is to be displayed.
Element 2: PrxDataIslandCategory	The parameter defining, which setting groups are to be included into the dialog box for setting up data area parameters. It is possible to determine a combination of the selected enumeration values as a parameter value.

Application Features

The command can be used only for regular reports.

Example

Executing the example requires a form with the Button1 button, the ReportBox component and the UiReport component named UiReport1, which is used as a data source for the ReportBox component. A data source is added to the regular report connected in the UiReport1 component, and a data area is created on the basis of this data source.

    Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
    Var
        Rep: IPrxReport;
        Target: IUiCommandTarget;
        Context: IUiCommandExecutionContext;
        Data: Array;
    Begin
        Rep := UiReport1.Instance As IPrxReport;
        Target := WinApplication.Instance.GetPluginTarget("Report");
        Context := Target.CreateExecutionContext;
        Data := New Variant[2];
        Data[0] := Rep.DataIslands.Item(0);
        Data[1] := PrxDataIslandCategory.Placement + PrxDataIslandCategory.Sort;
        Context.Data := Data;
        Target.Execute("DataIslandSetup", Context);
    End Sub Button1OnClick;

Clicking the button opens a standard dialog box that is used to set up data area parameters. The dialog box will include a section for setting up basic data area parameters and also Sorting and Layout settings groups.