GraphicsCaptureSession.IsBorderRequired Property

Definition

Namespace:

Windows.Graphics.Capture

Gets or sets a value specifying whether the capture operation requires a colored border around the window or display to indicate that a capture is in progress.

public:
 property bool IsBorderRequired { bool get(); void set(bool value); };

bool IsBorderRequired();

void IsBorderRequired(bool value);

public bool IsBorderRequired { get; set; }

var boolean = graphicsCaptureSession.isBorderRequired;
graphicsCaptureSession.isBorderRequired = boolean;

Public Property IsBorderRequired As Boolean

Property Value

Boolean

bool

true if the border is required; otherwise, false.

Windows requirements

Device family	Windows 10, version 2104 (introduced in 10.0.20348.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v12.0)

Remarks

Before the system will disable the colored border around the a window or display that is being captured, your app must get consent from the user by calling GraphicsCaptureAccess.RequestAccessAsync, passing in the value GraphicsCaptureAccessKind.Borderless, which displays a prompt to the user. If the user denies access, setting this property to false will succeed, but the value will be ignored and the border will be displayed during subsequent captured. To call RequestAccessAsync with GraphicsCaptureAccessKind.Borderless, you must declare the graphicsCaptureWithoutBorder capability in your app's package manifest. For more information, see App capability declarations.

Note that if the IsBorderRequired property is set to true for the same window or display by other apps on the device, the border will be displayed.