API Help
EPLAN API / API Reference / Actions / label
In This Topic
    In This Topic
    Action class to create labels for projects.

    Parameter Description


    Project name with full path (optional).
    If not entered, the selected project is used when the action is called from GUI (like from a script or button bar). 
    If called from the windows command line, PROJECTNAME must be set or the  must be used first, otherwise an  exception is thrown.


    Configuration scheme (optional).
    Default value: Most recently used configuration scheme.


    Filter scheme (optional).
    Default value: Filter scheme name is taken from configuration scheme. If this parameter is not available, nofiltering can be performed.


    Sorting scheme.
    Default value: Sorting scheme name is taken from configuration scheme. If this parameter is not available, no sorting can be performed.


    Language (e.g., en_US or ??_?? for all display languages).


    Target file where the labeling results are saved.
    The following formats are supported: txt, xls, xml. Format must be set according to the extension that is in CONFIGSCHEME.
    This parameter supports PROJPROP_* Eplan variables.
    Default value: file indicated by a configuration scheme (CONFIGSCHEME parameter) 


    Optional: Number of repetitions per label (>=1).                    
    Default value: 0


    Optional: Number of repetitions of total output (>=1).                      
    Default value: 0


    Optional: Decide whether the output file should be shown.
    Default value: 0


    Optional: Decide if use the selection as an input objects for labeling.
    Default value: 0

    If the current selection in the project should be included in the output of the labeling, then you must use the /USESELECTION parameter.
    Microsoft Excel application is necessary to run Labeling with output file extension set to .xls (Excel format)

    label /PROJECTNAME:C:\Projects\EPLAN\ESS_Sample_Project.elk  /CONFIGSCHEME:config_scheme /FILTERSCHEME:filter_scheme  /SORTSCHEME:sort_scheme /LANGUAGE:en_US /DESTINATIONFILE:C:\temp\labeling.txt /RECREPEAT:3 /TASKREPEAT:2
    Use the most recent configuration scheme: The CONFIGSCHEME parameter is not entered. It is empty.
    label /PROJECTNAME:C:\Projects\EPLAN\ESS_Sample_Project.elk /FILTERSCHEME:filter_scheme /SORTSCHEME:sort_scheme /LANGUAGE:en_US /DESTINATIONFILE:C:\temp\labeling.txt /RECREPEAT:3 /TASKREPEAT:2
    Carry out labeling without filtering and sorting: The FILTERSCHEME and SORTSCHEME parameters are not passed in this case.
    label /PROJECTNAME:C:\Projects\EPLAN\ESS_Sample_Project.elk  /CONFIGSCHEME:config_scheme /LANGUAGE:en_US /DESTINATIONFILE:C:\temp\labeling.txt /RECREPEAT:3 /TASKREPEAT:2