[Handler(ButtonToolItem.IHandler)] public class ButtonToolItem : ToolItem
Tool item to execute an action

Constructors

ButtonToolItem

#
public ButtonToolItem(Command command)
Initializes a new instance of the ButtonToolItem class with the specified command.

ButtonToolItem

#
public ButtonToolItem(EventHandler<EventArgs> click)
Initializes a new instance of the ButtonToolItem class with the specified click handler.
Remarks: This is a convenience constructor to set up the click event.
click (EventHandler<EventArgs>)Delegate to handle when the tool item is clicked.

Properties

Command

public ICommand Command { get; set; }
Gets or sets the command to invoke when the tool item is pressed.
inherited fromToolItem
Remarks: This will invoke the specified command when the tool item is pressed. The ICommand.CanExecute(object) will also used to set the enabled/disabled state of the tool item.
The command to invoke.

CommandParameter

public object CommandParameter { get; set; }
Gets or sets the parameter to pass to the ToolItem.Command when executing or determining its CanExecute state.
inherited fromToolItem

ControlObject

public object ControlObject { get; }
Gets the instance of the platform-specific object
inherited fromWidget
Remarks: This can sometimes be useful to get the platform-specific object. Some handlers may not have any backing object for its functionality, so this may be null. It is more preferred to use the Widget.Handler and cast that to the platform-specific handler class which can give you additional methods and helpers to do common tasks. For example, the Application object's handler for OS X has a AddFullScreenMenuItem property to specify if you want full screen support in your app.

DataContext

public object DataContext { get; set; }
Gets or sets the data context for this widget for binding
inherited fromBindableWidget
Remarks: Subclasses may override the standard behaviour so that hierarchy of widgets can be taken into account. For example, a Control may return the data context of a parent, if it is not set explicitly.
DataContext

Enabled

public bool Enabled { get; set; }
Gets or sets a value indicating whether this ToolItem is enabled.
inherited fromToolItem

Handler

public object Handler { get; }
Gets the platform-specific handler for this widget
inherited fromWidget

IsDataContextChanging

public bool IsDataContextChanging { get; set; }
Gets a value indicating that the BindableWidget.DataContext property is changing.
inherited fromBindableWidget
Remarks: This can be used to determine when to allow certain logic during the update of the data context. It is used to disable binding setters on the model when the data context changes so that a binding does not cause the view model to be updated when the state hasn't been fully set yet.
true if the DataContext is currently changing, false otherwise.

IsDisposed

public bool IsDisposed { get; }
Gets or sets a value indicating whether this Widget has been disposed.
inherited fromWidget
Remarks: When the widget is disposed, it can no longer be used.
true if this instance has been disposed; otherwise, false.

NativeHandle

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

Order

public int Order { get; set; }
Gets or sets the order of the tool item when adding to the ToolItemCollection.
inherited fromToolItem

Parent

public Widget Parent { get; protected internal set; }
Gets or sets the parent widget which this widget has been added to, if any
inherited fromBindableWidget
Remarks: When implementing child widgets that can participate in the context based binding (MVVM), You can set this to the parent widget when it is added or removed to it (usually via a collection). Note that you should typically provide a
public new [ParentWidget] Parent { get; }
property so that consumers of your API cannot set the parent to an invalid value.
The parent widget, or null if there is no parent

Platform

public Platform Platform { get; }
Gets the platform that was used to create the Widget.Handler for this widget
inherited fromWidget
Remarks: This gets set to the current Platform.Instance during the construction of the object

Properties

public PropertyStore Properties { get; }
Gets the dictionary of properties for this widget
inherited fromWidget

Style

public string Style { get; set; }
Gets or sets the style of this widget
inherited fromWidget
Remarks: Styles allow you to attach custom platform-specific logic to a widget. In your platform-specific assembly, use Add{H} to add the style logic with the same id.
// in your UI
var control = new Button { Style = "mystyle" };

// in your platform assembly
using Eto.Mac.Forms.Controls;

Styles.AddHandler<ButtonHandler>("mystyle", handler => {
	// this is where you can use handler.Control to set properties, handle events, etc.
	handler.Control.BezelStyle = NSBezelStyle.SmallSquare;
});

Tag

public object Tag { get; set; }
Gets or sets a user-defined tag for the tool item.
inherited fromToolItem

Text

public string Text { get; set; }
Gets or sets the text of the item, with mnemonic.
inherited fromToolItem

ToolTip

public string ToolTip { get; set; }
Gets or sets the tool tip to show when hovering the mouse over the item.
inherited fromToolItem

Visible

public bool Visible { get; set; }
Gets or sets a value indicating whether this ToolItem is visible.
inherited fromToolItem

Methods

Dispose

protected virtual void Dispose(bool disposing)
Handles the disposal of this widget
inherited fromWidget
disposing (bool)True if the caller called Widget.Dispose() manually, false if being called from a finalizer

FindParent<T>

public T FindParent<T>(string id = null)
Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
inherited fromBindableWidget
id (string = null)Identifier of the parent control to find, or null to ignore
The parent if found, or null if not found

FindParent

public Widget FindParent(Type type, string id = null)
Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
inherited fromBindableWidget
type (Type)The type of control to find.
id (string = null)Identifier of the parent control to find, or null to find by type only.
The parent if found, or null if not found.

GetCallback

protected virtual object GetCallback()
Gets an instance of an object used to perform callbacks to the widget from handler implementations
inherited fromWidget
Remarks: The callback should implement the parent class' Widget.ICallback interface so that there only needs to be a single callback for the entire hierarchy. This should return a static instance to avoid having overhead for each instance of your control.
The callback instance to use for this widget

Initialize

protected void Initialize()
Initializes the widget handler
inherited fromWidget
Remarks: This is typically called from the constructor after all of the logic is completed to construct the object. If your handler interface has the AutoInitializeAttribute set to false, then you are responsible for calling this method in your constructor after calling the creation method on your custom handler.

OnDataContextChanged

protected virtual void OnDataContextChanged(EventArgs e)
inherited fromBindableWidget
Remarks: Implementors may override this to fire this event on child widgets in a heirarchy. Alternatively, implement IBindableWidgetContainer for your widget and this will trigger any events on the children automatically. This allows a control to be bound to its own BindableWidget.DataContext, which would be set on one of the parent control(s).
e (EventArgs)Event arguments

OnLoad

protected internal virtual void OnLoad(EventArgs e)
Called when the tool item is assigned to a control/window
inherited fromTool

OnPreLoad

protected internal virtual void OnPreLoad(EventArgs e)
Called before the tool item is assigned to a control/window
inherited fromTool

OnStyleChanged

protected virtual void OnStyleChanged(EventArgs e)
Handles when the Widget.Style is changed.
inherited fromWidget

OnUnLoad

protected internal virtual void OnUnLoad(EventArgs e)
Called when the tool item is removed from a control/window
inherited fromTool

ToString

public override string ToString()
Gets a string that represents the current object with its ID if specified.
inherited fromWidget
A string value indicating the type and ID (if specified) of this widget.
Object.ToString

Unbind

public override void Unbind()
Unbinds any bindings in the BindableWidget.Bindings collection and removes the bindings
inherited fromToolItem

UpdateBindings

public virtual void UpdateBindings(BindingUpdateMode mode = BindingUpdateMode.Source)
Updates all bindings in this widget
inherited fromBindableWidget
Remarks: When you implement IBindableWidgetContainer, this will also update bindings for all of its children.
mode (BindingUpdateMode = BindingUpdateMode.Source)

Events

DataContextChanged

public event EventHandler<EventArgs> DataContextChanged
Event to handle when the BindableWidget.DataContext has changed
inherited fromBindableWidget
Remarks: This may be fired in the event of a parent in the hierarchy setting the data context. For example, the Container widget fires this event when it's event is fired.
DataContextChanged