Eplan Platform API
Eplan.EplApi.HEServices Namespace / Label Class / DoLabel Method / DoLabel(String,String,String,String,String,String,UInt32,UInt32,Boolean) Method
Full link file name of the project, for which a labeling will be done.
Name of the configuration scheme.
Name of the filter scheme.If this value is empty filter scheme name will be taken from configuration scheme
Name of the sorting scheme. If this value is empty sorting scheme name will be taken from configuration scheme
Language used by the labeling operation, ex. de_DE, en_EN, or ??_?? for all display languages.
Destination file where the labeling results will be stored.Extension of this \file must be set according to the configuration in strConfigScheme. If this parameter is empty, the destination file name is taken from the configuration selected by the strConfigScheme parameter.
Repeating number per each record. It must be greater or equal 1
Repeating number per task. It must be greater or equal 1.
Show output file.

In This Topic
    DoLabel(String,String,String,String,String,String,UInt32,UInt32,Boolean) Method
    In This Topic
    do a labeling for a project.
    Syntax

    Parameters

    strFullLinkFileName
    Full link file name of the project, for which a labeling will be done.
    strConfigScheme
    Name of the configuration scheme.
    strFilterScheme
    Name of the filter scheme.If this value is empty filter scheme name will be taken from configuration scheme
    strSortScheme
    Name of the sorting scheme. If this value is empty sorting scheme name will be taken from configuration scheme
    strLanguage
    Language used by the labeling operation, ex. de_DE, en_EN, or ??_?? for all display languages.
    strDestinationFile
    Destination file where the labeling results will be stored.Extension of this \file must be set according to the configuration in strConfigScheme. If this parameter is empty, the destination file name is taken from the configuration selected by the strConfigScheme parameter.
    nRecordRepeat
    Repeating number per each record. It must be greater or equal 1
    nTaskRepeat
    Repeating number per task. It must be greater or equal 1.
    bShowOutput
    Show output file.
    Exceptions
    ExceptionDescription
    \Parameters are invalid.
    Needed internal interface could not be created.
    A parameter is a null reference.
    Error occurred by labeling.
    Remarks

    If a user scheme is not empty, so it will be checked for existence. An ArgumentException will be thrown if it does not exist. If the user configuration scheme is empty or null, so the last used configuration scheme will be implicitly reused which is currently set in GUI. If filter or sort scheme is empty or null, its name will be taken from configuration scheme.

    The destination file should have the extension .txt, .xls, .xlsx or .xml. Otherwise the given extension will be replaced with .txt per default.

    Microsoft Excel application is necessary to run Labeling with output file extension set to .xls (Excel format).

    In contrary to the behavior, when Labeling is executed via the EPLAN ribbon, the API never considers the current selection in the project. In EPLAN GUI the selection causes the filters to be ignored, in API, the filters are never ignored, when set.

    See Also