SheetProperties Command

Purpose

Opens a standard dialog box that is used to set up sheet properties.

Parameters of Use

Command parameters are passed in the Data property. Executing the command requires to specify the following value in this property:

Value type	Description
IPrxSheet	The regular report sheet, for which it is required to show the dialog box that is used to set up sheet properties.

Application Features

The command can be used only for regular reports. Executing the command shows logical True if the OK button is clicked in the dialog box, and False if the Cancel button is clicked.

Fore Example

Executing the example requires a form, the Button1 button on the form, the ReportBox component and the UiReport component named UiReport1, which is used as a data source for the ReportBox component.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    Report: IPrxReport;
    Target: IUiCommandTarget;
    Context: IUiCommandExecutionContext;
Begin
    Report := UiReport1.Instance As IPrxReport;
    Target := WinApplication.Instance.GetPluginTarget("Report");
    Context := Target.CreateExecutionContext;
    Context.Data := Report.ActiveSheet;
    Target.Execute("SheetProperties", Context);
End Sub Button1OnClick;

Clicking the button opens a dialog box that is used to set up properties of regular report active sheet.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example. Use Fore.NET analogs instead of Fore components.

Imports Prognoz.Platform.Interop.Report;
Imports Prognoz.Platform.Interop.Ui;

Private Sub button1_Click(sender: System.Object; e: System.EventArgs);
Var
    Report: IPrxReport;
    WinApp: WinApplication = New WinApplicationClass_2();
    Target: IUiCommandTarget;
    Context: IUiCommandExecutionContext;
Begin
    Report := UiReportNet1.ReportUi.Report;
    Target := WinApp.GetPluginTarget("Report");
    Context := Target.CreateExecutionContext();
    Context.Data := Report.ActiveSheet;
    Target.Execute("SheetProperties", Context, Null);
End Sub;