C# Class ComponentFactory.Krypton.Navigator.ViewDrawNavCheckButtonBase

Navigator view base element for drawing a check button for a krypton page.

Inheritance: ComponentFactory.Krypton.Toolkit.ViewDrawButton, IContentValues

Show file Open project: ComponentFactory/Krypton Class Usage Examples

Protected Properties

Property	Type	Description
_overrideDisabled	PaletteTripleOverride
_overrideNormal	PaletteTripleOverride
_overridePressed	PaletteTripleOverride
_overrideSelected	PaletteTripleOverride
_overrideTracking	PaletteTripleOverride

Private Properties

Property	Type	Description
OnButtonDragOffset	void
OnButtonDragRectangle	void
OnDragEnd	void
OnDragMove	void
OnDragQuit	void
OnDragStart	void

Public Methods

Method	Description
ButtonSpecFromView ( ViewBase element ) : ButtonSpec	Gets the ButtonSpec associated with the provided item.
GetImage ( PaletteState state ) : Image	Gets the content image.
GetImageTransparentColor ( PaletteState state ) : Color	Gets the image color that should be transparent.
GetLongText ( ) : string	Gets the content long text.
GetShortText ( ) : string	Gets the content short text.
PerformClick ( ) : void	Raises the Click event for the button.
ToString ( ) : string	Obtains the String representation of this instance.
UpdateButtonSpecMapping ( ) : void	Update the button spec manager mapping to reflect current settings.
ViewDrawNavCheckButtonBase ( KryptonNavigator navigator, KryptonPage page, VisualOrientation orientation ) : System	Initialize a new instance of the ViewDrawNavCheckButtonBase class.
ViewDrawNavCheckButtonBase ( KryptonNavigator navigator, KryptonPage page, VisualOrientation orientation, IPaletteTriple stateDisabled, IPaletteTriple stateNormal, IPaletteTriple stateTracking, IPaletteTriple statePressed, IPaletteTriple stateSelected, IPaletteTriple stateFocused ) : System	Initialize a new instance of the ViewDrawNavCheckButtonBase class.
ViewDrawNavCheckButtonBase ( KryptonNavigator navigator, KryptonPage page, VisualOrientation orientation, bool overflow ) : System	Initialize a new instance of the ViewDrawNavCheckButtonBase class.

Protected Methods

Method	Description
CreateMouseController ( ) : IMouseController	Create a mouse controller appropriate for operating this button.
Dispose ( bool disposing ) : void	Release unmanaged and optionally managed resources.
OnClick ( object sender, EventArgs e ) : void	Processes the Click event from the button.
OnNeedPaint ( object sender, NeedLayoutEventArgs e ) : void	Raises the NeedPaint event.
OnRightClick ( object sender, MouseEventArgs e ) : void	Processes the RightClick event from the button.

Private Methods

Method	Description
OnButtonDragOffset ( object sender, ButtonDragOffsetEventArgs e ) : void
OnButtonDragRectangle ( object sender, ButtonDragRectangleEventArgs e ) : void
OnDragEnd ( object sender, PointEventArgs e ) : void
OnDragMove ( object sender, PointEventArgs e ) : void
OnDragQuit ( object sender, EventArgs e ) : void
OnDragStart ( object sender, DragStartEventCancelArgs e ) : void

Method Details

ButtonSpecFromView() public method

Gets the ButtonSpec associated with the provided item.

public ButtonSpecFromView ( ViewBase element ) : ButtonSpec
element	ViewBase	Element to search against.
return	ComponentFactory.Krypton.Toolkit.ButtonSpec

CreateMouseController() protected method

Create a mouse controller appropriate for operating this button.

protected CreateMouseController ( ) : IMouseController
return	IMouseController

Dispose() protected method

Release unmanaged and optionally managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	Called from Dispose method.
return	void

GetImage() public abstract method

Gets the content image.

public abstract GetImage ( PaletteState state ) : Image
state	PaletteState	The state for which the image is needed.
return	Image

GetImageTransparentColor() public method

Gets the image color that should be transparent.

public GetImageTransparentColor ( PaletteState state ) : Color
state	PaletteState	The state for which the image is needed.
return	Color

GetLongText() public abstract method

Gets the content long text.

public abstract GetLongText ( ) : string
return	string

GetShortText() public abstract method

Gets the content short text.

public abstract GetShortText ( ) : string
return	string

OnClick() protected method

Processes the Click event from the button.

protected OnClick ( object sender, EventArgs e ) : void
sender	object	Source of the event.
e	System.EventArgs	An EventArgs containing the event data.
return	void

OnNeedPaint() protected method

Raises the NeedPaint event.

protected OnNeedPaint ( object sender, NeedLayoutEventArgs e ) : void
sender	object	Source of the event.
e	ComponentFactory.Krypton.Toolkit.NeedLayoutEventArgs	An NeedLayoutEventArgs containing event data.
return	void

OnRightClick() protected method

Processes the RightClick event from the button.

protected OnRightClick ( object sender, MouseEventArgs e ) : void
sender	object	Source of the event.
e	MouseEventArgs	An EventArgs containing the event data.
return	void

PerformClick() public method

Raises the Click event for the button.

public PerformClick ( ) : void
return	void

ToString() public method

Obtains the String representation of this instance.

public ToString ( ) : string
return	string

UpdateButtonSpecMapping() public method

Update the button spec manager mapping to reflect current settings.

public UpdateButtonSpecMapping ( ) : void
return	void

ViewDrawNavCheckButtonBase() public method

Initialize a new instance of the ViewDrawNavCheckButtonBase class.

public ViewDrawNavCheckButtonBase ( KryptonNavigator navigator, KryptonPage page, VisualOrientation orientation ) : System
navigator	KryptonNavigator	Owning navigator instance.
page	KryptonPage	Page this check button represents.
orientation	VisualOrientation	Orientation for the check button.
return	System

ViewDrawNavCheckButtonBase() public method

Initialize a new instance of the ViewDrawNavCheckButtonBase class.

public ViewDrawNavCheckButtonBase ( KryptonNavigator navigator, KryptonPage page, VisualOrientation orientation, IPaletteTriple stateDisabled, IPaletteTriple stateNormal, IPaletteTriple stateTracking, IPaletteTriple statePressed, IPaletteTriple stateSelected, IPaletteTriple stateFocused ) : System
navigator	KryptonNavigator	Owning navigator instance.
page	KryptonPage	Page this check button represents.
orientation	VisualOrientation	Orientation for the check button.
stateDisabled	IPaletteTriple	Source for disabled state values.
stateNormal	IPaletteTriple	Source for normal state values.
stateTracking	IPaletteTriple	Source for tracking state values.
statePressed	IPaletteTriple	Source for pressed state values.
stateSelected	IPaletteTriple	Source for selected state values.
stateFocused	IPaletteTriple	Source for focused state values.
return	System

ViewDrawNavCheckButtonBase() public method

Initialize a new instance of the ViewDrawNavCheckButtonBase class.

public ViewDrawNavCheckButtonBase ( KryptonNavigator navigator, KryptonPage page, VisualOrientation orientation, bool overflow ) : System
navigator	KryptonNavigator	Owning navigator instance.
page	KryptonPage	Page this check button represents.
orientation	VisualOrientation	Orientation for the check button.
overflow	bool	Button is used on the overflow bar.
return	System

Property Details

_overrideDisabled protected property

Override for accessing the disable state.

protected PaletteTripleOverride _overrideDisabled
return	PaletteTripleOverride

_overrideNormal protected property

Override for accessing the normal state.

protected PaletteTripleOverride _overrideNormal
return	PaletteTripleOverride

_overridePressed protected property

Override for accessing the pressed state.

protected PaletteTripleOverride _overridePressed
return	PaletteTripleOverride

_overrideSelected protected property

Override for accessing the selected state.

protected PaletteTripleOverride _overrideSelected
return	PaletteTripleOverride

_overrideTracking protected property

Override for accessing the tracking state.

protected PaletteTripleOverride _overrideTracking
return	PaletteTripleOverride