Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
Public Member Functions | List of all members
IEwDialogProgressX Interface Reference

Use this interface to display a progress dialog. More...

Inheritance diagram for IEwDialogProgressX:
[legend]

Public Member Functions

void show (BOOL bShow)
 Show / hide the dialog. More...
 
void setCancelEnable (BOOL bEnable)
 Enable / disable cancel button. More...
 
void setCancelText (BSTR strMsg)
 Set cancel button text. More...
 
void setStop (BOOL bStop)
 Set stop flag. More...
 
BOOL getStop ()
 Get stop flag. More...
 
void setSnake (BOOL bSnake)
 Set snake mode. More...
 
void setMessage (BSTR strMsg)
 Set message string displayed above the progress indicator. More...
 
void setRange (INT lower, INT upper)
 Set progress range. More...
 
void setStep (INT nStep)
 Set progress step. More...
 
BOOL setPos (INT nPos)
 Set progress position. More...
 
BOOL stepIt ()
 Step the progress. More...
 
void showSecond (BOOL bShow)
 Show / hide second progress bas. More...
 
void setSecondSnake (BOOL bSnake)
 Set snake mode for second progress bar. More...
 
void setSecondMessage (BSTR strMsg)
 Set message string displayed above the progress indicator for second progress bar. More...
 
void setSecondRange (INT lower, INT upper)
 Set progress range for second progress bar. More...
 
void setSecondStep (INT nStep)
 Set progress step for second progress bar. More...
 
BOOL setSecondPos (INT nPos)
 Set progress position for second progress bar. More...
 
BOOL stepItSecond ()
 Step the progress for second progress bar. More...
 

Detailed Description

Use this interface to display a progress dialog.

Since
2018 SP0

Member Function Documentation

◆ getStop()

BOOL IEwDialogProgressX::getStop ( )

Get stop flag.

Use this method to check if Cancel button has been pressed.

Returns
stop flag

◆ setCancelEnable()

void IEwDialogProgressX::setCancelEnable ( BOOL  bEnable)

Enable / disable cancel button.

Parameters
[in]bEnableTRUE to enable, FALSE to disable.

◆ setCancelText()

void IEwDialogProgressX::setCancelText ( BSTR  strMsg)

Set cancel button text.

Parameters
[in]strMsgText to display on cancel button.

◆ setMessage()

void IEwDialogProgressX::setMessage ( BSTR  strMsg)

Set message string displayed above the progress indicator.

Parameters
[in]strMsgThe Message

◆ setPos()

BOOL IEwDialogProgressX::setPos ( INT  nPos)

Set progress position.

Parameters
[in]nStepThe position.
Returns
stop flag

◆ setRange()

void IEwDialogProgressX::setRange ( INT  lower,
INT  upper 
)

Set progress range.

Parameters
[in]lowerLower range bond.
[in]upperUpper range bond.

◆ setSecondMessage()

void IEwDialogProgressX::setSecondMessage ( BSTR  strMsg)

Set message string displayed above the progress indicator for second progress bar.

Parameters
[in]strMsgThe Message

◆ setSecondPos()

BOOL IEwDialogProgressX::setSecondPos ( INT  nPos)

Set progress position for second progress bar.

Parameters
[in]nStepThe position.
Returns
stop flag

◆ setSecondRange()

void IEwDialogProgressX::setSecondRange ( INT  lower,
INT  upper 
)

Set progress range for second progress bar.

Parameters
[in]lowerLower range bond.
[in]upperUpper range bond.

◆ setSecondSnake()

void IEwDialogProgressX::setSecondSnake ( BOOL  bSnake)

Set snake mode for second progress bar.

In snake mode, the progress indicator moves continiously to indicate that the process is alive, without need to call stepIt() or setPos().

Parameters
[in]bSnakeTRUE for snake mode, FALSE for standard range / pos / step mode.

◆ setSecondStep()

void IEwDialogProgressX::setSecondStep ( INT  nStep)

Set progress step for second progress bar.

Parameters
[in]nStepThe step. when calling stepItSecond() the current position will be incremented by this value.

◆ setSnake()

void IEwDialogProgressX::setSnake ( BOOL  bSnake)

Set snake mode.

In snake mode, the progress indicator moves continiously to indicate that the process is alive, without need to call stepIt() or setPos().

Parameters
[in]bSnakeTRUE for snake mode, FALSE for standard range / pos / step mode.

◆ setStep()

void IEwDialogProgressX::setStep ( INT  nStep)

Set progress step.

Parameters
[in]nStepThe step. when calling stepIt() the current position will be incremented by this value.

◆ setStop()

void IEwDialogProgressX::setStop ( BOOL  bStop)

Set stop flag.

Once setStop is called, cancel button is disabled, and getStop(), stepIt(), and setPos() methods will return true.

Parameters
[in]bStopstop flag value.

◆ show()

void IEwDialogProgressX::show ( BOOL  bShow)

Show / hide the dialog.

Parameters
[in]bShowTRUE to show, FALSE to hide.

◆ showSecond()

void IEwDialogProgressX::showSecond ( BOOL  bShow)

Show / hide second progress bas.

◆ stepIt()

BOOL IEwDialogProgressX::stepIt ( )

Step the progress.

Increments the position by the value previously set by setStep()

Returns
stop flag

◆ stepItSecond()

BOOL IEwDialogProgressX::stepItSecond ( )

Step the progress for second progress bar.

Increments the position by the value previously set by setSecondStep()

Returns
stop flag
Generated on Tue Sep 1 2020 17:01:23 for SOLIDWORKS Electrical API by   doxygen 1.8.18


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwDialogProgressX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2020 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.46