Class CustomPathLayoutProvider

Namespace

Artemis.Core.Providers

Assembly

Artemis.Core.dll

Represents a layout provider that loads a layout from a custom path.

public class CustomPathLayoutProvider : ILayoutProvider

Inheritance

object

CustomPathLayoutProvider

Implements

ILayoutProvider

Fields

LAYOUT_TYPE

The layout type of this layout provider.

public const string LAYOUT_TYPE = "CustomPath"

Field Value

string

Methods

ApplyLayout(ArtemisDevice, ArtemisLayout)

Applies the layout to the provided device.

public void ApplyLayout(ArtemisDevice device, ArtemisLayout layout)

Parameters

device ArtemisDevice

The device to apply to.

layout ArtemisLayout

The layout to apply.

ConfigureDevice(ArtemisDevice, string?)

Configures the provided device to use this layout provider.

public void ConfigureDevice(ArtemisDevice device, string? path)

Parameters

device ArtemisDevice

The device to apply the provider to.

path string

The path to the custom layout.

GetDeviceLayout(ArtemisDevice)

If available, loads an Artemis layout for the provided device.

public ArtemisLayout? GetDeviceLayout(ArtemisDevice device)

Parameters

device ArtemisDevice

The device to load the layout for.

Returns

ArtemisLayout

The resulting layout if one was available; otherwise null.

IsMatch(ArtemisDevice)

Determines whether the provided device is configured to use this layout provider.

public bool IsMatch(ArtemisDevice device)

Parameters

device ArtemisDevice

The device to check.

Returns

bool

A value indicating whether the provided device is configured to use this layout provider.