ThemedMessageBoxHandler

WidgetHandler<1>
A themed message box handler to allow more customization and theming

Properties

Buttons

#
public MessageBoxButtons Buttons { get; set; }
Gets or sets which buttons to show on the message box.

Callback

protected object Callback { get; }
Gets the callback object for the control
inherited fromWidgetHandler<TWidget>
Remarks: This object is typically a single static instance that is used by the platform handlers to call private or protected methods on the widget, such as protected event methods e.g. protected virtual void OnClick(EventArgs e)
The callback.

Caption

#
public string Caption { get; set; }
Gets or sets the caption for the title bar or heading of the message box.

DefaultButton

#
public MessageBoxDefaultButton DefaultButton { get; set; }
Gets or sets the default button, or MessageBoxDefaultButton.Default to automatically select either Cancel or No if displayed.

NativeHandle

public virtual nint NativeHandle { get; }
Gets the native platform-specific handle for integration purposes
inherited fromWidgetHandler<TWidget>

Text

#
public string Text { get; set; }
Gets or sets the body text of the message box.

Type

#
public MessageBoxType Type { get; set; }
Gets or sets the type of message box, usually changing the icon displayed.

Widget

public TWidget Widget { get; }
Gets the widget that this platform handler is attached to
inherited fromWidgetHandler<TWidget>

Methods

AttachEvent

public virtual void AttachEvent(string id)
Attaches the specified event to the platform-specific control
inherited fromWidgetHandler<TWidget>
Remarks: Implementors should override this method to handle any events that the widget supports. Ensure to call the base class' implementation if the event is not one the specific widget supports, so the base class' events can be handled as well.
id (string)Identifier of the event

DetachEvent

public virtual bool DetachEvent(string id)
Detaches an event from the platform-specific control, undoing WidgetHandler<TWidget>.AttachEvent(string).
inherited fromWidgetHandler<TWidget>
Remarks: Implementors can override this for events that hold onto something worth giving back while they are attached, such as a system wide hook. Most events cost nothing to leave attached for the life of the widget, which is why the default is to refuse. Only reached for events whose remove accessor uses PropertyStore.RemoveHandlerEvent(string, Delegate), and never for an event that is attached because the widget overrides its On[Event] method.
id (string)Identifier of the event
True if the event was detached, false if this platform can't detach it, in which case it stays attached and won't be attached again on a later subscription.

Dispose

protected virtual void Dispose(bool disposing)
Disposes the object
inherited fromWidgetHandler<TWidget>
disposing (bool)True when disposed manually, false if disposed via the finalizer

HandleEvent

public void HandleEvent(string id, bool defaultEvent = false)
Called to handle a specific event
inherited fromWidgetHandler<TWidget>
Remarks: Most events are late bound by this method. Instead of wiring all events, this will be called with an event string that is defined by the control. This is called automatically when attaching to events, but must be called manually when users of the control only override the event's On... method. Override the WidgetHandler<TWidget>.AttachEvent(string) to attach your events
id (string)ID of the event to handle
defaultEvent (bool = false)True if the event is default (e.g. overridden or via an event handler subscription)
HandleEvent

Initialize

protected virtual void Initialize()
Called to initialize this widget after it has been constructed
inherited fromWidgetHandler<TWidget>
Remarks: Override this to initialize any of the platform objects. This is called in the widget constructor, after all of the widget's constructor code has been called.

IsEventHandled

public bool IsEventHandled(string id)
Gets a value indicating that the specified event is handled
inherited fromWidgetHandler<TWidget>
id (string)Identifier of the event
True if the event is handled, otherwise false

OnInitializeComplete

protected virtual void OnInitializeComplete()
Called after initialization is complete
inherited fromWidgetHandler<TWidget>
Remarks: Override this to perform any logic after the handler is fully initialized, but before returning from the construction of the widget. This by default applies the any styles for the handler.

ShowDialog

#
public DialogResult ShowDialog(Control parent)
Shows the dialog.
parent (Control)Optional parent. If specified, the parent's window should be blocked from input. If null, all windows should be blocked.
The dialog result.
ShowDialog

UnhandleEvent

public void UnhandleEvent(string id)
Called when the last subscriber to an event has been removed, giving WidgetHandler<TWidget>.DetachEvent(string) the chance to stop listening for it.
inherited fromWidgetHandler<TWidget>