Add in-memory image support and contextual help to RibbonExtensions #11
Conversation
This file contains hidden or 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
Introduced a new method `SetContextualHelp` for the `RibbonItem` class, enabling the assignment of contextual help via a URL. Comprehensive XML documentation has been added to clarify its purpose, parameters, return value, and provide usage examples.
This commit introduces several using directives for WPF and image handling namespaces, enabling the use of WPF features in the Ribbon UI. A new private static method, `ConvertToImageSource`, is added to the `RibbonExtensions` class to convert `System.Drawing.Bitmap` to a WPF `ImageSource`, suitable for button icons. XML documentation comments are included for clarity. The existing code structure remains unchanged.
Implemented two new methods, `SetImage` and `SetLargeImage`, for the `RibbonExtensions` class. These methods enable setting images for Ribbon buttons using in-memory `System.Drawing.Bitmap` objects. Comprehensive XML documentation has been added for both methods, detailing their purpose, parameters, return values, remarks, and usage examples.
Updated `Nice3point.Revit.Extensions.csproj` to include a new package reference for `System.Drawing.Common` version `8.0.8` in the `<ItemGroup>` section.
Eliminated the `using System.Windows.Media.Imaging;` directive to clean up unused namespaces and avoid potential conflicts in the context of Revit 2024 or greater.
Clarified that the method converts a System.Drawing.Bitmap to a WPF-compatible BitmapSource. Updated parameter and return type descriptions, and added remarks about unmanaged HBITMAP handling. Changed the method signature to return BitmapSource instead of ImageSource for better specificity.
Author
|
Hi @Nice3point, could you take a look at this pull request? |
Owner
|
I see you are trying to add support for |
Author
Thanks, @Nice3point . Quick clarification:
Intent: enable scenarios where icons are produced at runtime or come from streams/embedded data and are already available as |
Owner
|
Give me an example with a Bitmap and where BitmapImage is not enough |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the Pull Request
What is this about:
Add in-memory image support and contextual help to RibbonExtensions
Description:
This PR introduces new features and improvements to the Ribbon extensions for Revit:
SetImage(Bitmap)andSetLargeImage(Bitmap)methods to apply 16x16 and 32x32 icons directly fromSystem.Drawing.Bitmap.BitmapSource, enabling runtime or embedded resource icons.SetContextualHelp(string url)method to quickly associate documentation or support pages with Ribbon buttons.System.Drawing.Commondependency to the project.ConvertToImageSource()helper for safe and efficient GDI+ to WPF conversion.These additions make Revit UI customization more flexible and dynamic, supporting both runtime-generated icons and integrated online help.
Quality Checklist