Skip to content

Fixing/clarifying XML comments for ScreenCaptureMode and VB's ColorMode. #14074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −11
Open

Fixing/clarifying XML comments for ScreenCaptureMode and VB's ColorMode. #14074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ....Forms/src/Microsoft/VisualBasic/ApplicationServices/ApplyApplicationDefaultsEventArgs.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Namespace Microsoft.VisualBasic.ApplicationServices
End Sub

''' <summary>
''' Setting this property inside the event handler determines the
''' <see cref="Application.ColorMode"/> for the application.
''' Setting this property inside the event handler determines the application's
''' <see cref="Application.ColorMode"/>. Use this property to control whether the application
''' uses dark mode, classic mode, or system default for its lifecycle.
''' </summary>
Public Property ColorMode As SystemColorMode

Expand Down
16 changes: 7 additions & 9 deletions src/System.Windows.Forms/System/Windows/Forms/ScreenCaptureMode.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,25 @@
namespace System.Windows.Forms;

/// <summary>
/// Enumeration defining the behavior when a form or control is captured in a screenshot.
/// Enumeration defining the behavior when a form is attempted to be captured in a screen capture (clipboard, image file),
/// in a screen sharing video conference scenario, a video recording or the alike.
Comment on lines +7 to +8
Copy link
Member

@Shyam-Gupta Shyam-Gupta Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It appears a bit convoluted. Consider:
An enumeration specifying the behavior of a form when an attempt is made to capture it via screenshot, clipboard, image export, screen-sharing during a video conference, video recording, or similar methods.

/// </summary>
public enum ScreenCaptureMode
{
/// <summary>
/// The form or control can be captured normally in screenshots. Default.
/// The form can be captured normally in screen captures.
/// Default setting.
Copy link

@adegeo adegeo Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default shouldn't be specified here, it should be specified on the property using this enum.

/// </summary>
Allow = 0,

/// <summary>
/// The form or control appears blacked out in screenshots.
/// Only the form's content is hidden in screenshots.
/// The form's borders and title bar remain visible.
/// </summary>
HideContent = 1,

/// <summary>
/// The form or control appears blurred in screenshots.
/// The whole form is invisible in screenshots.
/// </summary>
/// <remarks>
/// <para>
/// Using this option requires Windows 10 version 2004 or higher.
/// </para>
/// </remarks>
HideWindow = 2
}