AxisCollection
Contains a collection of Axes and allows getting of axis by Id
Inherits: ObservableCollection<IAxis>
Implements: IXmlSerializable
Constructors
public AxisCollection()
axisCollection = AxisCollection()
Initializes a new instance of the AxisCollection class.
public AxisCollection(IEnumerable<IAxis> collection)
axisCollection = AxisCollection(collection)
Initializes a new instance of the AxisCollection class.
- collection
- The collection.
Properties
public IAxis Default { get; }
value = axisCollection.Default
Gets the default axis, which is equal to the axis with the DefaultAxisId, else null
protected bool HasPrimaryAxis { get; }
value = axisCollection.HasPrimaryAxis
Returns true if any of the Axes in the collection have IsPrimaryAxis set to true
protected IAxis PrimaryAxis { get; }
value = axisCollection.PrimaryAxis
Gets the primary axis in the collection. This is the first that has IsPrimaryAxis set to true, or null if none exists.
Methods
public IAxis GetAxisById(string axisId, bool assertAxisExists)
result = axisCollection.GetAxisById(axisId, assertAxisExists)
Gets the axis specified by Id, else null
- axisId
- The axis identifier.
- assertAxisExists
- if set to true assert and throw if the axis does not exist.
public XmlSchema GetSchema()
result = axisCollection.GetSchema()
Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method
public virtual void ReadXml(XmlReader reader)
axisCollection.ReadXml(reader)
Generates AxisCollection from its XML representation.
- reader
public virtual void WriteXml(XmlWriter writer)
axisCollection.WriteXml(writer)
Converts AxisCollection into its XML representation.
- writer