Class MessageBox

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about the message box to show

public class MessageBox : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

MessageBox

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MessageBox()

public MessageBox()

Properties

AxisControls

Bitmap of the axis movement controls to show (indices)

public long? AxisControls { get; set; }

Property Value

long?

CancelButton

Indicates if a cancel button is supposed to be shown

public bool CancelButton { get; set; }

Property Value

bool

Choices

List of possible choices (only for mode 4)

public ObservableCollection<string>? Choices { get; set; }

Property Value

ObservableCollection<string>

Default

Default value (only for modes >= 4)

public object? Default { get; set; }

Property Value

object

Max

Maximum input value (only for modes >= 5)

public float? Max { get; set; }

Property Value

float?

Message

Content of the message box

public string Message { get; set; }

Property Value

string

Min

Minimum input value (only for modes >= 5)

public float? Min { get; set; }

Property Value

float?

Mode

Mode of the message box to display

public MessageBoxMode Mode { get; set; }

Property Value

MessageBoxMode

Seq

Sequence number of the message box

public int Seq { get; set; }

Property Value

int

Remarks

This is increased whenever a new message box is supposed to be displayed

Timeout

Total timeout for this message box (in ms)

public int Timeout { get; set; }

Property Value

int

Title

Title of the message box

public string Title { get; set; }

Property Value

string

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data