FloatingForm.IHandler

References
public interface FloatingForm.IHandler : Form.IHandler
Interface handler for the FloatingForm control

Properties

AllowDrop

bool AllowDrop { get; set; }
Gets or sets a value indicating whether this control can serve as drop target.
inherited fromControl.IHandler

AutoSize

bool AutoSize { get; set; }
Gets or sets a value indicating that the window will automatically resize when its content changes
inherited fromWindow.IHandler
Remarks: Note that if you set both dimensions of the Size and/or Container.ClientSize, this will be set to false.
true to auto size the window when its content changes, false to only auto size when first created

BackgroundColor

Color BackgroundColor { get; set; }
Gets or sets the color for the background of the control
inherited fromControl.IHandler
Remarks: Note that on some platforms (e.g. Mac), setting the background color of a control can change the performance characteristics of the control and its children, since it must enable layers to do so.
The color of the background.

Bounds

Rectangle Bounds { get; set; }
Gets or sets the size and location of the window
inherited fromWindow.IHandler
Remarks: Where the platform provides an API to set both the size and location at once, handlers should use it so the window is repositioned and resized in a single operation instead of two separate steps.
The bounding rectangle of the window

CanFocus

bool CanFocus { get; set; }
Gets or sets a value indicating that this form can get keyboard/input focus when the user clicks on it or any child control.
inherited fromForm.IHandler
Remarks: This is useful for windows that provide interaction but do not steal focus from the current window, such as a tooltip, popover, etc.
true if the form can get focus; otherwise, false.

ClientSize

Size ClientSize { get; set; }
Gets or sets the size for the client area of the control
inherited fromContainer.IHandler
Remarks: The client size differs from the Size in that it excludes the decorations of the container, such as the title bar and border around a Window, or the title and line around a GroupBox.
The size of the client area

Closeable

bool Closeable { get; set; }
Gets or sets a value indicating whether the close button should be shown. Defaults to true
inherited fromWindow.IHandler
Remarks: Note that on some platforms (e.g. Windows) this also hides the system menu if Window.IHandler.Minimizable and Window.IHandler.Maximizable are also false. Note that this does not prevent the window from being closed, to do that use the Window.Closing event.
true to show the close button (and in some platforms the system menu), false to hide them.

Content

Control Content { get; set; }
Gets or sets the main content of the panel.
inherited fromPanel.IHandler
Remarks: The main content will be offset by the Panel.IHandler.Padding value specified, and will take up the entire content area of the control. Some controls may have decorations that will surround the content, such as a GroupBox, TabControl, or Window
The child content of the control.

ContextMenu

ContextMenu ContextMenu { get; set; }
Gets or sets the context menu to show when the user right clicks or presses the menu key
inherited fromIContextMenuHost

Cursor

Cursor Cursor { get; set; }
Gets or sets the type of cursor to use when the mouse is hovering over the control
inherited fromControl.IHandler

Enabled

bool Enabled { get; set; }
Gets or sets a value indicating whether this Control is enabled and accepts user input.
inherited fromControl.IHandler
Remarks: Typically when a control is disabled, the user cannot do anything with the control (including for example, selecting text in a text control). Certain controls can have a 'Read Only' mode, such as TextBox.ReadOnly which allows the user to select text, but not change its contents.
true if enabled; otherwise, false.

HasFocus

bool HasFocus { get; }
Gets a value indicating whether this instance has the keyboard input focus.
inherited fromControl.IHandler

Icon

Icon Icon { get; set; }
Gets or sets the icon for the window to show in the menu bar.
inherited fromWindow.IHandler
Remarks: The icon should have many variations, such as 16x16, 24x24, 32x32, 48x48, 64x64, etc. This ensures that the many places it is used (title bar, task bar, switch window, etc) all have optimized icon sizes. For OS X, the application icon is specified in the .app bundle, not by this value.
The icon for this window.

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)

IsMouseCaptured

bool IsMouseCaptured { get; }
Gets a value indicating this control currently has mouse capture
inherited fromControl.IHandler
Remarks: Mouse capture can happen during a handled MouseDown event until MouseUp, or it can be captured explicitly via Control.IHandler.CaptureMouse().

Location

Point Location { get; set; }
Gets or sets the location of the window
inherited fromWindow.IHandler
Remarks: Note that in multi-monitor setups, the origin of the location is at the upper-left of Screen.PrimaryScreen. Also note, that on Linux systems running GTK via Wayland, the location is relative to the Window.Owner when one is set and the Window.IHandler.WindowStyle is WindowStyle.None; otherwise it will always point to 0, 0 and setting it to different values will have no effect. Using Control.PointToScreen(PointF) on a control within the Window.Owner can be used to position the window relative to specific elements of the owner.

LogicalPixelSize

float LogicalPixelSize { get; }
Gets the number of pixels per logical pixel when on a high DPI display.
inherited fromWindow.IHandler
Remarks: This indicates the number of pixels per logical pixel. All units in Eto.Forms such as control size, drawing operations, etc are in logical pixels. When not in high DPI, this will be 1.0; Retina displays in OS X will return 2; and in windows this matches the scale set in the monitor settings. Use the Window.LogicalPixelSizeChanged to detect when the window is moved to a display with a different DPI.

Maximizable

bool Maximizable { get; set; }
Gets or sets a value indicating whether this Window can be maximized.
inherited fromWindow.IHandler
Remarks: This may hide or disable the minimize button on the title bar.
true if maximizable; otherwise, false.

Minimizable

bool Minimizable { get; set; }
Gets or sets a value indicating whether this Window can be minimized.
inherited fromWindow.IHandler
Remarks: This may hide or disable the maximize button on the title bar.
true if minimizable; otherwise, false.

MinimumSize

Size MinimumSize { get; set; }
Gets or sets the minimum size of the panel.
inherited fromPanel.IHandler

MovableByWindowBackground

bool MovableByWindowBackground { get; set; }
Gets or sets a value indicating that the window can be moved by click+dragging the window background
inherited fromWindow.IHandler

NativeHandle

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

Opacity

double Opacity { get; set; }
Gets or sets the opacity of the window
inherited fromWindow.IHandler

Padding

Padding Padding { get; set; }
Gets or sets the padding around the Panel.IHandler.Content of the panel.
inherited fromPanel.IHandler

RecurseToChildren

bool RecurseToChildren { get; }
Gets a value indicating whether PreLoad/Load/LoadComplete/Unload events are propegated to the children controls
inherited fromContainer.IHandler
Remarks: This is mainly used when you want to use Eto controls in your handler, such as with the ThemedContainerHandler<TContainer, TWidget, TCallback>
true to recurse events to children; otherwise, false.

Resizable

bool Resizable { get; set; }
Gets or sets a value indicating whether this Window is resizable.
inherited fromWindow.IHandler

RestoreBounds

Rectangle RestoreBounds { get; }
Gets the bounds of the window before it was minimized or maximized.
inherited fromWindow.IHandler
Remarks: This is useful to retrieve the desired size and position of the window even though it is currently maximized or minimized.
The restore bounds.

Screen

Screen Screen { get; }
Gets the screen this window is mostly contained in. Typically defined by the screen center of the window is visible.
inherited fromWindow.IHandler

ShowActivated

bool ShowActivated { get; set; }
Gets or sets a value indicating that the form should be activated when initially shown.
inherited fromForm.IHandler
Remarks: When true, the form will become the active/focussed window when the Form.IHandler.Show() method is called. When false, the form will show but will not get focus until the user clicks on the form.

ShowInTaskbar

bool ShowInTaskbar { get; set; }
Gets or sets a value indicating whether this Window will show in the taskbar.
inherited fromWindow.IHandler
Remarks: Some platforms, e.g. OS X do not show a separate icon for each running window.
true if the window will show in taskbar; otherwise, false.

Size

Size Size { get; set; }
Gets or sets the size of the control. Use -1 to specify auto sizing for either the width and/or height.
inherited fromControl.IHandler
Remarks: Setting the size of controls is entirely optional as most controls will size themselves appropriately. When specifying a size, it will be used as the desired size of the control. The container will reposition and resize the control depending on the available size. For a Window, it is preferred to set the Container.ClientSize instead, as various platforms have different sizes of window decorations, toolbars, etc.
The current size of the control

SupportedPlatformCommands

IEnumerable<string> SupportedPlatformCommands { get; }
Gets the supported platform commands that can be used to hook up system functions to user defined logic
inherited fromControl.IHandler

TabIndex

int TabIndex { get; set; }
Gets or sets the tab index order for this control within its container.
inherited fromControl.IHandler
Remarks: This sets the order when using the tab key to cycle through controls Note that some platforms (Gtk and WinForms) may not support setting the context of the tab order to StackLayout or DynamicLayout containers and may not behave exactly as expected. Use the PlatformFeatures.TabIndexWithCustomContainers flag to determine if it is supported.
The index of the control in the tab order.

TabStop

bool TabStop { get; set; }
Gets or sets a value indicating whether the user can get to this control using the tab key.
inherited fromControl.IHandler
Remarks: When false, the control is skipped when cycling through controls with the tab key, but can still be focused by clicking on it or by calling Control.Focus(). Note that on Gtk this also prevents the control from being focused by clicking on it, and on iOS and Android this has no effect.
true to include the control in the tab order (the default); false to skip it.

Title

string Title { get; set; }
Gets or sets the title of the window
inherited fromWindow.IHandler
Remarks: The title of the window is displayed to the user usually at the top of the window, but in cases where you show a window in a mobile environment, this may be the title shown in a navigation controller.
The title of the window

ToolBar

ToolBar ToolBar { get; set; }
Gets or sets the tool bar for the window.
inherited fromWindow.IHandler
Remarks: Note that each window can only have a single tool bar
The tool bar for the window

ToolTip

string ToolTip { get; set; }
Gets or sets the tool tip to show when the mouse is hovered over the control
inherited fromControl.IHandler

Topmost

bool Topmost { get; set; }
Gets or sets a value indicating whether this Window is above all other windows.
inherited fromWindow.IHandler
Remarks: The window should be above all other windows when this is true. In some platforms, this will show above all other windows only when the application has focus.
true if the window should be topmost; otherwise, false.

Visible

bool Visible { get; set; }
Gets or sets a value indicating whether this Control is visible to the user.
inherited fromControl.IHandler
Remarks: When the visibility of a control is set to false, it will still occupy space in the layout, but not be shown. The only exception is for controls like the Splitter, which will hide a pane if the visibility of one of the panels is changed.
true if visible; otherwise, false.

VisualControls

IEnumerable<Control> VisualControls { get; }
Gets an enumeration of controls that are in the visual tree.
inherited fromControl.IHandler
Remarks: This is used to specify which controls are contained by this instance that are part of the visual tree. This should include all controls including non-logical Eto controls used for layout.
The visual controls.

WindowState

WindowState WindowState { get; set; }
Gets or sets the state of the window.
inherited fromWindow.IHandler

WindowStyle

WindowStyle WindowStyle { get; set; }
Gets or sets the style of this window.
inherited fromWindow.IHandler

Methods

BringToFront

void BringToFront()
Brings the window in front of all other windows in the z-order.
inherited fromWindow.IHandler

CaptureMouse

bool CaptureMouse()
Captures all mouse events to this control.
inherited fromControl.IHandler
Remarks: This captures all mouse events until Control.IHandler.ReleaseMouseCapture() is called. Note that not all platforms will allow a mouse capture unless the mouse is currently down.
true if the mouse was captured, false otherwise.

Close

void Close()
Closes the window
inherited fromWindow.IHandler
Remarks: Note that once a window is closed, it cannot be shown again in most platforms.

DoDragDrop

void DoDragDrop(DataObject data, DragEffects allowedEffects, Image image, PointF cursorOffset)
Starts drag operation using this control as drag source.
inherited fromControl.IHandler
data (DataObject)Drag data.
allowedEffects (DragEffects)Allowed effects.
image (Image)Custom drag image
cursorOffset (PointF)Offset of the cursor to the drag image

Focus

void Focus()
Attempts to set the keyboard input focus to this control, or the first child that accepts focus
inherited fromControl.IHandler

GetNativeParentWindow

Window GetNativeParentWindow()
Gets a parent window wrapper around the native window
inherited fromControl.IHandler

GetPreferredSize

SizeF GetPreferredSize(SizeF availableSize)
Gets the preferred size of this control given the specified availableSize.
inherited fromControl.IHandler
availableSize (SizeF)The available size to determine the preferred size
The preferred size this control would like to be, which can be larger than the specified availableSize.

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()

Invalidate

void Invalidate(bool invalidateChildren)
Queues a repaint of the entire control on the screen
inherited fromControl.IHandler
Remarks: This is only useful when the control is visible.
invalidateChildren (bool)True to invalidate all children, false to only invalidate the container

Invalidate

void Invalidate(Rectangle rect, bool invalidateChildren)
Queues a repaint of the specified rect of the control
inherited fromControl.IHandler
Remarks: This is only useful when the control is visible.
rect (Rectangle)Rectangle to repaint
invalidateChildren (bool)True to invalidate all children, false to only invalidate the container

MapPlatformCommand

void MapPlatformCommand(string systemCommand, Command command)
Specifies a command to execute for a platform-specific command
inherited fromControl.IHandler
Remarks: Some platforms have specific system-defined commands that can be associated with a control. For example, the Mac platform's cut/copy/paste functionality is defined by the system, and if you want to hook into it, you can use this to map it to your own defined logic. The valid values of the systemCommand parameter are defined by each platform, and a list can be retrieved using Control.SupportedPlatformCommands
systemCommand (string)System command.
command (Command)Command to execute, or null to restore to the default behavior
This example shows how to extend a control with cut/copy/paste for the mac platform:
var drawable = new Drawable();
if (drawable.Generator.IsMac)
{
	drawable.MapPlatformCommand("cut", new MyCutCommand());
	drawable.MapPlatformCommand("copy", new MyCopyCommand());
	drawable.MapPlatformCommand("paste", new MyPasteCommand());
}

PointFromScreen

PointF PointFromScreen(PointF point)
Converts a point from screen space to control space.
inherited fromControl.IHandler

PointToScreen

PointF PointToScreen(PointF point)
Converts a point from control space to screen space
inherited fromControl.IHandler

RemoveGesture

void RemoveGesture(Gesture item)
Removes a gesture from the control.
inherited fromControl.IHandler

ResumeLayout

void ResumeLayout()
Resumes the layout after it has been suspended, and performs a layout
inherited fromControl.IHandler
Remarks: This can be used to optimize some platforms while adding, removing, or changing many child controls at once. Each call to ResumeLayout() must be balanced with a call to Control.IHandler.SuspendLayout() before it.

SetParent

void SetParent(Container oldParent, Container newParent)
Called when the parent of the control has been set
inherited fromControl.IHandler
oldParent (Container)Old parent for the control, or null if the control is added
newParent (Container)New parent for the control, or null if the parent was removed

SuspendLayout

void SuspendLayout()
Suspends the layout of child controls
inherited fromControl.IHandler
Remarks: This can be used to optimize some platforms while adding, removing, or changing many child controls at once. It disables the calculation of control positioning until Control.IHandler.ResumeLayout() is called. Each call to SuspendLayout() must be balanced with a call to Control.IHandler.ResumeLayout().

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

UpdateLayout

void UpdateLayout()
Updates the layout of this control if necessary.
inherited fromControl.IHandler
Remarks: This will ensure the control has had all of its layout applied so you can use its position and size right after this call. Most platforms (except WinForms) use a deferred layout system so that after adding your control to the form dynamically it won't get laid out until the next idle loop. This is useful when you need to know the dimensions of the control immediately.