Clarify DialogHost.Close parameter documentation #3990
+1
−1
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
The documentation for DialogHost.Close(...) described the `parameter` argument as being "to provide to close handler", which is misleading and incomplete. Internally, DialogHost.Close forwards the value directly to DialogSession.Close(parameter). In DialogSession.Close, the parameter is correctly documented as the dialog result value, which is returned by DialogHost.Show(...) and exposed through DialogClosingEventArgs.Parameter. This change aligns the DialogHost.Close documentation with the existing DialogSession.Close documentation, making it clear that the parameter represents the dialog result and is not solely intended for close handlers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The documentation for DialogHost.Close(...) described the
parameterargument as being "to provide to close handler", which is misleading and incomplete.Internally, DialogHost.Close forwards the value directly to DialogSession.Close(parameter). In DialogSession.Close, the parameter is correctly documented as the dialog result value, which is returned by DialogHost.Show(...) and exposed through DialogClosingEventArgs.Parameter.
This change aligns the DialogHost.Close documentation with the existing DialogSession.Close documentation, making it clear that the parameter represents the dialog result and is not solely intended for close handlers.