C# Class ComponentFactory.Krypton.Toolkit.ButtonSpec

Inheritance: System.ComponentModel.Component, IButtonSpecValues, ICloneable

Show file Open project: ComponentFactory/Krypton Class Usage Examples

Private Properties

Property	Type	Description
OnImageStateChanged	void
ResetEdge	void
ShouldSerializeColorMap	bool
ShouldSerializeEdge	bool
ShouldSerializeExtraText	bool
ShouldSerializeImage	bool
ShouldSerializeImageStates	bool
ShouldSerializeImageTransparentColor	bool
ShouldSerializeOrientation	bool
ShouldSerializeStyle	bool
ShouldSerializeText	bool
ShouldSerializeToolTipBody	bool
ShouldSerializeToolTipImage	bool
ShouldSerializeToolTipImageTransparentColor	bool
ShouldSerializeToolTipStyle	bool
ShouldSerializeToolTipTitle	bool

Public Methods

Method	Description
ButtonSpec ( ) : System	Initialize a new instance of the ButtonSpec class.
Clone ( ) : object	Make a clone of this object.
CopyFrom ( ButtonSpec source ) : void	Value copy from the provided source to ourself.
GetChecked ( IPalette palette ) : ButtonCheckState	Gets the button checked state.
GetColorMap ( IPalette palette ) : Color	Gets the color to remap from the image to the container foreground.
GetEdge ( IPalette palette ) : RelativeEdgeAlign	Gets the edge for the button.
GetEnabled ( IPalette palette ) : ButtonEnabled	Gets the button enabled state.
GetImage ( IPalette palette, PaletteState state ) : Image	Gets the button image.
GetImageTransparentColor ( IPalette palette ) : Color	Gets the image transparent color.
GetLocation ( IPalette palette ) : HeaderLocation	Gets the button location.
GetLongText ( IPalette palette ) : string	Gets the button long text.
GetOrientation ( IPalette palette ) : ButtonOrientation	Gets the button orienation.
GetShortText ( IPalette palette ) : string	Gets the button short text.
GetStyle ( IPalette palette ) : ButtonStyle	Gets the button style.
GetToolTipTitle ( IPalette palette ) : string	Gets the button tooltip title text.
GetView ( ) : ViewBase	Get the current view associated with the button spec.
GetViewEnabled ( ) : bool	Gets a value indicating if the associated view is enabled.
GetVisible ( IPalette palette ) : bool	Gets the button visible value.
PerformClick ( ) : void	Generates a Click event for the control.
PerformClick ( EventArgs e ) : void	Generates a Click event for the control.
ResetAllowInheritExtraText ( ) : void	Resets the AllowInheritExtraText property to its default value.
ResetAllowInheritImage ( ) : void	Resets the AllowInheritImage property to its default value.
ResetAllowInheritText ( ) : void	Resets the AllowInheritText property to its default value.
ResetAllowInheritToolTipTitle ( ) : void	Resets the AllowInheritToolTipTitle property to its default value.
ResetColorMap ( ) : void	Resets the ColorMap property to its default value.
ResetExtraText ( ) : void	Resets the ExtraText property to its default value.
ResetImage ( ) : void	Resets the Image property to its default value.
ResetImageTransparentColor ( ) : void	Resets the ImageTransparentColor 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.
ResetText ( ) : void	Resets the Text property to its default value.
ResetToolTipBody ( ) : void	Resets the ToolTipBody property to its default value.
ResetToolTipImage ( ) : void	Resets the ToolTipImage property to its default value.
ResetToolTipImageTransparentColor ( ) : void	Resets the ToolTipImageTransparentColor property to its default value.
ResetToolTipStyle ( ) : void	Resets the ToolTipStyle property to its default value.
ResetToolTipTitle ( ) : void	Resets the ToolTipTitle property to its default value.
ResetUniqueName ( ) : void	Resets the UniqueName property to its default value.
SetView ( ViewBase view ) : void	Sets the current view associated with the button spec.
ToString ( ) : string	Returns a string that represents the current defaulted state.

Protected Methods

Method	Description
ConvertToButtonOrientation ( PaletteButtonOrientation paletteButtonOrientation ) : ButtonOrientation	Convert from palette specific button orientation to resolved button orientation.
ConvertToButtonStyle ( PaletteButtonStyle paletteButtonStyle ) : ButtonStyle	Convert from palette specific button style to resolved button style.
ConvertToRelativeEdgeAlign ( PaletteRelativeEdgeAlign paletteRelativeEdgeAlign ) : RelativeEdgeAlign	Convert from palette specific edge alignment to resolved edge alignment.
GenerateClick ( EventArgs e ) : void	Generates the Click event.
OnButtonSpecPropertyChanged ( string propertyName ) : void	Raises the ButtonSpecPropertyChanged event.
OnClick ( EventArgs e ) : void	Raises the Click event.
OnCommandPropertyChanged ( object sender, PropertyChangedEventArgs e ) : void	Handles a change in the property of an attached command.

Private Methods

Method	Description
OnImageStateChanged ( object sender, NeedLayoutEventArgs e ) : void
ResetEdge ( ) : void
ShouldSerializeColorMap ( ) : bool
ShouldSerializeEdge ( ) : bool
ShouldSerializeExtraText ( ) : bool
ShouldSerializeImage ( ) : bool
ShouldSerializeImageStates ( ) : bool
ShouldSerializeImageTransparentColor ( ) : bool
ShouldSerializeOrientation ( ) : bool
ShouldSerializeStyle ( ) : bool
ShouldSerializeText ( ) : bool
ShouldSerializeToolTipBody ( ) : bool
ShouldSerializeToolTipImage ( ) : bool
ShouldSerializeToolTipImageTransparentColor ( ) : bool
ShouldSerializeToolTipStyle ( ) : bool
ShouldSerializeToolTipTitle ( ) : bool

Method Details

ButtonSpec() public method

Initialize a new instance of the ButtonSpec class.

public ButtonSpec ( ) : System
return	System

Clone() public method

Make a clone of this object.

public Clone ( ) : object
return	object

ConvertToButtonOrientation() protected method

Convert from palette specific button orientation to resolved button orientation.

protected ConvertToButtonOrientation ( PaletteButtonOrientation paletteButtonOrientation ) : ButtonOrientation
paletteButtonOrientation	PaletteButtonOrientation	Palette specific button orientation.
return	ButtonOrientation

ConvertToButtonStyle() protected method

Convert from palette specific button style to resolved button style.

protected ConvertToButtonStyle ( PaletteButtonStyle paletteButtonStyle ) : ButtonStyle
paletteButtonStyle	PaletteButtonStyle	Palette specific button style.
return	ButtonStyle

ConvertToRelativeEdgeAlign() protected method

Convert from palette specific edge alignment to resolved edge alignment.

protected ConvertToRelativeEdgeAlign ( PaletteRelativeEdgeAlign paletteRelativeEdgeAlign ) : RelativeEdgeAlign
paletteRelativeEdgeAlign	PaletteRelativeEdgeAlign	Palette specific edge alignment.
return	RelativeEdgeAlign

CopyFrom() public method

Value copy from the provided source to ourself.

public CopyFrom ( ButtonSpec source ) : void
source	ButtonSpec	Source instance.
return	void

GenerateClick() protected method

Generates the Click event.

protected GenerateClick ( EventArgs e ) : void
e	System.EventArgs	An EventArgs containing the event data.
return	void

GetChecked() public abstract method

Gets the button checked state.

public abstract GetChecked ( IPalette palette ) : ButtonCheckState
palette	IPalette	Palette to use for inheriting values.
return	ButtonCheckState

GetColorMap() public method

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

public GetColorMap ( IPalette palette ) : Color
palette	IPalette	Palette to use for inheriting values.
return	Color

GetEdge() public method

Gets the edge for the button.

public GetEdge ( IPalette palette ) : RelativeEdgeAlign
palette	IPalette	Palette to use for inheriting values.
return	RelativeEdgeAlign

GetEnabled() public abstract method

Gets the button enabled state.

public abstract GetEnabled ( IPalette palette ) : ButtonEnabled
palette	IPalette	Palette to use for inheriting values.
return	ButtonEnabled

GetImage() public method

Gets the button image.

public GetImage ( IPalette palette, PaletteState state ) : Image
palette	IPalette	Palette to use for inheriting values.
state	PaletteState	State for which an image is needed.
return	Image

GetImageTransparentColor() public method

Gets the image transparent color.

public GetImageTransparentColor ( IPalette palette ) : Color
palette	IPalette	Palette to use for inheriting values.
return	Color

GetLocation() public method

Gets the button location.

public GetLocation ( IPalette palette ) : HeaderLocation
palette	IPalette	Palette to use for inheriting values.
return	HeaderLocation

GetLongText() public method

Gets the button long text.

public GetLongText ( IPalette palette ) : string
palette	IPalette	Palette to use for inheriting values.
return	string

GetOrientation() public method

Gets the button orienation.

public GetOrientation ( IPalette palette ) : ButtonOrientation
palette	IPalette	Palette to use for inheriting values.
return	ButtonOrientation

GetShortText() public method

Gets the button short text.

public GetShortText ( IPalette palette ) : string
palette	IPalette	Palette to use for inheriting values.
return	string

GetStyle() public method

Gets the button style.

public GetStyle ( IPalette palette ) : ButtonStyle
palette	IPalette	Palette to use for inheriting values.
return	ButtonStyle

GetToolTipTitle() public method

Gets the button tooltip title text.

public GetToolTipTitle ( IPalette palette ) : string
palette	IPalette	Palette to use for inheriting values.
return	string

GetView() public method

Get the current view associated with the button spec.

public GetView ( ) : ViewBase
return	ViewBase

GetViewEnabled() public method

Gets a value indicating if the associated view is enabled.

public GetViewEnabled ( ) : bool
return	bool

GetVisible() public abstract method

Gets the button visible value.

public abstract GetVisible ( IPalette palette ) : bool
palette	IPalette	Palette to use for inheriting values.
return	bool

OnButtonSpecPropertyChanged() protected method

Raises the ButtonSpecPropertyChanged event.

protected OnButtonSpecPropertyChanged ( string propertyName ) : void
propertyName	string	Name of the appearance property that has changed.
return	void

OnClick() protected method

Raises the Click event.

protected OnClick ( EventArgs e ) : void
e	System.EventArgs	An EventArgs containing the event data.
return	void

OnCommandPropertyChanged() protected method

Handles a change in the property of an attached command.

protected OnCommandPropertyChanged ( object sender, PropertyChangedEventArgs e ) : void
sender	object	Source of the event.
e	System.ComponentModel.PropertyChangedEventArgs	A PropertyChangedEventArgs that contains the event data.
return	void

PerformClick() public method

Generates a Click event for the control.

public PerformClick ( ) : void
return	void

PerformClick() public method

Generates a Click event for the control.

public PerformClick ( EventArgs e ) : void
e	System.EventArgs	An EventArgs containing the event data.
return	void

ResetAllowInheritExtraText() public method

Resets the AllowInheritExtraText property to its default value.

public ResetAllowInheritExtraText ( ) : void
return	void

ResetAllowInheritImage() public method

Resets the AllowInheritImage property to its default value.

public ResetAllowInheritImage ( ) : void
return	void

ResetAllowInheritText() public method

Resets the AllowInheritText property to its default value.

public ResetAllowInheritText ( ) : void
return	void

ResetAllowInheritToolTipTitle() public method

Resets the AllowInheritToolTipTitle property to its default value.

public ResetAllowInheritToolTipTitle ( ) : void
return	void

ResetColorMap() public method

Resets the ColorMap property to its default value.

public ResetColorMap ( ) : void
return	void

ResetExtraText() public method

Resets the ExtraText property to its default value.

public ResetExtraText ( ) : void
return	void

ResetImage() public method

Resets the Image property to its default value.

public ResetImage ( ) : void
return	void

ResetImageTransparentColor() public method

Resets the ImageTransparentColor property to its default value.

public ResetImageTransparentColor ( ) : 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

ResetText() public method

Resets the Text property to its default value.

public ResetText ( ) : void
return	void

ResetToolTipBody() public method

Resets the ToolTipBody property to its default value.

public ResetToolTipBody ( ) : void
return	void

ResetToolTipImage() public method

Resets the ToolTipImage property to its default value.

public ResetToolTipImage ( ) : void
return	void

ResetToolTipImageTransparentColor() public method

Resets the ToolTipImageTransparentColor property to its default value.

public ResetToolTipImageTransparentColor ( ) : void
return	void

ResetToolTipStyle() public method

Resets the ToolTipStyle property to its default value.

public ResetToolTipStyle ( ) : void
return	void

ResetToolTipTitle() public method

Resets the ToolTipTitle property to its default value.

public ResetToolTipTitle ( ) : void
return	void

ResetUniqueName() public method

Resets the UniqueName property to its default value.

public ResetUniqueName ( ) : void
return	void

SetView() public method

Sets the current view associated with the button spec.

public SetView ( ViewBase view ) : void
view	ViewBase	View element reference.
return	void

ToString() public method

Returns a string that represents the current defaulted state.

public ToString ( ) : string
return	string