Class AddOnInstruction

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

A logix AddOnInstruction component. Contains the properties that comprise the L5X AddOnInstructionDefinition element.

public class AddOnInstruction : LogixComponent<AddOnInstruction>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<AddOnInstruction>

AddOnInstruction

Implements

ILogixSerializable

Inherited Members

LogixComponent<AddOnInstruction>.Use

LogixComponent<AddOnInstruction>.Name

LogixComponent<AddOnInstruction>.Description

LogixComponent<AddOnInstruction>.AddAfter(AddOnInstruction)

LogixComponent<AddOnInstruction>.AddBefore(AddOnInstruction)

LogixComponent<AddOnInstruction>.Clone()

LogixComponent<AddOnInstruction>.Remove()

LogixComponent<AddOnInstruction>.Replace(AddOnInstruction)

LogixComponent<AddOnInstruction>.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)

Constructors

AddOnInstruction()

Creates a new AddOnInstruction with default values.

public AddOnInstruction()

AddOnInstruction(XElement)

Creates a new AddOnInstruction initialized with the provided XElement.

public AddOnInstruction(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

AdditionalHelpText

The help text specific to the Add-On Instruction.

public string? AdditionalHelpText { get; set; }

Property Value

string

A string containing the help text.

CreatedBy

The name of the user that created the instruction.

public string? CreatedBy { get; set; }

Property Value

string

A string representing the name of the user.

CreatedDate

The date and time that the instruction was created.

public DateTime? CreatedDate { get; set; }

Property Value

DateTime?

A DateTime representing the creation date and time.

EditedBy

The name of the user that last edited the instruction.

public string? EditedBy { get; set; }

Property Value

string

A string representing the name of the user.

EditedDate

The date and time that the instruction was last edited.

public DateTime? EditedDate { get; set; }

Property Value

DateTime?

A DateTime representing the edit date and time.

ExecuteEnableInFalse

Indicates that the instruction has and executes a enable in false routine.

public bool ExecuteEnableInFalse { get; set; }

Property Value

bool

A bool - true if the instruction executes a enable in false routine; otherwise, false.

ExecutePostScan

Indicates that the instruction has and executes a post scan routine.

public bool ExecutePostScan { get; set; }

Property Value

bool

true if the instruction executes a post scan routine; otherwise, false.

ExecutePreScan

Indicates that the instruction has and executes a pre scan routine.

public bool ExecutePreScan { get; set; }

Property Value

bool

true if the instruction executes a pre scan routine; otherwise, false.

IsEncrypted

Indicates whether the Add-On Instruction is protected with license-based Source Protection and locked

public bool IsEncrypted { get; set; }

Property Value

bool

true if the instruction is encrypted; otherwise, false.

LocalTags

The collection of local Tag objects used within the AOI logic.

public LogixContainer<LocalTag> LocalTags { get; set; }

Property Value

LogixContainer<LocalTag>

Parameters

The collection of Parameter that make up the structure of the instruction component.

public LogixContainer<Parameter> Parameters { get; set; }

Property Value

LogixContainer<Parameter>

Revision

The revision of the instruction.

public Revision? Revision { get; set; }

Property Value

Revision

A Revision representing the version of the instruction.

Remarks

Specify the revision of the Add-On Instruction, in the form of MajorRevision.MinorRevision. Each revision number can be 1...65,535. If there is no period, the number is treated as a major revision only

RevisionExtension

Additional text indicating or identifying the revision of the instruction.

public string? RevisionExtension { get; set; }

Property Value

string

A string containing text of the revision extension.

RevisionNote

Additional text describing release information or changes with the current revision(s).

public string? RevisionNote { get; set; }

Property Value

string

A string containing the text of the revision note.

Routines

The collection of local Routine objects that contain the logic for the instruction.

public LogixContainer<Routine> Routines { get; set; }

Property Value

LogixContainer<Routine>

SoftwareRevision

Specify the revision of the application last used to edit the Add-On Instruction. The default is the currently open version of the application.

public Revision? SoftwareRevision { get; set; }

Property Value

Revision

A Revision representing the version of the instruction.

Vendor

The vendor or creator of the instruction.

public string? Vendor { get; set; }

Property Value

string

A string value representing the name of the vendor.