Eplan Platform API
Eplan.EplApi.Base Namespace / Progress Class
Methods

In This Topic
    Progress Class Members
    In This Topic

    The following tables list the members exposed by Progress.

    Public Constructors
     NameDescription
    Public ConstructorProgress ConstructorOverloaded.   
    Top
    Public Methods
     NameDescription
    Public MethodBeginPartStarts a new segment. All parallel segments should result in a sum of 100%.  
    Public MethodCanceledQueries whether the operation was canceled.  
    Public MethodDisposeDestructor for deterministic finalization of Progress object.  
    Public MethodEndPartOverloaded. Ends segment and closes the window when it is not used. Don't forget to call it at the end, otherwise a progress dialog may lock P8.  
    Public MethodGetProgressFor internal use only.  
    Public MethodSetActionTextSets a new action text.  
    Public MethodSetAllowCancelAllows canceling.  
    Public MethodSetAskOnCancelAsks to confirm the cancel request.  
    Public MethodSetNeededPartsSpecifies how many segments are required.  
    Public MethodSetNeededStepsIndicates how many steps are required to reach 100%. E.g. used for loops.  
    Public MethodSetOverallActionTextSets a new action text.  
    Public MethodSetTitleSets the title of the progress bar.  
    Public MethodShowImmediatelyShows the progress bar without any further delay. When ShowImmediately isnt't called the dialog appears later (with delay), it prevents the dialog to show unnecessarily (to prevent that the progress flickers up for a short running actions).  
    Public MethodShowLevelSpecifies the nesting level up to which a display is made.  
    Public MethodStepUses a step  
    Top
    See Also

    Reference

    Progress Class
    Eplan.EplApi.Base Namespace

     

     

    EPLAN API , 19.11.2021, © by EPLAN GmbH & Co. KG. All rights reserved.

    Send Feedback