acplCreatePlotProgressDialog

C++

ACPL_PORT AcPlPlotProgressDialog* acplCreatePlotProgressDialog(
    HWND hParent, 
    bool bPreview = false, 
    int nSheets = 1, 
    ACPLPLTPRGHELPPROC hlpProc = nullptr, 
    bool bShowCancelSheetButton = true
);

File

AcPlPlotProgress.h

Description

This factory method creates an instance of the default implementation of the AcPlPlotProgressDialog class. acplCreatePlotProgressDialog() creates a single or multi-sheet plot progress dialog, which can be customized using the methods on the returned AcPlPlotProgressDialog pointer. Callers must destroy the dialog created by this call by calling AcPlPlotProgressDialog::destroy() on the object when it is no longer needed.

The hlpProc function pointer is invoked upon a help request from the user (in other words, if the user presses the help button in the UI). The callback method should conform to the following type definition:

typedef void (*ACPLPLTPRGHELPPROC)(
    AcPlPlotProgressDialog * pAcPlPlotProgressDialog);

When plotting a multi-page document, applications may want to set bShowCancelSheetButton to false to hide the Cancel Sheet button and prevent the user from canceling a single sheet. This parameter does not affect the Cancel Plot button, which is always displayed and can be used to cancel the entire job.

acplCreatePlotProgressDialog() returns a valid pointer to an AcPlPlotProgressDialog object if successful.

Parameters

Previous Declaration

ACPL_PORT AcPlPlotProgressDialog* ADESK_STDCALL acplCreatePlotProgressDialog(HWND hParent, bool bPreview = false, int nSheets = 1, ACPLPLTPRGHELPPROC hlpProc = NULL, bool bShowCancelSheetButton = true);