BrightnessOverride.SetBrightnessScenario Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Sets the brightness level, by specifying a scenario that has a well-known brightness level, and the override options of the brightness override.
public:
virtual void SetBrightnessScenario(DisplayBrightnessScenario scenario, DisplayBrightnessOverrideOptions options) = SetBrightnessScenario;void SetBrightnessScenario(DisplayBrightnessScenario const& scenario, DisplayBrightnessOverrideOptions const& options);public void SetBrightnessScenario(DisplayBrightnessScenario scenario, DisplayBrightnessOverrideOptions options);function setBrightnessScenario(scenario, options)Public Sub SetBrightnessScenario (scenario As DisplayBrightnessScenario, options As DisplayBrightnessOverrideOptions)Parameters
- scenario
- DisplayBrightnessScenario
A scenario that has a well-known brightness level.
- options
- DisplayBrightnessOverrideOptions
Options that modify the brightness level of the screen during the brightness override session.
Examples
/* Set the display brightness to a level that is optimum for reading barcodes. If the device is on low battery during overriding, allow the display to dim*/
bo.SetBrightnessScenario(DisplayBrightnessScenario.BarcodeReadingBrightness, DisplayBrightnessOverrideOptions.UseDimmedPolicyWhenBatteryIsLow);