Table of Contents

Class MagnetElementExtensions

Namespace
Nalu.MagnetLayout
Assembly
Nalu.Maui.Layouts.dll

Extension methods for IMagnetElement.

public static class MagnetElementExtensions
Inheritance
MagnetElementExtensions
Inherited Members

Methods

GetChainPole(IMagnetElementBase, HorizontalPoles)

Gets the pole Variable of a magnet element.

public static Variable GetChainPole(this IMagnetElementBase element, HorizontalPoles pole)

Parameters

element IMagnetElementBase
pole HorizontalPoles

Returns

Variable

Exceptions

ArgumentOutOfRangeException

Invalid pole type

InvalidOperationException

The element does not implement the required interface for the specified pole

GetChainPole(IMagnetElementBase, VerticalPoles)

Gets the pole Variable of a magnet element.

public static Variable GetChainPole(this IMagnetElementBase element, VerticalPoles pole)

Parameters

element IMagnetElementBase
pole VerticalPoles

Returns

Variable

Exceptions

ArgumentOutOfRangeException

Invalid pole type

InvalidOperationException

The element does not implement the required interface for the specified pole

GetElement(HorizontalPullTarget, IMagnetStage)

Gets the element of a HorizontalPullTarget in a magnet stage.

public static IMagnetElementBase GetElement(this HorizontalPullTarget target, IMagnetStage stage)

Parameters

target HorizontalPullTarget
stage IMagnetStage

Returns

IMagnetElementBase

GetElement(VerticalPullTarget, IMagnetStage)

Gets the element of a VerticalPullTarget in a magnet stage.

public static IMagnetElementBase GetElement(this VerticalPullTarget target, IMagnetStage stage)

Parameters

target VerticalPullTarget
stage IMagnetStage

Returns

IMagnetElementBase

GetFrame(IMagnetView)

Gets the frame to which the view will be arranged.

public static Rect GetFrame(this IMagnetView view)

Parameters

view IMagnetView

Returns

Rect

GetPole(IMagnetElementBase, HorizontalPoles)

Gets the pole Variable of a magnet element.

public static Variable GetPole(this IMagnetElementBase element, HorizontalPoles pole)

Parameters

element IMagnetElementBase
pole HorizontalPoles

Returns

Variable

Exceptions

ArgumentOutOfRangeException

Invalid pole type

InvalidOperationException

The element does not implement the required interface for the specified pole

GetPole(IMagnetElementBase, VerticalPoles)

Gets the pole Variable of a magnet element.

public static Variable GetPole(this IMagnetElementBase element, VerticalPoles pole)

Parameters

element IMagnetElementBase
pole VerticalPoles

Returns

Variable

Exceptions

ArgumentOutOfRangeException

Invalid pole type

InvalidOperationException

The element does not implement the required interface for the specified pole