Class Pen

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

A component of the Trend that defines the tags used for the trend

public class Pen : LogixComponent<Pen>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<Pen>

Pen

Implements

ILogixSerializable

Inherited Members

LogixComponent<Pen>.Use

LogixComponent<Pen>.Name

LogixComponent<Pen>.Description

LogixComponent<Pen>.AddAfter(Pen)

LogixComponent<Pen>.AddBefore(Pen)

LogixComponent<Pen>.Clone()

LogixComponent<Pen>.Remove()

LogixComponent<Pen>.Replace(Pen)

LogixComponent<Pen>.ToString()

LogixElement.Element

LogixElement.IsAttached

LogixElement.Clone<TElement>()

LogixElement.L5X()

LogixElement.Serialize()

LogixElement.GetValue<T>(string)

LogixElement.GetValue<T>(Func<XElement, XElement>, string)

LogixElement.GetValue<T>(XName, string)

LogixElement.GetRequiredValue<T>(string)

LogixElement.GetProperty<T>(string)

LogixElement.GetComplex<T>(string)

LogixElement.GetContainer<TChild>(string)

LogixElement.GetDateTime(string, string)

LogixElement.SetValue<T>(T, string)

LogixElement.SetValue<T>(T, Func<XElement, XElement>, string)

LogixElement.SetValue<T>(T, XName, string)

LogixElement.SetRequiredValue<T>(T, string)

LogixElement.SetProperty<T>(T, string)

LogixElement.SetComplex<T>(T, string)

LogixElement.SetContainer<TChild>(LogixContainer<TChild>, string)

LogixElement.SetDateTime(DateTime?, string, string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

Observe these guidelines when defining a trend:
• A trend can support as many as eight pen declarations.

Constructors

Pen()

Creates a new Pen with default values.

public Pen()

Pen(XElement)

Creates a new Pen initialized with the provided XElement.

public Pen(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

Color

Specify the color of the line in RGB format. Type the hex number for the color (16#0000_0000 – 16#00FF_FFFF).

public string? Color { get; set; }

Property Value

string

EngUnits

Specify engineering units. For example, rpm, gallon, fps, and degrees.

public string? EngUnits { get; set; }

Property Value

string

Marker

Specify the line marker (0...83)

public int? Marker { get; set; }

Property Value

int?

Max

Specify the maximum value for the pen. The maximum cannot be less than or equal to the minimum.

public double? Max { get; set; }

Property Value

double?

Min

Specify the minimum value for the pen. The minimum cannot be greater than or equal to the maximum.

public double? Min { get; set; }

Property Value

double?

Style

Specify the style of line.

public int Style { get; set; }

Property Value

int

Type: For:
0 …………….
1 … … … …
2 . . . . . . . . . . .
3 … . … . … . …
4 … .. … .. … ..

Type

Specify the line type (Analog, Digital, or Full-Width).

public PenType? Type { get; set; }

Property Value

PenType

Visible

Specify whether or not the line should be visible

public bool? Visible { get; set; }

Property Value

bool?

true if the pen is visible; otherwise, false.

Width

Specify the width of the line in pixels (1...10).

public int? Width { get; set; }

Property Value

int?