Base class for items of the SegmentedButton control.
Constructors
SegmentedItem
#Initializes a new instance of the SegmentedItem class with the specified command.
Remarks: This links the segmented item with the specified command, and will trigger Command.Execute() when the user clicks the item, and enable/disable the menu item based on Command.Enabled. This also supports RadioCommand and CheckCommand, which may be appropriate depending on the current SegmentedButton.SelectionMode. For SegmentedSelectionMode.Multiple, then CheckCommand would be preferred, whereas for SegmentedSelectionMode.Single, RadioCommand would make more sense. Otherwise, use Command if the mode is SegmentedSelectionMode.None. This is not a weak link, so you should not reuse the Command instance for other menu items if you are disposing this segmented item.
Parameters:
| command (Command) | Command to initialize the menu item with. |
Fields
Properties
Bindings
Gets the collection of bindings that are attached to this widget
Command
#Gets or sets the command to invoke when the segmented item is pressed.
Remarks: This will invoke the specified command when the segmented item is pressed. The ICommand.CanExecute(object) will also used to set the enabled/disabled state of the segmented item.
Value: The command to invoke.
CommandParameter
#Gets or sets the parameter to pass to the Command when executing or determining its CanExecute state.
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
Gets or sets the data context for this widget for binding
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.
Implements: DataContext
Enabled
#Gets or sets a value indicating whether this SegmentedItem is enabled.
Value:
true if enabled; otherwise, false.IsDataContextChanging
Gets a value indicating that the BindableWidget.DataContext property is changing.
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.
Value:
true if the DataContext is currently changing, false otherwise.Implements: IsDataContextChanging
IsDisposed
Gets or sets a value indicating whether this Widget has been disposed.
Remarks: When the widget is disposed, it can no longer be used.
Value:
true if this instance has been disposed; otherwise, false.NativeHandle
public nint NativeHandle { get; }
Gets the native platform-specific handle for integration purposes
Value: The native handle.
Parent
#Gets the parent button this item belongs to.
Remarks: Note this is only set after adding your item to the SegmentedButton.Items collection.
Value: The parent control.
Parents
Gets an enumeration of all parent widgets in the heirarchy by traversing the BindableWidget.Parent property.
inherited fromWidget
Remarks: This gets set to the current Platform.Instance during the construction of the object
Selected
#Gets or sets a value indicating whether this SegmentedItem is selected.
Value:
true if selected; otherwise, false.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.
Example:
// 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;
});Visible
#Gets or sets a value indicating whether this SegmentedItem is visible.
Value:
true if visible; otherwise, false.Methods
Dispose
public void Dispose()
Disposes of this widget, supressing the finalizer
Parameters:
| disposing (bool) | True if the caller called Widget.Dispose() manually, false if being called from a finalizer |
FindParent<T>
Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
Parameters:
| id (string = null) | Identifier of the parent control to find, or null to ignore |
Returns: The parent if found, or null if not found
FindParent
Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
GetCallback
#Gets an instance of an object used to perform callbacks to the widget from handler implementations
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.
Returns: The callback instance to use for this widget
Overrides: Widget.GetCallback
Initialize
protected void Initialize()
Initializes the widget handler
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.
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).
Parameters:
| e (EventArgs) | Event arguments |
inherited fromWidget
ToString
Gets a string that represents the current object with its ID if specified.
Returns: A string value indicating the type and ID (if specified) of this widget.
Overrides: Object.ToString
Unbind
#public override void Unbind()
Unbinds any bindings in the BindableWidget.Bindings collection and removes the bindings
Remarks: When you implement IBindableWidgetContainer, this will also unbind any of its children.
Overrides: BindableWidget.Unbind
UpdateBindings
Updates all bindings in this widget
Remarks: When you implement IBindableWidgetContainer, this will also update bindings for all of its children.
Parameters:
| mode (BindingUpdateMode = BindingUpdateMode.Source) |
Events
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.
Implements: DataContextChanged
inherited fromWidget
Convertors
| Operation | Result | Description | ||
|---|---|---|---|---|
| implicit | Command | SegmentedItem | Implicitly converts a command to a segmented item. | |
| implicit | Image | SegmentedItem | Implicitly converts an image to a segmented item. | |
| implicit | string | SegmentedItem | Implicitly converts a string to a segmented item. | |