[Breaking Changes] Fix FrameShow enum #418
Merged
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.
🚨 This contains breaking changes 🚨
A few improvements to the
FrameShow
enum. Hopefully the breaking changes won't actually affect anyone. 🤞It was marked with the
[Flags]
attribute. The underlying__FRAMESHOW
enum is not flagged.There was a redundant
Unknown
member with a value of zero. That is equivalent to bothFRAMESHOW_Hidden
andFRAMESHOW_WinHidden
. I've removedUnknown
. This is a breaking change.FRAMESHOW_Hidden
is documented as being obsolete and has the same value asFRAMESHOW_WinHidden
. I've removedWinHidden
rather thanHidden
because there is no correspondingWinShown
value (but there is aShown
value). This is a breaking change.I've added enum values for
__FRAMESHOW2
,__FRAMESHOW3
and__FRAMESHOW4
.I've added a comment to the
<summary>
tag that specifies the underlying enum value. When I was trying to understand which value I should be using, I found myself searching the web for examples. First I had to discover the Visual Studio enum thatFrameShow
is actually wrapping, and then find the corresponding enum member name. It would have been much easier if it was all available in the documentation comments.ℹ️ One thing about the documentation comments that I noticed - when the enum is used within the same solution as the toolkit, intellisense actually shows the value assigned to the enum, like so:
But when you're referencing the actual NuGet packages, intellisense only tells you the numeric value:
Hence why I've added the underlying enum member to the documentation. 😄