Version

EditorButtonBase Class

Abstract base class for editor buttons
Syntax
'Declaration
 
Public MustInherit Class EditorButtonBase 
   Inherits Infragistics.Shared.KeyedSubObjectBase
   Implements Infragistics.Shared.IKeyedSubObject, Infragistics.Shared.IKeyedSubObjectEx 
public abstract class EditorButtonBase : Infragistics.Shared.KeyedSubObjectBase, Infragistics.Shared.IKeyedSubObject, Infragistics.Shared.IKeyedSubObjectEx  
Remarks

The EditorButtonBase is the base class for an editor button. An editor button provides a way to display a generic button within a text or mask editor. Many of the editor classes already provide their own buttons that relate specifically to their value and are controlled by the editor itself. The editor buttons allow you to add additional buttons and affect the editor as required. For example, you can use an DropDownEditorButton to display a custom control in a dropdown window.

As well as providing several basic properties (e.g. Visible, Appearance, etc), there are also several members that must be overriden. The CalculatePreferredSize member is used to determine the size requested by the editor button to display its contents. The CreateUIElement method is used to obtain the Infragistics.Win.UIElement that will provide the display for the button. The UIElementType member should return the type of UIElement that will be used to display the button. Implements should also override the Clone and InitializeFrom methods.

Implements that provide events should derive their event arguments from EditorButtonEventArgs or CancelableEditorButtonEventArgs to provide both the button instance related to the event as well as the EditorButtonEventArgs.Context.

Note The editor buttons do not automatically affect the value of the editor in any way. The Editor property is provided from the button so that you can manipulate the editor as required.

Note Implementors must override the CreateInstanceDescriptor if the object is to be properly serialized at design time.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also