FormattedText.IHandler

References
public interface FormattedText.IHandler : Widget.IHandler
Handler for implementations of the FormattedText class.

Properties

ForegroundBrush

#
Brush ForegroundBrush { get; set; }
Gets or sets the brush to use to draw the text.

ID

string ID { get; set; }
Gets or sets an ID for the widget
inherited fromWidget.IHandler
Remarks: Some platforms may use this to identify controls (e.g. web)

MaximumSize

#
SizeF MaximumSize { get; set; }
Gets or sets the maximum size of the text.
Remarks: The width is used when wrapping, trimming, and aligning the text. The height is used when trimming the text. Only the last full visible line will be visible.

NativeHandle

nint NativeHandle { get; }
Gets the native platform-specific handle for integration purposes
inherited fromWidget.IHandler

Trimming

#
FormattedTextTrimming Trimming { get; set; }
Gets or sets the trimming mode.
Remarks: Note that not all platforms support all modes and may fall back to a different mode.

Wrap

#
FormattedTextWrapMode Wrap { get; set; }
Gets or sets the wrapping mode.
Remarks: Note that not all platforms support all modes and may fall back to a different mode.

Methods

HandleEvent

void HandleEvent(string id, bool defaultEvent = false)
Called to handle a specific event
inherited fromWidget.IHandler
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.
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)

Initialize

void Initialize()
Called after the widget is constructed
inherited fromWidget.IHandler
Remarks: This gets called automatically after the control is constructed and the Widget.IHandler.Widget and Widget.Platform properties are set. When the handler has specialized construction methods, then the AutoInitializeAttribute can be used to disable automatic initialization. In this case, it is the responsibility of the subclass to call Widget.Initialize()

Measure

#
SizeF Measure()
Gets the size needed to draw the text.
Remarks: This may be smaller than the MaximumSize.
The size of the rectangle needed to draw the text

UnhandleEvent

virtual void UnhandleEvent(string id)
Called when the last subscriber to an event has been removed, so the platform can stop listening for it.
inherited fromWidget.IHandler
Remarks: Only reached for events whose remove accessor uses PropertyStore.RemoveHandlerEvent(string, Delegate), and only for events that were attached because something subscribed to them. An event attached because the widget overrides its On[Event] method is never detached, since it has to keep firing regardless. Most events stay attached for the life of the widget, which costs nothing. Detaching is worth wiring up for the few that hold onto something expensive or process wide while they are attached, such as a system wide hook. Handlers deriving from WidgetHandler<TWidget> get an implementation of this that dispatches to WidgetHandler<TWidget>.DetachEvent(string), which is what to override.
id (string)ID of the event to stop handling