-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1908-V95-KDGV-Column-indicator-image-class-KryptonDataGridViewUtilities
Adds KryptonDataGridViewCellIndicatorImage.cs Adds KryptonDataGridViewUtilities.cs
- Loading branch information
Showing
2 changed files
with
245 additions
and
0 deletions.
There are no files selected for viewing
169 changes: 169 additions & 0 deletions
169
...pton Components/Krypton.Toolkit/Controls Toolkit/KryptonDataGridViewCellIndicatorImage.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| #region BSD License | ||
| /* | ||
| * New BSD 3-Clause License (https://github.com/Krypton-Suite/Standard-Toolkit/blob/master/LICENSE) | ||
| * Modifications by Peter Wagner (aka Wagnerp), Simon Coghlan (aka Smurf-IV), Giduac & Ahmed Abdelhameed et al. 2017 - 2025. All rights reserved. | ||
| * | ||
| */ | ||
| #endregion | ||
|
|
||
| namespace Krypton.Toolkit | ||
| { | ||
| /// <summary> | ||
| /// This class is used within advanved columns that make use of embedded controls. | ||
| /// </summary> | ||
| [ToolboxItem(false)] | ||
| internal class KryptonDataGridViewCellIndicatorImage : IDisposable | ||
| { | ||
| #region Fields | ||
| // Cell indicator image | ||
| private Image? _image = null; | ||
| // Size of the image which is always square | ||
| private int _size; | ||
| // Datagridview the column belongs to. | ||
| private KryptonDataGridView? _dataGridView; | ||
| // State of disposal | ||
| private bool _disposed = false; | ||
|
|
||
| // type and state of the image | ||
| private PaletteRibbonGalleryButton _paletteRibbonGalleryButton = PaletteRibbonGalleryButton.Down; | ||
| private PaletteState _paletteState = PaletteState.Normal; | ||
| #endregion Fields | ||
|
|
||
| #region Identity | ||
| /// <summary> | ||
| /// Default constructor. | ||
| /// </summary> | ||
| /// <param name="imageSize">The image size in pixels. Which will always be used to square the image. Default is 14.</param> | ||
| public KryptonDataGridViewCellIndicatorImage(int imageSize = 14) | ||
| { | ||
| _size = imageSize; | ||
|
|
||
| UpdateCellIndicatorImage(true); | ||
| KryptonManager.GlobalPaletteChanged += OnKryptonManagerGlobalPaletteChanged; | ||
| } | ||
| #endregion Identity | ||
|
|
||
| #region Public | ||
| /// <summary> | ||
| /// Reference to the column's DataGridView.<br/> | ||
| /// Set this property via the column's 'protected override void OnDataGridViewChanged()'. | ||
| /// </summary> | ||
| public KryptonDataGridView? DataGridView | ||
| { | ||
| get => _dataGridView; | ||
|
|
||
| set | ||
| { | ||
| if (_dataGridView != value) | ||
| { | ||
| if (_dataGridView is not null) | ||
| { | ||
| _dataGridView.PaletteChanged -= OnDataGridViewPaletteChanged; | ||
| } | ||
|
|
||
| _dataGridView = value; | ||
|
|
||
| if (_dataGridView is not null) | ||
| { | ||
| _dataGridView.PaletteChanged += OnDataGridViewPaletteChanged; | ||
| UpdateCellIndicatorImage(false); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Cell indicator image. | ||
| /// </summary> | ||
| public virtual Image? Image => _image; | ||
|
|
||
| /// <inheritdoc/>> | ||
| public void Dispose() | ||
| { | ||
| Dispose(true); | ||
| } | ||
|
|
||
| /// <inheritdoc cref="Dispose()"/> | ||
| public void Dispose(bool disposing) | ||
| { | ||
| // If the column is disposed at runtime the eventhandlers need to unsubscribe from the grid and kmananger | ||
| try | ||
| { | ||
| if (!_disposed && disposing) | ||
| { | ||
| // Since the DataGridView property is controlled internally, | ||
| // use the cached reference to unsubscribe from the event | ||
| if (_dataGridView is not null) | ||
| { | ||
| _dataGridView.PaletteChanged -= OnDataGridViewPaletteChanged; | ||
| } | ||
|
|
||
| KryptonManager.GlobalPaletteChanged -= OnKryptonManagerGlobalPaletteChanged; | ||
| _dataGridView = null; | ||
|
|
||
| _disposed = true; | ||
| } | ||
| } | ||
| catch { } | ||
| } | ||
| #endregion Public | ||
|
|
||
| #region Private | ||
| /// <summary> | ||
| /// Subscribe this handler to: KryptonDataGridView.PaletteChanged | ||
| /// </summary> | ||
| /// <param name="sender">Not used.</param> | ||
| /// <param name="e">Not used.</param> | ||
| private void OnDataGridViewPaletteChanged(object? sender, EventArgs e) => UpdateCellIndicatorImage(false); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe this handler to: KryptonManager.GlobalPaletteChanged | ||
| /// </summary> | ||
| /// <param name="sender">Not used.</param> | ||
| /// <param name="e">Not used.</param> | ||
| private void OnKryptonManagerGlobalPaletteChanged(object? sender, EventArgs e) => UpdateCellIndicatorImage(true); | ||
|
|
||
| /// <summary> | ||
| /// Updates the cell indicator image based on the source from where the theme change originated. | ||
| /// </summary> | ||
| /// <param name="updateFromKryptonManager">True if KryptonManager fired the theme change, otherwise from KryptonDataGridView.</param> | ||
| private void UpdateCellIndicatorImage(bool updateFromKryptonManager) | ||
| { | ||
| if (updateFromKryptonManager) | ||
| { | ||
| // Probably the case used most, so first to check. | ||
| _image = KryptonManager.CurrentGlobalPalette.GetGalleryButtonImage(_paletteRibbonGalleryButton, _paletteState)!; | ||
| ResizeCellIndicatorImage(); | ||
| } | ||
| else if (DataGridView is KryptonDataGridView dataGridView) | ||
| { | ||
| if (dataGridView.Palette is not null && dataGridView.PaletteMode == PaletteMode.Custom) | ||
| { | ||
| // The grid has a custom palette instance assigned to it and PaletteMode is Custom | ||
| _image = dataGridView.Palette.GetGalleryButtonImage(_paletteRibbonGalleryButton, _paletteState); | ||
| } | ||
| else | ||
| { | ||
| // Fetch through KryptonManager using the locally set palette mode | ||
| _image = KryptonManager | ||
| .GetPaletteForMode(dataGridView.PaletteMode) | ||
| .GetGalleryButtonImage(_paletteRibbonGalleryButton, _paletteState)!; | ||
| } | ||
|
|
||
| ResizeCellIndicatorImage(); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// This method may only be used by UpdateCellIndicatorImage() | ||
| /// </summary> | ||
| private void ResizeCellIndicatorImage() | ||
| { | ||
| if (_image is not null && (_image.Width != _size || _image.Height != _size)) | ||
| { | ||
| _image = new Bitmap(_image, _size, _size); | ||
| } | ||
| } | ||
| #endregion Private | ||
| } | ||
| } |
76 changes: 76 additions & 0 deletions
76
Source/Krypton Components/Krypton.Toolkit/Controls Toolkit/KryptonDataGridViewUtilities.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| #region BSD License | ||
| /* | ||
| * New BSD 3-Clause License (https://github.com/Krypton-Suite/Standard-Toolkit/blob/master/LICENSE) | ||
| * Modifications by Peter Wagner (aka Wagnerp), Simon Coghlan (aka Smurf-IV), Giduac & Ahmed Abdelhameed et al. 2024 - 2025. All rights reserved. | ||
| * | ||
| */ | ||
| #endregion | ||
|
|
||
| namespace Krypton.Toolkit | ||
| { | ||
|
|
||
| internal class KryptonDataGridViewUtilities | ||
| { | ||
| internal static class TextFormatFlagsCellStyleAlignments | ||
| { | ||
| // Calculate these once for use in ComputeTextFormatFlagsForCellStyleAlignment() | ||
| private const TextFormatFlags baseMask = TextFormatFlags.NoPrefix | TextFormatFlags.PreserveGraphicsClipping; | ||
|
|
||
| internal const TextFormatFlags TopLeft_RightToLeft = baseMask | TextFormatFlags.Top | TextFormatFlags.Right | TextFormatFlags.RightToLeft; | ||
| internal const TextFormatFlags TopLeft_LeftToRight = baseMask | TextFormatFlags.Top | TextFormatFlags.Left; | ||
| internal const TextFormatFlags TopCenter = baseMask | TextFormatFlags.Top | TextFormatFlags.HorizontalCenter; | ||
| internal const TextFormatFlags TopRight_RightToLeft = baseMask | TextFormatFlags.Top | TextFormatFlags.Left | TextFormatFlags.RightToLeft; | ||
| internal const TextFormatFlags TopRight_LeftToRight = baseMask | TextFormatFlags.Top | TextFormatFlags.Right; | ||
|
|
||
| internal const TextFormatFlags MiddleLeft_RightToLeft = baseMask | TextFormatFlags.VerticalCenter | TextFormatFlags.Right | TextFormatFlags.RightToLeft; | ||
| internal const TextFormatFlags MiddleLeft_LeftToRight = baseMask | TextFormatFlags.VerticalCenter | TextFormatFlags.Left; | ||
| internal const TextFormatFlags MiddleCenter = baseMask | TextFormatFlags.VerticalCenter | TextFormatFlags.HorizontalCenter; | ||
| internal const TextFormatFlags MiddleRight_RightToLeft = baseMask | TextFormatFlags.VerticalCenter | TextFormatFlags.Left | TextFormatFlags.RightToLeft; | ||
| internal const TextFormatFlags MiddleRight_LeftToRight = baseMask | TextFormatFlags.VerticalCenter | TextFormatFlags.Right; | ||
|
|
||
| internal const TextFormatFlags BottomLeft_RightToLeft = baseMask | TextFormatFlags.Bottom | TextFormatFlags.Right | TextFormatFlags.RightToLeft; | ||
| internal const TextFormatFlags BottomLeft_LeftToRight = baseMask | TextFormatFlags.Bottom | TextFormatFlags.Left; | ||
| internal const TextFormatFlags BottomCenter = baseMask | TextFormatFlags.Bottom | TextFormatFlags.HorizontalCenter; | ||
| internal const TextFormatFlags BottomRight_RightToLeft = baseMask | TextFormatFlags.Bottom | TextFormatFlags.Left | TextFormatFlags.RightToLeft; | ||
| internal const TextFormatFlags BottomRight_Lefttoright = baseMask | TextFormatFlags.Bottom | TextFormatFlags.Right; | ||
|
|
||
| internal const TextFormatFlags DefaultAlignment = baseMask | TextFormatFlags.HorizontalCenter | TextFormatFlags.VerticalCenter; | ||
| } | ||
|
|
||
| internal static TextFormatFlags ComputeTextFormatFlagsForCellStyleAlignment( | ||
| bool rightToLeft, | ||
| DataGridViewContentAlignment alignment, | ||
| DataGridViewTriState wrapMode) | ||
| { | ||
| // This routine has been copied from the dotnet winforms project and slightly rewritten to reduce computing masks | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| TextFormatFlags tff = alignment switch | ||
| { | ||
| DataGridViewContentAlignment.TopLeft when rightToLeft => TextFormatFlagsCellStyleAlignments.TopLeft_RightToLeft, | ||
| DataGridViewContentAlignment.TopLeft when !rightToLeft => TextFormatFlagsCellStyleAlignments.TopLeft_LeftToRight, | ||
| DataGridViewContentAlignment.TopCenter => TextFormatFlagsCellStyleAlignments.TopCenter, | ||
| DataGridViewContentAlignment.TopRight when rightToLeft => TextFormatFlagsCellStyleAlignments.TopRight_RightToLeft, | ||
| DataGridViewContentAlignment.TopRight when !rightToLeft => TextFormatFlagsCellStyleAlignments.TopRight_LeftToRight, | ||
|
|
||
| DataGridViewContentAlignment.MiddleLeft when rightToLeft => TextFormatFlagsCellStyleAlignments.MiddleLeft_RightToLeft, | ||
| DataGridViewContentAlignment.MiddleLeft when !rightToLeft => TextFormatFlagsCellStyleAlignments.MiddleLeft_LeftToRight, | ||
| DataGridViewContentAlignment.MiddleCenter => TextFormatFlagsCellStyleAlignments.MiddleCenter, | ||
| DataGridViewContentAlignment.MiddleRight when rightToLeft => TextFormatFlagsCellStyleAlignments.MiddleRight_RightToLeft, | ||
| DataGridViewContentAlignment.MiddleRight when !rightToLeft => TextFormatFlagsCellStyleAlignments.MiddleRight_LeftToRight, | ||
|
|
||
| DataGridViewContentAlignment.BottomLeft when rightToLeft => TextFormatFlagsCellStyleAlignments.BottomLeft_RightToLeft, | ||
| DataGridViewContentAlignment.BottomLeft when !rightToLeft => TextFormatFlagsCellStyleAlignments.BottomLeft_LeftToRight, | ||
| DataGridViewContentAlignment.BottomCenter => TextFormatFlagsCellStyleAlignments.BottomCenter, | ||
| DataGridViewContentAlignment.BottomRight when rightToLeft => TextFormatFlagsCellStyleAlignments.BottomRight_RightToLeft, | ||
| DataGridViewContentAlignment.BottomRight when !rightToLeft => TextFormatFlagsCellStyleAlignments.BottomRight_Lefttoright, | ||
| _ => TextFormatFlagsCellStyleAlignments.DefaultAlignment | ||
| }; | ||
|
|
||
| return tff | (wrapMode == DataGridViewTriState.False | ||
| ? TextFormatFlags.SingleLine | ||
| : TextFormatFlags.WordBreak); | ||
|
|
||
| } | ||
| } | ||
| } |