C# Class ComponentFactory.Krypton.Toolkit.KryptonPaletteButtonSpecBase

Base class for defining button specifications.

Inheritance: Storage, IPaletteButtonSpec

Datei anzeigen Open project: ComponentFactory/Krypton

Private Properties

Property	Type	Description
KryptonPaletteButtonSpecBase	System

Public Methods

Method	Description
GetButtonSpecColorMap ( PaletteButtonSpecStyle style ) : Color	Gets the color to remap from the image to the container foreground.
GetButtonSpecEdge ( PaletteButtonSpecStyle style ) : PaletteRelativeEdgeAlign	Gets the edge to positon the button against.
GetButtonSpecIcon ( PaletteButtonSpecStyle style ) : Icon	Gets the icon to display for the button.
GetButtonSpecImage ( PaletteButtonSpecStyle style, PaletteState state ) : Image	Gets the image to display for the button.
GetButtonSpecImageTransparentColor ( PaletteButtonSpecStyle style ) : Color	Gets the image transparent color.
GetButtonSpecLocation ( PaletteButtonSpecStyle style ) : HeaderLocation	Get the location for the button.
GetButtonSpecLongText ( PaletteButtonSpecStyle style ) : string	Gets the long text to display for the button.
GetButtonSpecOrientation ( PaletteButtonSpecStyle style ) : PaletteButtonOrientation	Gets the button orientation.
GetButtonSpecShortText ( PaletteButtonSpecStyle style ) : string	Gets the short text to display for the button.
GetButtonSpecStyle ( PaletteButtonSpecStyle style ) : PaletteButtonStyle	Gets the button style used for drawing the button.
GetButtonSpecToolTipTitle ( PaletteButtonSpecStyle style ) : string	Gets the tooltip title text to display for the button.
PopulateFromBase ( PaletteButtonSpecStyle style ) : void	Populate values from the base palette.
ResetEdge ( ) : void	Resets the Edge property to its default value.
ResetOrientation ( ) : void	Resets the Orientation property to its default value.
ResetStyle ( ) : void	Resets the Style property to its default value.
SetRedirector ( PaletteRedirect redirect ) : void	Update the redirector with new reference.

Protected Methods

Method	Description
OnButtonSpecChanged ( object sender, EventArgs e ) : void	Raises the ButtonSpecChanged event.

Private Methods

Method	Description
KryptonPaletteButtonSpecBase ( PaletteRedirect redirector ) : System	Initialize a new instance of the KryptonPaletteButtonSpecBase class.

Method Details

GetButtonSpecColorMap() public method

Gets the color to remap from the image to the container foreground.

public GetButtonSpecColorMap ( PaletteButtonSpecStyle style ) : Color
style	PaletteButtonSpecStyle	Style of button spec.
return	Color

GetButtonSpecEdge() public method

Gets the edge to positon the button against.

public GetButtonSpecEdge ( PaletteButtonSpecStyle style ) : PaletteRelativeEdgeAlign
style	PaletteButtonSpecStyle	Style of button spec.
return	PaletteRelativeEdgeAlign

GetButtonSpecIcon() public method

Gets the icon to display for the button.

public GetButtonSpecIcon ( PaletteButtonSpecStyle style ) : Icon
style	PaletteButtonSpecStyle	Style of button spec.
return	System.Drawing.Icon

GetButtonSpecImage() public method

Gets the image to display for the button.

public GetButtonSpecImage ( PaletteButtonSpecStyle style, PaletteState state ) : Image
style	PaletteButtonSpecStyle	Style of button spec.
state	PaletteState	State for which image is required.
return	Image

GetButtonSpecImageTransparentColor() public method

Gets the image transparent color.

public GetButtonSpecImageTransparentColor ( PaletteButtonSpecStyle style ) : Color
style	PaletteButtonSpecStyle	Style of button spec.
return	Color

GetButtonSpecLocation() public method

Get the location for the button.

public GetButtonSpecLocation ( PaletteButtonSpecStyle style ) : HeaderLocation
style	PaletteButtonSpecStyle	Style of button spec.
return	HeaderLocation

GetButtonSpecLongText() public method

Gets the long text to display for the button.

public GetButtonSpecLongText ( PaletteButtonSpecStyle style ) : string
style	PaletteButtonSpecStyle	Style of button spec.
return	string

GetButtonSpecOrientation() public method

Gets the button orientation.

public GetButtonSpecOrientation ( PaletteButtonSpecStyle style ) : PaletteButtonOrientation
style	PaletteButtonSpecStyle	Style of button spec.
return	PaletteButtonOrientation

GetButtonSpecShortText() public method

Gets the short text to display for the button.

public GetButtonSpecShortText ( PaletteButtonSpecStyle style ) : string
style	PaletteButtonSpecStyle	Style of button spec.
return	string

GetButtonSpecStyle() public method

Gets the button style used for drawing the button.

public GetButtonSpecStyle ( PaletteButtonSpecStyle style ) : PaletteButtonStyle
style	PaletteButtonSpecStyle	Style of button spec.
return	PaletteButtonStyle

GetButtonSpecToolTipTitle() public method

Gets the tooltip title text to display for the button.

public GetButtonSpecToolTipTitle ( PaletteButtonSpecStyle style ) : string
style	PaletteButtonSpecStyle	Style of button spec.
return	string

OnButtonSpecChanged() protected method

Raises the ButtonSpecChanged event.

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

PopulateFromBase() public method

Populate values from the base palette.

public PopulateFromBase ( PaletteButtonSpecStyle style ) : void
style	PaletteButtonSpecStyle	The style of the button spec instance.
return	void

ResetEdge() public method

Resets the Edge property to its default value.

public ResetEdge ( ) : void
return	void

ResetOrientation() public method

Resets the Orientation property to its default value.

public ResetOrientation ( ) : void
return	void

ResetStyle() public method

Resets the Style property to its default value.

public ResetStyle ( ) : void
return	void

SetRedirector() public method

Update the redirector with new reference.

public SetRedirector ( PaletteRedirect redirect ) : void
redirect	PaletteRedirect	Target redirector.
return	void