Harness proD API Help
EPLAN.Harness.API.ApiProperties Namespace / TerminalDesignation Class
Members Example
In This Topic
    TerminalDesignation Class
    In This Topic
    Terminal level designations of this terminal.
    Inheritance Hierarchy

    System.Object
       EPLAN.Harness.API.ApiProperties.TerminalDesignation

    Syntax
    public class TerminalDesignation
    Remarks

    Contains a dictionary of two strings.

    • First System.String is the order of the terminal level. For example: "Level 1". It is read only.
    • Second System.String is designation of this level and you can change it.

    Example
    This example shows how to use TerminalDesignation class.
    // Obtain the terminal occurrence
IOccTerminal occTerminal = ...

// Obtain the Terminal designation from the terminal occurrence.
TerminalDesignation terminalDesignation = occTerminal.TerminalDesignation;

Console.WriteLine(terminalDesignation);

// Change the designation of terminal's level 1.
terminalDesignation.ChangeLevelDesignation("1", "A");

// Change the designation of terminal's level 2.
terminalDesignation.ChangeLevelDesignation("2", "B");

// Change the designation of terminal's level 3.
terminalDesignation.ChangeLevelDesignation("Level 3", "C");

Console.WriteLine(terminalDesignation);

// RESULTS:
// [(Level 1: 1)(Level 2: 2)(Level 3: 3)]
// [(Level 1: A)(Level 2: B)(Level 3: C)]
    Public Properties
     NameDescription
    Public PropertyTerminalLevelDesignationsGets the Dictionary of two System.Strings that contain the order of the level and its designation.  
    Top
    Public Methods
     NameDescription
    Public MethodChangeLevelDesignation Set the designation of the level.  
    Public MethodToStringReturns a string that represents the current object.  
    Top
    See Also

    Reference

    TerminalDesignation Members
    EPLAN.Harness.API.ApiProperties Namespace
    ChangeLevelDesignation Method
    ToString Method
    Dictionary

    Send Feedback