Harness proD API Help
EPLAN.Harness.API.ApiProperties Namespace / AreaProperty Class
Members Example
In This Topic
    AreaProperty Class
    In This Topic
    Property which stores an area value with a unit.
    Object Model
    AreaProperty ClassPropertyValue Class
    Inheritance Hierarchy

    System.Object
       EPLAN.Harness.API.ApiProperties.Property
          EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty
             EPLAN.Harness.API.ApiProperties.AreaProperty

    Syntax
    public class AreaProperty : EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty
    Remarks

    Represents a property with an area value.

    Class provides a method to convert values between units.

    Example
    The following example shows how to use the class AreaProperty.
    AreaProperty area = new AreaProperty(100, Unit.SquareMeter);
Console.WriteLine(area);

area.Convert(Unit.SquareFoot);
Console.WriteLine(area.ToString());

area = "23 mm2";
Console.WriteLine(area);
Console.WriteLine($"Value: {(double)area.Value}, Unit: {area.Unit}");

area.Convert(Unit.Awg);
Console.WriteLine(area);

// Results:
// 100 m2
// 1076,39 ft2
// 23 mm2
// Value: 23, Unit: SquareMillimeter
// 3-4 AWG
    Public Constructors
     NameDescription
    Public ConstructorAreaProperty ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyIsInterval Specifies whether the property is interval. (Inherited from EPLAN.Harness.API.ApiProperties.Property)
    Public PropertyUnit Unit of the value of this property. (Inherited from EPLAN.Harness.API.ApiProperties.Property)
    Public PropertyValue Gets the value of this property. (Inherited from EPLAN.Harness.API.ApiProperties.Property)
    Top
    Public Methods
     NameDescription
    Public MethodConvertOverridden.  Convert a property to the specified unit.  
    Public MethodEqualsIs this unit class property equal to the following object? (Inherited from EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty)
    Public MethodToStringOverloaded. Overridden. Returns a string that represents the current object.  
    Top
    Public Operators
    public Operator Addition Sums two properties.
    public Operator Implicit Type Conversion Implicit conversion from System.String to AreaProperty.
    public Operator Subtraction Subtracts two properties.
    Top
    See Also

    Reference

    AreaProperty Members
    EPLAN.Harness.API.ApiProperties Namespace
    Unit Enumeration
    ToString Method

    Send Feedback