Class L5X

Namespace

L5Sharp

Assembly

L5Sharp.dll

A XElement decorator that adds members for interacting with the root L5X content. This class should represent the root RSLogix5000Content element of the L5X file.

public class L5X : XElement, IXmlLineInfo, IXmlSerializable

Inheritance

object

XObject

XNode

XContainer

XElement

L5X

Implements

IXmlLineInfo

IXmlSerializable

Inherited Members

XElement.AncestorsAndSelf()

XElement.AncestorsAndSelf(XName)

XElement.Attribute(XName)

XElement.Attributes()

XElement.Attributes(XName)

XElement.DescendantNodesAndSelf()

XElement.DescendantsAndSelf()

XElement.DescendantsAndSelf(XName)

XElement.GetDefaultNamespace()

XElement.GetNamespaceOfPrefix(string)

XElement.GetPrefixOfNamespace(XNamespace)

XElement.Load(Stream)

XElement.Load(Stream, LoadOptions)

XElement.Load(TextReader)

XElement.Load(TextReader, LoadOptions)

XElement.Load(string)

XElement.Load(string, LoadOptions)

XElement.Load(XmlReader)

XElement.Load(XmlReader, LoadOptions)

XElement.LoadAsync(Stream, LoadOptions, CancellationToken)

XElement.LoadAsync(TextReader, LoadOptions, CancellationToken)

XElement.LoadAsync(XmlReader, LoadOptions, CancellationToken)

XElement.Parse(string)

XElement.Parse(string, LoadOptions)

XElement.RemoveAll()

XElement.RemoveAttributes()

XElement.ReplaceAll(object)

XElement.ReplaceAll(params object[])

XElement.ReplaceAttributes(object)

XElement.ReplaceAttributes(params object[])

XElement.Save(Stream)

XElement.Save(Stream, SaveOptions)

XElement.Save(TextWriter)

XElement.Save(TextWriter, SaveOptions)

XElement.Save(string)

XElement.Save(string, SaveOptions)

XElement.Save(XmlWriter)

XElement.SaveAsync(Stream, SaveOptions, CancellationToken)

XElement.SaveAsync(TextWriter, SaveOptions, CancellationToken)

XElement.SaveAsync(XmlWriter, CancellationToken)

XElement.SetAttributeValue(XName, object)

XElement.SetElementValue(XName, object)

XElement.SetValue(object)

XElement.WriteTo(XmlWriter)

XElement.WriteToAsync(XmlWriter, CancellationToken)

XElement.EmptySequence

XElement.FirstAttribute

XElement.HasAttributes

XElement.HasElements

XElement.IsEmpty

XElement.LastAttribute

XElement.Name

XElement.NodeType

XElement.Value

XContainer.Add(object)

XContainer.Add(params object[])

XContainer.AddFirst(object)

XContainer.AddFirst(params object[])

XContainer.CreateWriter()

XContainer.DescendantNodes()

XContainer.Descendants()

XContainer.Descendants(XName)

XContainer.Element(XName)

XContainer.Elements()

XContainer.Elements(XName)

XContainer.Nodes()

XContainer.RemoveNodes()

XContainer.ReplaceNodes(object)

XContainer.ReplaceNodes(params object[])

XContainer.FirstNode

XContainer.LastNode

XNode.AddAfterSelf(object)

XNode.AddAfterSelf(params object[])

XNode.AddBeforeSelf(object)

XNode.AddBeforeSelf(params object[])

XNode.Ancestors()

XNode.Ancestors(XName)

XNode.CompareDocumentOrder(XNode, XNode)

XNode.CreateReader()

XNode.CreateReader(ReaderOptions)

XNode.DeepEquals(XNode, XNode)

XNode.ElementsAfterSelf()

XNode.ElementsAfterSelf(XName)

XNode.ElementsBeforeSelf()

XNode.ElementsBeforeSelf(XName)

XNode.IsAfter(XNode)

XNode.IsBefore(XNode)

XNode.NodesAfterSelf()

XNode.NodesBeforeSelf()

XNode.ReadFrom(XmlReader)

XNode.ReadFromAsync(XmlReader, CancellationToken)

XNode.Remove()

XNode.ReplaceWith(object)

XNode.ReplaceWith(params object[])

XNode.ToString()

XNode.ToString(SaveOptions)

XNode.DocumentOrderComparer

XNode.EqualityComparer

XNode.NextNode

XNode.PreviousNode

XObject.AddAnnotation(object)

XObject.Annotation(Type)

XObject.Annotations(Type)

XObject.Annotations<T>()

XObject.Annotation<T>()

XObject.RemoveAnnotations(Type)

XObject.RemoveAnnotations<T>()

XObject.BaseUri

XObject.Document

XObject.Parent

XObject.Changed

XObject.Changing

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LogixExtensions.LogixName(XElement)

Remarks

Most of these methods and properties are meant to be internal and are used by LogixContent. However, the user can use this type if they need direct access to the underlying XML to perform custom query or extend the API.

Constructors

L5X(XElement)

Creates a new L5X instance wrapping the provided XElement object.

public L5X(XElement content)

Parameters

content XElement

Fields

DateTimeFormat

The date/time format for the L5X content.

public const string DateTimeFormat = "ddd MMM d HH:mm:ss yyyy"

Field Value

string

Properties

ContainsContext

Gets the value indicating whether the current L5X is contextual..

public bool? ContainsContext { get; set; }

Property Value

bool?

ExportDate

Gets the date time that the L5X file was exported.

public DateTime? ExportDate { get; }

Property Value

DateTime?

Owner

Gets the owner that exported the current L5X file.

public string? Owner { get; set; }

Property Value

string

SchemaRevision

Gets the value of the schema revision for the current L5X content.

public Revision? SchemaRevision { get; set; }

Property Value

Revision

A Revision type that represent the major/minor revision of the L5X schema.

Remarks

This is always 1.0. If the R

SoftwareRevision

Gets the value of the software revision for the current L5X content.

public Revision? SoftwareRevision { get; set; }

Property Value

Revision

A Revision type that represent the major/minor revision of the software.

TargetName

Gets the name of the Logix component that is the target of the current L5X context.

public string? TargetName { get; set; }

Property Value

string

TargetType

Gets the type of Logix component that is the target of the current L5X context.

public string? TargetType { get; set; }

Property Value

string

Methods

GetContainer(string)

Gets a top level container element from the root controller element of the L5X.

public XElement GetContainer(string name)

Parameters

name string

The name of the container to retrieve.

Returns

XElement

A XElement representing the container with the provided name.

Exceptions

InvalidOperationException

The element does not exist.

GetController()

Gets the root controller element of the L5X file.

public XElement GetController()

Returns

XElement