C# Class ComponentFactory.Krypton.Navigator.HeaderGroupMappingBase

Base class for storage and mapping of navigator header values.
Inheritance: ComponentFactory.Krypton.Toolkit.HeaderValuesBase
Show file Open project: ComponentFactory/Krypton

Private Properties

Property Type Description
ShouldSerializeMapDescription bool
ShouldSerializeMapHeading bool
ShouldSerializeMapImage bool

Public Methods

Method Description
GetImage ( PaletteState state ) : Image

Gets the content image.
GetLongText ( ) : string

Gets the content long text.
GetShortText ( ) : string

Gets the content short text.
HeaderGroupMappingBase ( KryptonNavigator navigator, NeedPaintHandler needPaint ) : System

Initialize a new instance of the HeaderGroupMappingBase class.
ResetMapDescription ( ) : void

Resets the MapDescription property to its default value.
ResetMapHeading ( ) : void

Resets the MapHeading property to its default value.
ResetMapImage ( ) : void

Resets the MapImage property to its default value.

Protected Methods

Method Description
GetImageDefault ( ) : Image

Gets the default image value.
GetMapDescriptionDefault ( ) : MapKryptonPageText

Gets the default description mapping value.
GetMapHeadingDefault ( ) : MapKryptonPageText

Gets the default heading mapping value.
GetMapImageDefault ( ) : MapKryptonPageImage

Gets the default image mapping value.

Private Methods

Method Description
ShouldSerializeMapDescription ( ) : bool
ShouldSerializeMapHeading ( ) : bool
ShouldSerializeMapImage ( ) : bool

Method Details

GetImage() public method

Gets the content image.
public GetImage ( PaletteState state ) : Image
state PaletteState State for which the image is needed.
return Image

GetImageDefault() protected method

Gets the default image value.
protected GetImageDefault ( ) : Image
return Image

GetLongText() public method

Gets the content long text.
public GetLongText ( ) : string
return string

GetMapDescriptionDefault() protected abstract method

Gets the default description mapping value.
protected abstract GetMapDescriptionDefault ( ) : MapKryptonPageText
return MapKryptonPageText

GetMapHeadingDefault() protected abstract method

Gets the default heading mapping value.
protected abstract GetMapHeadingDefault ( ) : MapKryptonPageText
return MapKryptonPageText

GetMapImageDefault() protected abstract method

Gets the default image mapping value.
protected abstract GetMapImageDefault ( ) : MapKryptonPageImage
return MapKryptonPageImage

GetShortText() public method

Gets the content short text.
public GetShortText ( ) : string
return string

HeaderGroupMappingBase() public method

Initialize a new instance of the HeaderGroupMappingBase class.
public HeaderGroupMappingBase ( KryptonNavigator navigator, NeedPaintHandler needPaint ) : System
navigator KryptonNavigator Reference to owning navogator instance.
needPaint NeedPaintHandler Delegate for notifying paint requests.
return System

ResetMapDescription() public method

Resets the MapDescription property to its default value.
public ResetMapDescription ( ) : void
return void

ResetMapHeading() public method

Resets the MapHeading property to its default value.
public ResetMapHeading ( ) : void
return void

ResetMapImage() public method

Resets the MapImage property to its default value.
public ResetMapImage ( ) : void
return void