ComponentFactory.Krypton.Toolkit.ButtonSpec.GetImage C# (CSharp) Method

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
        public virtual Image GetImage(IPalette palette, PaletteState state)
        {
            Image image = null;

            // Prefer to get image from the command first
            if (KryptonCommand != null)
                return KryptonCommand.ImageSmall;

            // Try and recover a state specific image
            switch (state)
            {
                case PaletteState.Disabled:
                    image = ImageStates.ImageDisabled;
                    break;
                case PaletteState.Normal:
                    image = ImageStates.ImageNormal;
                    break;
                case PaletteState.Pressed:
                    image = ImageStates.ImagePressed;
                    break;
                case PaletteState.Tracking:
                    image = ImageStates.ImageTracking;
                    break;
                case PaletteState.CheckedNormal:
                    image = ImageStates.ImageCheckedNormal;
                    break;
                case PaletteState.CheckedPressed:
                    image = ImageStates.ImageCheckedPressed;
                    break;
                case PaletteState.CheckedTracking:
                    image = ImageStates.ImageCheckedTracking;
                    break;
            }

            // Default to the image if no state specific image is found
            if (image == null)
                image = Image;

            if ((image != null) || !AllowInheritImage)
                return image;
            else
                return palette.GetButtonSpecImage(_type, state);
        }

Usage Example

 /// <summary>
 /// Gets the content image.
 /// </summary>
 /// <param name="state">The state for which the image is needed.</param>
 /// <returns>Image value.</returns>
 public Image GetImage(PaletteState state)
 {
     // Get value from button spec passing inheritence redirector
     return(_buttonSpec.GetImage(_redirector, state));
 }