diff --git a/windows.applicationmodel.activation/activationkind.md b/windows.applicationmodel.activation/activationkind.md index 5572bdd09c..f000f41aa7 100644 --- a/windows.applicationmodel.activation/activationkind.md +++ b/windows.applicationmodel.activation/activationkind.md @@ -124,8 +124,14 @@ Reserved for system use. Introduced in Windows 10, version 1703 (10.0.15063). ### -field PrintWorkflowForegroundTask:1018 This app was activated because the user is printing to a printer that has a Print Workflow Application associated with it which has requested user input. Prerelease. -### -field Console:1019 -The app was launched because it was activated from the command line. Prerelease. +### -field GameUIProvider:1019 + + +### -field StartupTask:1020 + + +### -field CommandLineLaunch:1021 +The app was launched from the command line. Prerelease. ## -remarks diff --git a/windows.applicationmodel.activation/commandlineactivatedeventargs.md b/windows.applicationmodel.activation/commandlineactivatedeventargs.md new file mode 100644 index 0000000000..b69c9da472 --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivatedeventargs.md @@ -0,0 +1,69 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs + +## -description +Provides information, such as the command-line arguments, when an app is activated from the command line. + +## -remarks +A UWP app may be activated from **Start|Run** in Windows, from the command line in PowerShell, the DOS command prompt, or from another Win32 process that calls [CreateProcess()](https://msdn.microsoft.com/library/windows/desktop/ms682425.aspx). + +To be activated from the command line, your app must register for the "AppExecutionAlias" extension category in its manifest. + +```xml + + + + + +``` +After you register in your manifest, your app can be activated from the command line. When your app is activated, you can use the event information to identify the call activation and extract the parameters that help you complete the call for the user. + +## -examples +Here is an example of handling a command-line launch: + +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ +    string activationArgString = string.Empty; +    string activationPath = string.Empty; +    string cmdLineString = string.Empty; +     + // Existing behavior to differentiate different activation kinds, +    // and to extract any argument payload. +    switch (args.Kind) +    { + case ActivationKind.Launch: +         var launchArgs = args as LaunchActivatedEventArgs; +         activationArgString = launchArgs.Arguments; +         break; + + // A new ActivationKind for console activation of a windowed app. +        case ActivationKind.CommandLineLaunch: +            CommandLineActivatedEventArgs cmdLineArgs = args as CommandLineActivatedEventArgs; +            CommandLineActivationOperation operation = cmdLineArgs.Operation; +            cmdLineString = operation.Arguments; +            activationPath = operation.CurrentDirectoryPath; +            break; +    } + +    // Parse the trusted activation arguments. +    ParseTrustedArgs(activationArgString); + +    // Parse the untrusted command-line arguments. +    ParseUntrustedArgs(activationPath, cmdLineString); + +    // Since we did not take a deferral, the calling app gets the result +    // as soon as this method returns. Since we did not set an exit code, +    // the calling app gets a default exit code as the result. +}     +``` + +## -see-also diff --git a/windows.applicationmodel.activation/commandlineactivatedeventargs_kind.md b/windows.applicationmodel.activation/commandlineactivatedeventargs_kind.md new file mode 100644 index 0000000000..a6daa80bea --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivatedeventargs_kind.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.Kind + +## -description +Gets the type of activation that launched the app. + +## -property-value +The activation kind. + +## -remarks +The expected value is **ActivationKind.CommandLineLaunch**. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivatedeventargs_operation.md b/windows.applicationmodel.activation/commandlineactivatedeventargs_operation.md new file mode 100644 index 0000000000..c7b3004f2d --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivatedeventargs_operation.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.Operation + +## -description +Gets info about the activation of the app such as what arguments were provided and the current directory path. + +## -property-value +The activation info. + +## -remarks +The app supplies the exit code which is passed back to the caller. + +## -see-also +[CommandLineActivatedEventArgs.Operation](commandlineactivatedeventargs_operation.md) + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/commandlineactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..2b50bb92cd --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state before the app was activated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/commandlineactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..9c2445f999 --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivatedeventargs_splashscreen.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.SplashScreen + +## -description +Gets info about the transition from the splash screen to the activated app. + +## -property-value +The splash screen transition info. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivatedeventargs_user.md b/windows.applicationmodel.activation/commandlineactivatedeventargs_user.md new file mode 100644 index 0000000000..ef79f6fa71 --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivatedeventargs_user.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivationoperation.md b/windows.applicationmodel.activation/commandlineactivationoperation.md new file mode 100644 index 0000000000..57b8cdc36a --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivationoperation.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.CommandLineActivationOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivationOperation + +## -description +Provides info about the activation of the app such as what arguments were provided and the current directory path. + +## -remarks +The app supplies the exit code which is passed back to the caller. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivationoperation_arguments.md b/windows.applicationmodel.activation/commandlineactivationoperation_arguments.md new file mode 100644 index 0000000000..89163b493d --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivationoperation_arguments.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivationOperation.Arguments +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivationOperation.Arguments + +## -description +Gets the command-line arguments passed to the app when it was activated. + +## -property-value +The command line arguments. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivationoperation_currentdirectorypath.md b/windows.applicationmodel.activation/commandlineactivationoperation_currentdirectorypath.md new file mode 100644 index 0000000000..e0f2e3dab1 --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivationoperation_currentdirectorypath.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivationOperation.CurrentDirectoryPath +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivationOperation.CurrentDirectoryPath + +## -description +Gets the directory path from which the app was activated from the command line. + +## -property-value +The current directory path. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivationoperation_exitcode.md b/windows.applicationmodel.activation/commandlineactivationoperation_exitcode.md new file mode 100644 index 0000000000..a4265c7806 --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivationoperation_exitcode.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.CommandLineActivationOperation.ExitCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivationOperation.ExitCode + +## -description +Sets the exit code for the app that was launched from the command line. + +## -property-value +The code the app returned when it exits. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/commandlineactivationoperation_getdeferral_254836512.md b/windows.applicationmodel.activation/commandlineactivationoperation_getdeferral_254836512.md new file mode 100644 index 0000000000..91183f7927 --- /dev/null +++ b/windows.applicationmodel.activation/commandlineactivationoperation_getdeferral_254836512.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.ApplicationModel.Activation.CommandLineActivationOperation.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Activation.CommandLineActivationOperation.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A **Deferral** object that your code uses to signal when it has finished processing the activation. + +## -remarks + +## -see-also + +## -examples +```csharp +// The deferral is only needed if your processing requires async operations +using (Deferral deferral = operation.GetDeferral()) +{ + var parsedCommands = + ParseUntrustedArgsAsync(activationPath, cmdLineString); + ... +} + +``` diff --git a/windows.applicationmodel.activation/icommandlineactivatedeventargs.md b/windows.applicationmodel.activation/icommandlineactivatedeventargs.md new file mode 100644 index 0000000000..bda7eb408d --- /dev/null +++ b/windows.applicationmodel.activation/icommandlineactivatedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.ICommandLineActivatedEventArgs +-api-type: winrt interface +--- + + + +# Windows.ApplicationModel.Activation.ICommandLineActivatedEventArgs + +## -description +Defines the interface for providing info, such as the command-line arguments, when an app is activated from the command line. + +## -remarks + +## -see-also +[CommandLineActivatedEventArgs](commandlineactivatedeventargs.md) + +## -examples diff --git a/windows.applicationmodel.activation/icommandlineactivatedeventargs_operation.md b/windows.applicationmodel.activation/icommandlineactivatedeventargs_operation.md new file mode 100644 index 0000000000..62d41aac9f --- /dev/null +++ b/windows.applicationmodel.activation/icommandlineactivatedeventargs_operation.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ICommandLineActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ICommandLineActivatedEventArgs.Operation + +## -description +Provides info about the activation of the app such as what arguments were provided and the current directory path. + +## -property-value +The activation info. + +## -remarks +The app supplies the exit code which is passed back to the caller. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/istartuptaskactivatedeventargs.md b/windows.applicationmodel.activation/istartuptaskactivatedeventargs.md new file mode 100644 index 0000000000..c2a8e6a4a7 --- /dev/null +++ b/windows.applicationmodel.activation/istartuptaskactivatedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.IStartupTaskActivatedEventArgs +-api-type: winrt interface +--- + + + +# Windows.ApplicationModel.Activation.IStartupTaskActivatedEventArgs + +## -description +Provides information when an app is activated at device startup or user login. + +## -remarks +This functionality is only supported on Windows Desktop. + +## -see-also +[Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs](startuptaskactivatedeventargs.md) + +## -examples diff --git a/windows.applicationmodel.activation/startuptaskactivatedeventargs.md b/windows.applicationmodel.activation/startuptaskactivatedeventargs.md new file mode 100644 index 0000000000..bb52cfc7a7 --- /dev/null +++ b/windows.applicationmodel.activation/startuptaskactivatedeventargs.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs + +## -description +Provides information when an app is activated at device startup or user login. + +## -remarks +This functionality is only supported on Windows Desktop. + +## -see-also +[Windows.ApplicationModel.Activation.IStartupTaskActivatedEventArgs](istartuptaskacitvatedeventArgs.md) +[Windows.ApplicationModel.StartupTask](..\windows.applicationmodel\startuptask.md) + +## -examples +```csharp +protected override void OnActivated(IActivatedEventArgs args) +{ + string argString = string.Empty; + + // Existing behavior to differentiate different activation kinds, + // and to extract any argument payload. + switch (args.Kind) + { + case ActivationKind.StartupTask: + var startupArgs = args as StartupTaskActivatedEventArgs; + string taskId = startupArgs.TaskId; + break; + } +} +``` diff --git a/windows.applicationmodel.activation/startuptaskactivatedeventargs_kind.md b/windows.applicationmodel.activation/startuptaskactivatedeventargs_kind.md new file mode 100644 index 0000000000..abc8254a12 --- /dev/null +++ b/windows.applicationmodel.activation/startuptaskactivatedeventargs_kind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.Kind + +## -description +Gets the reason that this app is being activated. + +## -property-value +The expected value is **ActivationKind.StartupTask**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/startuptaskactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/startuptaskactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..14f84db846 --- /dev/null +++ b/windows.applicationmodel.activation/startuptaskactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.PreviousExecutionState + +## -description +Gets the execution state of the app before it was activated. + +## -property-value +The execution state before the app was activated. + +## -remarks +The app uses this information to determine whether it should restore saved state. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/startuptaskactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/startuptaskactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..a78aeef382 --- /dev/null +++ b/windows.applicationmodel.activation/startuptaskactivatedeventargs_splashscreen.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.SplashScreen + +## -description +Gets a [SplashScreen](splashscreen.md) object that provides information about the transition from the splash screen to the activated app. + +## -property-value +The object that provides splash screen information. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.activation/startuptaskactivatedeventargs_taskid.md b/windows.applicationmodel.activation/startuptaskactivatedeventargs_taskid.md new file mode 100644 index 0000000000..67baf753c5 --- /dev/null +++ b/windows.applicationmodel.activation/startuptaskactivatedeventargs_taskid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.TaskId + +## -description +Gets the unique identifier for your task. + +## -property-value + +## -remarks +The task identifier is specified in the manifest of the app. You can use this identifier to call the APIs in the [Windows.ApplicationModel.StartupTask](../windows.applicationmodel/startuptask.md) class to programmatically enable or disable a startup task. + +## -see-also + + +## -examples diff --git a/windows.applicationmodel.activation/startuptaskactivatedeventargs_user.md b/windows.applicationmodel.activation/startuptaskactivatedeventargs_user.md new file mode 100644 index 0000000000..5738b07bb6 --- /dev/null +++ b/windows.applicationmodel.activation/startuptaskactivatedeventargs_user.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.StartupTaskActivatedEventArgs.User + +## -description +Gets the user that the app was activated for. + +## -property-value +The user that the app was activated for. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.appointments/appointmentstore_getchangetracker_1729245170.md b/windows.applicationmodel.appointments/appointmentstore_getchangetracker_1729245170.md new file mode 100644 index 0000000000..aacde2ce5e --- /dev/null +++ b/windows.applicationmodel.appointments/appointmentstore_getchangetracker_1729245170.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Appointments.AppointmentStore.GetChangeTracker(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStore.GetChangeTracker + +## -description + +## -parameters +### -param identity + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.appointments/appointmentstorechangetracker_istracking.md b/windows.applicationmodel.appointments/appointmentstorechangetracker_istracking.md new file mode 100644 index 0000000000..8396f792e8 --- /dev/null +++ b/windows.applicationmodel.appointments/appointmentstorechangetracker_istracking.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.IsTracking +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Appointments.AppointmentStoreChangeTracker.IsTracking + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.appservice/appservicetriggerdetails_checkcallerforcapabilityasync_1034471998.md b/windows.applicationmodel.appservice/appservicetriggerdetails_checkcallerforcapabilityasync_1034471998.md new file mode 100644 index 0000000000..12862c52de --- /dev/null +++ b/windows.applicationmodel.appservice/appservicetriggerdetails_checkcallerforcapabilityasync_1034471998.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.AppService.AppServiceTriggerDetails.CheckCallerForCapabilityAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.AppService.AppServiceTriggerDetails.CheckCallerForCapabilityAsync + +## -description +Determines whether the caller of the app service has the specified capability. + +## -parameters +### -param capabilityName +The name of the capability. + +## -returns +**True** if it was possible to get the capabilities of the caller and the caller has the specified capability; **false** otherwise. + +## -remarks +This API can only be called from within an app that is marked as an app service in its manifest. +One use of this function is to determine whether a caller has the specified capability and, based on that, decide whether to share the requested data, a subset of the data, or no data. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/geovisittrigger.md b/windows.applicationmodel.background/geovisittrigger.md new file mode 100644 index 0000000000..598209e856 --- /dev/null +++ b/windows.applicationmodel.background/geovisittrigger.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.GeovisitTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.GeovisitTrigger + +## -description +Represents an event that triggers a Visits-related background task. + +## -remarks +For more information, see the [Guidelines for using Visits tracking](https://docs.microsoft.com/windows/uwp/maps-and-location/guidelines-for-visits). + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.background/geovisittrigger_geovisittrigger_1221375020.md b/windows.applicationmodel.background/geovisittrigger_geovisittrigger_1221375020.md new file mode 100644 index 0000000000..560d25acf0 --- /dev/null +++ b/windows.applicationmodel.background/geovisittrigger_geovisittrigger_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.GeovisitTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.GeovisitTrigger.GeovisitTrigger + +## -description +Initializes a new [GeovisitTrigger](GeovisitTrigger.md) instance. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.background/geovisittrigger_monitoringscope.md b/windows.applicationmodel.background/geovisittrigger_monitoringscope.md new file mode 100644 index 0000000000..90040406c4 --- /dev/null +++ b/windows.applicationmodel.background/geovisittrigger_monitoringscope.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GeovisitTrigger.MonitoringScope +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GeovisitTrigger.MonitoringScope + +## -description +Gets and sets the scope of Visits to monitor. + +## -property-value +A [VisitMonitoringScope](https://docs.microsoft.com/uwp/api/windows.devices.geolocation.visitmonitoringscope) value representing the scope of location monitoring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.background/paymentappcanmakepaymenttrigger.md b/windows.applicationmodel.background/paymentappcanmakepaymenttrigger.md new file mode 100644 index 0000000000..d02614044a --- /dev/null +++ b/windows.applicationmodel.background/paymentappcanmakepaymenttrigger.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.PaymentAppCanMakePaymentTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.PaymentAppCanMakePaymentTrigger + +## -description +This class represents a PaymentAppCanMakePayment trigger. + +## -remarks +> [!NOTE] +> : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see [Threading and Marshaling (C++/CX)](http://go.microsoft.com/fwlink/p/?linkid=258275) and [Using Windows Runtime objects in a multithreaded environment (.NET)](http://go.microsoft.com/fwlink/p/?linkid=258277). + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.background/paymentappcanmakepaymenttrigger_paymentappcanmakepaymenttrigger_1221375020.md b/windows.applicationmodel.background/paymentappcanmakepaymenttrigger_paymentappcanmakepaymenttrigger_1221375020.md new file mode 100644 index 0000000000..b06dc03352 --- /dev/null +++ b/windows.applicationmodel.background/paymentappcanmakepaymenttrigger_paymentappcanmakepaymenttrigger_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.PaymentAppCanMakePaymentTrigger.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.PaymentAppCanMakePaymentTrigger.PaymentAppCanMakePaymentTrigger + +## -description +Creates a PaymentAppCanMakePaymentTrigger object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.calls/voipcallcoordinator_setupnewacceptedcall_475235632.md b/windows.applicationmodel.calls/voipcallcoordinator_setupnewacceptedcall_475235632.md new file mode 100644 index 0000000000..84ef17c01d --- /dev/null +++ b/windows.applicationmodel.calls/voipcallcoordinator_setupnewacceptedcall_475235632.md @@ -0,0 +1,40 @@ +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipCallCoordinator.SetupNewAcceptedCall(System.String,System.String,System.String,System.String,Windows.ApplicationModel.Calls.VoipPhoneCallMedia) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipCallCoordinator.SetupNewAcceptedCall + +## -description +Sets up a newly accepted call. + +## -parameters +### -param context +Information that is passed to the VOIP app's foreground UI process. This might be the contact name, or other data that helps the UI display more quickly. + +### -param contactName +The name or ID of the caller. + +### -param contactNumber +The phone number (if applicable) of the caller. + +### -param serviceName +The name of the service or application. + +### -param media +The type of call (audio/video or audio only). + +## -returns +Returns the call as a VoipPhoneCall object. + +## -remarks +All string parameters have a maximum allowed length of 128 characters (including the terminator). + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.calls/voipphonecall_tryshowappui_768095277.md b/windows.applicationmodel.calls/voipphonecall_tryshowappui_768095277.md new file mode 100644 index 0000000000..4181e27900 --- /dev/null +++ b/windows.applicationmodel.calls/voipphonecall_tryshowappui_768095277.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.ApplicationModel.Calls.VoipPhoneCall.TryShowAppUI +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Calls.VoipPhoneCall.TryShowAppUI + +## -description +Brings the VOIP app's user interface into the foreground after accepting a call. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_createorupdatecontactrequested.md b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_createorupdatecontactrequested.md new file mode 100644 index 0000000000..28fdc6319b --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_createorupdatecontactrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.CreateOrUpdateContactRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.CreateOrUpdateContactRequested + +## -description +Raised when the client app attempts to create or update a contact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_deletecontactrequested.md b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_deletecontactrequested.md new file mode 100644 index 0000000000..b1e37b53fa --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactdataproviderconnection_deletecontactrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.DeleteContactRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactDataProviderConnection.DeleteContactRequested + +## -description +Raised when the client app attempts to delete a contact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest.md new file mode 100644 index 0000000000..508f3421da --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest + +## -description +Details of a request to create or update a contact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_contact.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_contact.md new file mode 100644 index 0000000000..0a2464088b --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_contact.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.Contact + +## -description +Gets the [Contact](../windows.applicationmodel.contacts/contact.md) of the task to be created or updated. + +## -property-value +The [Contact](../windows.applicationmodel.contacts/contact.md) of the task to be created or updated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_contactlistid.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_contactlistid.md new file mode 100644 index 0000000000..cf5919488e --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_contactlistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.ContactListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.ContactListId + +## -description +Gets the ID of the contact list that contains the task that is to created or updated. + +## -property-value +The ID of the contact list that contains the task that is to created or updated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_reportcompletedasync_1141106491.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_reportcompletedasync_1141106491.md new file mode 100644 index 0000000000..8277dcd5f6 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_reportcompletedasync_1141106491.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.ReportCompletedAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -parameters +### -param createdOrUpdatedContact +The [Contact](../windows.applicationmodel.contacts/contact.md) of the contact that was created or updated. + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..c76e0631dc --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequest_reportfailedasync_1210652737.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs.md new file mode 100644 index 0000000000..2110ca6132 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequestEventArgs + +## -description +Encapsulates information about a request to create or update. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..4fd173dd8d --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs_getdeferral_254836512.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs_request.md b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs_request.md new file mode 100644 index 0000000000..7d44df129b --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistcreateorupdatecontactrequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListCreateOrUpdateContactRequestEventArgs.Request + +## -description +Gets the [ContactListCreateOrUpdateTaskRequest](contactlistcreateorupdatetaskrequest.md) object associated with this request. + +## -property-value +A [ContactListCreateOrUpdateTaskRequest](contactlistcreateorupdatetaskrequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest.md new file mode 100644 index 0000000000..4f17443785 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest + +## -description +Details of a request to delete a contact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_contactid.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_contactid.md new file mode 100644 index 0000000000..8300a75f06 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_contactid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ContactId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ContactId + +## -description +Gets the contact ID of the contact to be deleted. + +## -property-value +The contact ID of the contact to be deleted. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_contactlistid.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_contactlistid.md new file mode 100644 index 0000000000..c3fd946409 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_contactlistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ContactListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ContactListId + +## -description +Gets the ID of the contact list that contains the contact that is to be deleted. + +## -property-value +The contact list that contains the contact that is to be deleted. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_reportcompletedasync_1707664681.md new file mode 100644 index 0000000000..8c238a8678 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_reportcompletedasync_1707664681.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..8e7cb2d21e --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequest_reportfailedasync_1210652737.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs.md new file mode 100644 index 0000000000..09d1613d4e --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequestEventArgs + +## -description +Encapsulates information about a request to delete a contact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..74691c96ae --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs_getdeferral_254836512.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs_request.md b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs_request.md new file mode 100644 index 0000000000..0e95fe0ff0 --- /dev/null +++ b/windows.applicationmodel.contacts.dataprovider/contactlistdeletecontactrequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.DataProvider.ContactListDeleteContactRequestEventArgs.Request + +## -description +Gets the [ContactListDeleteTaskRequest](contactlistdeletetaskrequest.md) object associated with this request. + +## -property-value +A [ContactListDeleteTaskRequest](contactlistdeletetaskrequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactchangetracker_istracking.md b/windows.applicationmodel.contacts/contactchangetracker_istracking.md new file mode 100644 index 0000000000..67e0b4129b --- /dev/null +++ b/windows.applicationmodel.contacts/contactchangetracker_istracking.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactChangeTracker.IsTracking +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactChangeTracker.IsTracking + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.contacts/contactlist_getchangetracker_1729245170.md b/windows.applicationmodel.contacts/contactlist_getchangetracker_1729245170.md new file mode 100644 index 0000000000..158d3480b8 --- /dev/null +++ b/windows.applicationmodel.contacts/contactlist_getchangetracker_1729245170.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactList.GetChangeTracker(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.GetChangeTracker + +## -description + +## -parameters +### -param identity + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.contacts/contactlist_limitedwriteoperations.md b/windows.applicationmodel.contacts/contactlist_limitedwriteoperations.md new file mode 100644 index 0000000000..a1baa0bc44 --- /dev/null +++ b/windows.applicationmodel.contacts/contactlist_limitedwriteoperations.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactList.LimitedWriteOperations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactList.LimitedWriteOperations + +## -description +Gets an object that provides operations that an app can perform on a contact list that it has not created. + +## -property-value +An object that provides operations that an app can perform on a contact list that it has not created. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactlistlimitedwriteoperations.md b/windows.applicationmodel.contacts/contactlistlimitedwriteoperations.md new file mode 100644 index 0000000000..be5aac6866 --- /dev/null +++ b/windows.applicationmodel.contacts/contactlistlimitedwriteoperations.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactListLimitedWriteOperations +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactListLimitedWriteOperations + +## -description +Provides operations that an app can perform on a contact list that it has not created. + +## -remarks +Get an instance of this class by using the [LimitedWriteOperations](contactlist_limitedwriteoperations.md) property of a [ContactList](contactlist.md). + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactlistlimitedwriteoperations_trycreateorupdatecontactasync_1239528401.md b/windows.applicationmodel.contacts/contactlistlimitedwriteoperations_trycreateorupdatecontactasync_1239528401.md new file mode 100644 index 0000000000..e8787d76a4 --- /dev/null +++ b/windows.applicationmodel.contacts/contactlistlimitedwriteoperations_trycreateorupdatecontactasync_1239528401.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactListLimitedWriteOperations.TryCreateOrUpdateContactAsync(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactListLimitedWriteOperations.TryCreateOrUpdateContactAsync + +## -description +Asynchronously attempts to create or update a contact. + +## -parameters +### -param contact +The contact to create or update. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactlistlimitedwriteoperations_trydeletecontactasync_893454021.md b/windows.applicationmodel.contacts/contactlistlimitedwriteoperations_trydeletecontactasync_893454021.md new file mode 100644 index 0000000000..2a41fa5655 --- /dev/null +++ b/windows.applicationmodel.contacts/contactlistlimitedwriteoperations_trydeletecontactasync_893454021.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactListLimitedWriteOperations.TryDeleteContactAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactListLimitedWriteOperations.TryDeleteContactAsync + +## -description +Asynchronously attempts to delete a contact. + +## -parameters +### -param contactId +The ID of the contact to delete. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactlistotherappwriteaccess.md b/windows.applicationmodel.contacts/contactlistotherappwriteaccess.md index 7d05c038db..43c381b407 100644 --- a/windows.applicationmodel.contacts/contactlistotherappwriteaccess.md +++ b/windows.applicationmodel.contacts/contactlistotherappwriteaccess.md @@ -19,9 +19,11 @@ No write access is granted. ### -field SystemOnly:1 Other apps can only write system contacts. +### -field Limited:2 +Other apps can only write contacts for this app. ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.applicationmodel.contacts/contactstore_getchangetracker_1729245170.md b/windows.applicationmodel.contacts/contactstore_getchangetracker_1729245170.md new file mode 100644 index 0000000000..f2088874ec --- /dev/null +++ b/windows.applicationmodel.contacts/contactstore_getchangetracker_1729245170.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactStore.GetChangeTracker(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactStore.GetChangeTracker + +## -description + +## -parameters +### -param identity + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.core/applistentry_appusermodelid.md b/windows.applicationmodel.core/applistentry_appusermodelid.md new file mode 100644 index 0000000000..6c2b33ea2b --- /dev/null +++ b/windows.applicationmodel.core/applistentry_appusermodelid.md @@ -0,0 +1,47 @@ +--- +-api-id: P:Windows.ApplicationModel.Core.AppListEntry.AppUserModelId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.AppListEntry.AppUserModelId + +## -description +Gets the Application User Model ID (AUMID) for this **AppListEntry**. + +## -property-value +A string representing the app's identity. + +## -remarks +An AUMID is a persistable value that you can use to identify an application. + +## -see-also + +## -examples +```csharp +// Find and activate the desired application (if present on this machine) +using namespace Windows.Management.Deployment; + +async Task RunApplicationAsync(string aumid) +{ + var packageManager = new Windows.Management.Deployment.PackageManager(); + IEnumerable packages = packageManager.FindPackagesForUserWithPackageTypes( + null, PackageTypes.Main | PackageTypes.Optional); + + foreach (Package package in packages) + { + IReadOnlyList entries = await package.GetAppListEntriesAsync(); + foreach (AppListEntry entry in entries) + { + if (String.Equals(entry.AppUserModelId, aumid, StringComparison.OrdinalIgnoreCase)) + { + return await entry.LaunchAsync(); + } + } + } + return false; +} +``` diff --git a/windows.applicationmodel.core/apprestartfailurereason.md b/windows.applicationmodel.core/apprestartfailurereason.md new file mode 100644 index 0000000000..2d35c6b74d --- /dev/null +++ b/windows.applicationmodel.core/apprestartfailurereason.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.ApplicationModel.Core.AppRestartFailureReason +-api-type: winrt enum +--- + + + +# Windows.ApplicationModel.Core.AppRestartFailureReason + +## -description +Describes the reasons why an app could fail a request to restart. + +## -enum-fields +### -field RestartPending:0 +A restart is already in progress. + +### -field Other:3 +Unspecified failure. + +### -field NotInForeground:1 +An app must be visible and in the foreground when it calls the restart API. + +### -field InvalidUser:2 +Could not restart for the specified user. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.core/coreapplication_requestrestartasync_172604043.md b/windows.applicationmodel.core/coreapplication_requestrestartasync_172604043.md index 9b4bf9ca2e..9063e7a6b0 100644 --- a/windows.applicationmodel.core/coreapplication_requestrestartasync_172604043.md +++ b/windows.applicationmodel.core/coreapplication_requestrestartasync_172604043.md @@ -10,15 +10,41 @@ public IAsyncOperation CoreApplication.RequestRestartAsync(String # Windows.ApplicationModel.Core.CoreApplication.RequestRestartAsync ## -description +Restart the app. ## -parameters ### -param launchArguments +The arguments to pass to the restarted instance. ## -returns +The status of the restart request. ## -remarks +* The app must be visible and foreground when it calls this API. +* If the restart fails, but the user subsequently launches the app manually, the app will launch normally and no restart arguments will be passed. +* If the app wasn't launched in the normal way, but was launched by a share contract, file picker, app-service, and so on, the app should not call this API because the user will not expect the resulting behavior. +* The app is responsible for ensuring the validity of the **User** object. The activation will fail if there is policy in place which prevents that user from executing the app. +* The app should not request an Extended Execution session after it has called this API because that will result in a poor user experience. +* If the app has any in-process background tasks running when it calls this API, those tasks will be cancelled in the normal way. Out-of-process background tasks will not be affected. +* When the app is restarted, [LaunchActivatedEventArgs.PreviousExecutionState](https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Activation.LaunchActivatedEventArgs) will have the value **Terminated** so that the app can distinguish between a resume and a restart. ## -see-also +[Windows.ApplicationModel.Core.CoreApplication.RequestRestartAsyncForUser](coreapplication_requestrestartforuserasync_1889038893.md) ## -examples +```csharp +private async void DoMajorAppReconfiguration() +{ + // Attempt restart, with arguments. + AppRestartFailureReason result = + await CoreApplication.RequestRestartAsync("-fastInit -level 1 -foo"); + // Restart request denied, send a toast to tell the user to restart manually. + if (result == AppRestartFailureReason.NotInForeground + || result == AppRestartFailureReason.Other) + { + SendToast("Please manually restart."); + } +} + +``` diff --git a/windows.applicationmodel.core/coreapplication_requestrestartforuserasync_1889038893.md b/windows.applicationmodel.core/coreapplication_requestrestartforuserasync_1889038893.md index df99d220b7..b82a20b750 100644 --- a/windows.applicationmodel.core/coreapplication_requestrestartforuserasync_1889038893.md +++ b/windows.applicationmodel.core/coreapplication_requestrestartforuserasync_1889038893.md @@ -10,17 +10,52 @@ public IAsyncOperation CoreApplication.RequestRestartForUserAsync # Windows.ApplicationModel.Core.CoreApplication.RequestRestartForUserAsync ## -description +Restart the app in the context of a different user. ## -parameters ### -param user +The user to restart the app as. ### -param launchArguments +The arguments to pass to the restarted instance. ## -returns +The status of the restart request. ## -remarks +* The app must be visible and foreground when it calls this API. +* If the restart fails, but the user subsequently launches the app manually, the app will launch normally and no restart arguments will be passed. +* If the app wasn't launched in the normal way, but was launched by a share contract, file picker, app-service, and so on, the app should not call this API because the user will not expect the resulting behavior. +* The app is responsible for ensuring the validity of the **User** object. The activation will fail if there is policy in place which prevents that user from executing the app. +* The app should not request an Extended Execution session after it has called this API because that will result in a poor user experience. +* If the app has any in-process background tasks running when it calls this API, those tasks will be cancelled in the normal way. Out-of-process background tasks will not be affected. +* When the app is restarted, [LaunchActivatedEventArgs.PreviousExecutionState](https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Activation.LaunchActivatedEventArgs) will have the value **Terminated** so that the app can distinguish between a resume and a restart. ## -see-also +[Windows.ApplicationModel.Core.CoreApplication.RequestRestartAsync](coreapplication_requestrestartasync_172604043.md) ## -examples - +```csharp +private async void RestartAsAnotherUser(string selectedUser) +{ + IReadOnlyList users = await User.FindAllAsync(); + foreach (User user in users) + { + object accountProperty = + await user.GetPropertyAsync(KnownUserProperties.AccountName); + string accountName = (string)accountProperty; + if (accountName == selectedUser) + { + // Attempt restart, with arguments. + AppRestartFailureReason result = await App.RequestRestartForUserAsync( + user, "-fastInit -mainMenu"); + + // Restart request denied, tell the user to restart manually. + if (result== AppRestartFailureReason.InvalidUser) + { + SendToast(string.Format("Could not restart as user {0} - please manually restart.", user)); + } + } + } +} +``` diff --git a/windows.applicationmodel.core/coreapplicationview_dispatcherqueue.md b/windows.applicationmodel.core/coreapplicationview_dispatcherqueue.md index 6ab6a6ae4b..30667159d3 100644 --- a/windows.applicationmodel.core/coreapplicationview_dispatcherqueue.md +++ b/windows.applicationmodel.core/coreapplicationview_dispatcherqueue.md @@ -10,12 +10,14 @@ public DispatcherQueue DispatcherQueue { get; } # Windows.ApplicationModel.Core.CoreApplicationView.DispatcherQueue ## -description +Gets the **DispatcherQueue** for the window. ## -property-value +A **DispatcherQueue** instance. ## -remarks +The **DispatcherQueue** allows you to run your tasks on the thread associated with the **DispatcherQueue** instance. To make UI changes on a **CoreApplicationView** from a different thread, use the **DispatcherQueue** from that **CoreApplicationView**. ## -see-also ## -examples - diff --git a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_contacts.md b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_contacts.md index bf8ad03216..d20f57823c 100644 --- a/windows.applicationmodel.datatransfer.sharetarget/shareoperation_contacts.md +++ b/windows.applicationmodel.datatransfer.sharetarget/shareoperation_contacts.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Contacts --api-type: winrt property ---- - +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Contacts +-api-type: winrt property +--- + -# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Contacts - +# Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation.Contacts + ## -description +Gets the contacts for the share operation. ## -property-value +The contacts for the share operation. ## -remarks diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_2106599435.md b/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_2106599435.md index 7cddfca9b3..b7a23066e8 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_2106599435.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_showshareui_2106599435.md @@ -1,22 +1,30 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI(Windows.ApplicationModel.DataTransfer.ShareUIOptions) --api-type: winrt method ---- - +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI(Windows.ApplicationModel.DataTransfer.ShareUIOptions) +-api-type: winrt method +--- + -# Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI - +# Windows.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI + ## -description +Programmatically initiates the user interface for sharing content with another app. ## -parameters -### -param shareOptions +### -param options +The options. ## -remarks +We recommend that you use this method only when absolutely necessary. Users expect to launch the Share user interface through the Share charm. Launching the user interface programmatically can create a confusing user experience. + +As a general rule, use this method only when it isn't obvious to a user that some content is shareable. For example, if a user gets a high score in a game, it may not be obvious that they can share that high score with their friends. In this situation, it makes sense to use the **showShareUI** method. + +A [DataPackage](datapackage.md) must have its [Title](datapackagepropertyset_title.md) set in order to be shared. Ensure [Title](datapackagepropertyset_title.md) is set before calling this method. ## -see-also ## -examples + diff --git a/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3.md b/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3.md index 6cf7492cf1..65f1e6bb2d 100644 --- a/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3.md +++ b/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3 --api-type: winrt interface ---- - +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3 +-api-type: winrt interface +--- + -# Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3 - +# Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3 + ## -description +Interface that provides static methods for data transfer. ## -remarks diff --git a/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3_showshareui_2106599435.md b/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3_showshareui_2106599435.md index b88a92d7e7..58412a37de 100644 --- a/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3_showshareui_2106599435.md +++ b/windows.applicationmodel.datatransfer/idatatransfermanagerstatics3_showshareui_2106599435.md @@ -1,18 +1,20 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3.ShowShareUI(Windows.ApplicationModel.DataTransfer.ShareUIOptions) --api-type: winrt method ---- - +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3.ShowShareUI(Windows.ApplicationModel.DataTransfer.ShareUIOptions) +-api-type: winrt method +--- + -# Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3.ShowShareUI - +# Windows.ApplicationModel.DataTransfer.IDataTransferManagerStatics3.ShowShareUI + ## -description +This method shows the share UI to the user. ## -parameters ### -param shareOptions +The options to provide to the user. ## -remarks diff --git a/windows.applicationmodel.datatransfer/shareuioptions.md b/windows.applicationmodel.datatransfer/shareuioptions.md index 21231ba7e0..4f7ebd2e1b 100644 --- a/windows.applicationmodel.datatransfer/shareuioptions.md +++ b/windows.applicationmodel.datatransfer/shareuioptions.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.ApplicationModel.DataTransfer.ShareUIOptions --api-type: winrt class ---- - +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareUIOptions +-api-type: winrt class +--- + -# Windows.ApplicationModel.DataTransfer.ShareUIOptions - +# Windows.ApplicationModel.DataTransfer.ShareUIOptions + ## -description +This class represents the options that are available to the user when showing the ShareUI. ## -remarks diff --git a/windows.applicationmodel.datatransfer/shareuioptions_selectionrect.md b/windows.applicationmodel.datatransfer/shareuioptions_selectionrect.md new file mode 100644 index 0000000000..62b8f37ec7 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareuioptions_selectionrect.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareUIOptions.SelectionRect +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareUIOptions.SelectionRect + +## -description +Gets or sets the selection rectangle. + +## -property-value +The selection rectangle. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareuioptions_shareuioptions_1221375020.md b/windows.applicationmodel.datatransfer/shareuioptions_shareuioptions_1221375020.md index 276ba9759b..fd109fa133 100644 --- a/windows.applicationmodel.datatransfer/shareuioptions_shareuioptions_1221375020.md +++ b/windows.applicationmodel.datatransfer/shareuioptions_shareuioptions_1221375020.md @@ -1,15 +1,16 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.ShareUIOptions.#ctor --api-type: winrt method ---- - +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareUIOptions.#ctor +-api-type: winrt method +--- + -# Windows.ApplicationModel.DataTransfer.ShareUIOptions.ShareUIOptions - +# Windows.ApplicationModel.DataTransfer.ShareUIOptions.ShareUIOptions + ## -description +Creates a new ShareUIOptions object. ## -remarks diff --git a/windows.applicationmodel.datatransfer/shareuioptions_theme.md b/windows.applicationmodel.datatransfer/shareuioptions_theme.md new file mode 100644 index 0000000000..62e81d5849 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareuioptions_theme.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareUIOptions.Theme +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareUIOptions.Theme + +## -description +Gets or sets the share UI theme. + +## -property-value +The share UI theme. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareuitheme.md b/windows.applicationmodel.datatransfer/shareuitheme.md index d1a815364a..99c61dc1bd 100644 --- a/windows.applicationmodel.datatransfer/shareuitheme.md +++ b/windows.applicationmodel.datatransfer/shareuitheme.md @@ -1,22 +1,26 @@ ---- --api-id: T:Windows.ApplicationModel.DataTransfer.ShareUITheme --api-type: winrt enum ---- - +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareUITheme +-api-type: winrt enum +--- + -# Windows.ApplicationModel.DataTransfer.ShareUITheme - +# Windows.ApplicationModel.DataTransfer.ShareUITheme + ## -description +The theme for the Share UI. ## -enum-fields ### -field Light:1 +Light theme. ### -field Default:0 +Default theme. ### -field Dark:2 +Dark theme. ## -remarks diff --git a/windows.applicationmodel.email/emailmailbox_getchangetracker_1729245170.md b/windows.applicationmodel.email/emailmailbox_getchangetracker_1729245170.md new file mode 100644 index 0000000000..64494c5ac3 --- /dev/null +++ b/windows.applicationmodel.email/emailmailbox_getchangetracker_1729245170.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Email.EmailMailbox.GetChangeTracker(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Email.EmailMailbox.GetChangeTracker + +## -description + +## -parameters +### -param identity + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails.md b/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails.md new file mode 100644 index 0000000000..ca48db3570 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.Provider.PaymentAppCanMakePaymentTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppCanMakePaymentTriggerDetails + +## -description +Creates a new PaymentAppCanMakePaymentTriggerDetails. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails_reportcanmakepaymentresult_1676885184.md b/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails_reportcanmakepaymentresult_1676885184.md new file mode 100644 index 0000000000..575e3c64b8 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails_reportcanmakepaymentresult_1676885184.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentAppCanMakePaymentTriggerDetails.ReportCanMakePaymentResult(Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppCanMakePaymentTriggerDetails.ReportCanMakePaymentResult + +## -description +Reports the status of whether the payment can be made. + +## -parameters +### -param value +The value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails_request.md b/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails_request.md new file mode 100644 index 0000000000..25da63569a --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappcanmakepaymenttriggerdetails_request.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentAppCanMakePaymentTriggerDetails.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppCanMakePaymentTriggerDetails.Request + +## -description +Gets the payment request. + +## -property-value +The payment request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentcanmakepaymentresult.md b/windows.applicationmodel.payments/paymentcanmakepaymentresult.md new file mode 100644 index 0000000000..2a75462907 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcanmakepaymentresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult + +## -description +This class serves as a result of the [CanMakePaymentsAsync](paymentmediator_canmakepaymentasync_2038017003.md) method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentcanmakepaymentresult_paymentcanmakepaymentresult_1792942912.md b/windows.applicationmodel.payments/paymentcanmakepaymentresult_paymentcanmakepaymentresult_1792942912.md new file mode 100644 index 0000000000..1e35540725 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcanmakepaymentresult_paymentcanmakepaymentresult_1792942912.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult.#ctor(Windows.ApplicationModel.Payments.PaymentCanMakePaymentResultStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult.PaymentCanMakePaymentResult + +## -description +Creates a new PaymentCanMakePaymentResult object. + +## -parameters +### -param value +The status value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentcanmakepaymentresult_status.md b/windows.applicationmodel.payments/paymentcanmakepaymentresult_status.md new file mode 100644 index 0000000000..8d516ed8c6 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcanmakepaymentresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentCanMakePaymentResult.Status + +## -description +Gets the status of whether a payment can be made. + +## -property-value +The status of whether a payment can be made. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentcanmakepaymentresultstatus.md b/windows.applicationmodel.payments/paymentcanmakepaymentresultstatus.md new file mode 100644 index 0000000000..57fb033643 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcanmakepaymentresultstatus.md @@ -0,0 +1,42 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentCanMakePaymentResultStatus +-api-type: winrt enum +--- + + + +# Windows.ApplicationModel.Payments.PaymentCanMakePaymentResultStatus + +## -description +This enumeration represents the result of querying whether a payment can be made. + +## -enum-fields +### -field Yes:1 +Yes, a payment can be made. + +### -field UserNotSignedIn:4 +The user is not signed in. + +### -field Unknown:0 +There's an unknown reason. + +### -field SpecifiedPaymentMethodIdsNotSupported:5 +The specified payment method is not supported. + +### -field NotAllowed:3 +The payment is not allowed. + +### -field NoQualifyingCardOnFile:6 +There is no qualifying card on file. + +### -field No:2 +No. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentmediator_canmakepaymentasync_2038017003.md b/windows.applicationmodel.payments/paymentmediator_canmakepaymentasync_2038017003.md index 486842313c..1834547999 100644 --- a/windows.applicationmodel.payments/paymentmediator_canmakepaymentasync_2038017003.md +++ b/windows.applicationmodel.payments/paymentmediator_canmakepaymentasync_2038017003.md @@ -1,20 +1,23 @@ ---- --api-id: M:Windows.ApplicationModel.Payments.PaymentMediator.CanMakePaymentAsync(Windows.ApplicationModel.Payments.PaymentRequest) --api-type: winrt method ---- - +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMediator.CanMakePaymentAsync(Windows.ApplicationModel.Payments.PaymentRequest) +-api-type: winrt method +--- + -# Windows.ApplicationModel.Payments.PaymentMediator.CanMakePaymentAsync - +# Windows.ApplicationModel.Payments.PaymentMediator.CanMakePaymentAsync + ## -description +This method checks if a payment can be made on the paymentRequest. ## -parameters ### -param paymentRequest +The payment request to check. ## -returns +Returns an asynchronous operation that completes with a bool indicating whether a payment can be made. ## -remarks diff --git a/windows.applicationmodel.payments/paymentrequest_id.md b/windows.applicationmodel.payments/paymentrequest_id.md new file mode 100644 index 0000000000..a10cf61f52 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequest.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.Id + +## -description +Gets the payment request ID. + +## -property-value +The payment request ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentrequest_paymentrequest_1715057212.md b/windows.applicationmodel.payments/paymentrequest_paymentrequest_1715057212.md new file mode 100644 index 0000000000..6a249ac186 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_paymentrequest_1715057212.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequest.#ctor(Windows.ApplicationModel.Payments.PaymentDetails,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentMethodData},Windows.ApplicationModel.Payments.PaymentMerchantInfo,Windows.ApplicationModel.Payments.PaymentOptions,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.PaymentRequest + +## -description +Creates a new PaymentRequest object. + +## -parameters +### -param details +The details. + +### -param methodData +The method daya. + +### -param merchantInfo +The merchantInfo. + +### -param options +The options. + +### -param id +The ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.useractivities.core/coreuseractivitymanager.md b/windows.applicationmodel.useractivities.core/coreuseractivitymanager.md index d893f9f45c..7b9f2e6cc1 100644 --- a/windows.applicationmodel.useractivities.core/coreuseractivitymanager.md +++ b/windows.applicationmodel.useractivities.core/coreuseractivitymanager.md @@ -4,16 +4,17 @@ --- # Windows.ApplicationModel.UserActivities.Core.CoreUserActivityManager ## -description +Manages the creation and deletion of user activities. ## -remarks +A [UserActivity](../windows.applicationmodel.useractivities/useractivity.md) encapsulates a user's task that can be continued at a later time, and potentially on a different device. For example, a mail app could create a UserActivity when the user starts creating a new email message. The user could pause working on the email and then work on it later on the same machine, or even another device. ## -see-also ## -examples - diff --git a/windows.applicationmodel.useractivities.core/coreuseractivitymanager_createuseractivitysessioninbackground_1296215843.md b/windows.applicationmodel.useractivities.core/coreuseractivitymanager_createuseractivitysessioninbackground_1296215843.md index 51f6943cec..5c54b47ec2 100644 --- a/windows.applicationmodel.useractivities.core/coreuseractivitymanager_createuseractivitysessioninbackground_1296215843.md +++ b/windows.applicationmodel.useractivities.core/coreuseractivitymanager_createuseractivitysessioninbackground_1296215843.md @@ -10,6 +10,7 @@ public UserActivitySession CoreUserActivityManager.CreateUserActivitySessionInBa # Windows.ApplicationModel.UserActivities.Core.CoreUserActivityManager.CreateUserActivitySessionInBackground ## -description +Creates a user activity session. ## -parameters ### -param activity @@ -17,8 +18,10 @@ public UserActivitySession CoreUserActivityManager.CreateUserActivitySessionInBa ## -returns ## -remarks +The *background* in this API name refers to the fact that the session is not associated with a window. + +A session allows you to group user activities together so that you can do things such as delete all user activities created during a given timeframe. ## -see-also ## -examples - diff --git a/windows.applicationmodel.useractivities.core/coreuseractivitymanager_deleteuseractivitysessionsintimerangeasync_244848816.md b/windows.applicationmodel.useractivities.core/coreuseractivitymanager_deleteuseractivitysessionsintimerangeasync_244848816.md new file mode 100644 index 0000000000..16bfb8e71e --- /dev/null +++ b/windows.applicationmodel.useractivities.core/coreuseractivitymanager_deleteuseractivitysessionsintimerangeasync_244848816.md @@ -0,0 +1,40 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.Core.CoreUserActivityManager.DeleteUserActivitySessionsInTimeRangeAsync(Windows.ApplicationModel.UserActivities.UserActivityChannel,Windows.Foundation.DateTime,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.Core.CoreUserActivityManager.DeleteUserActivitySessionsInTimeRangeAsync + +## -description +Delete user activities created during a specified timeframe. + +## -parameters +### -param channel +The channel that was used to create the user activities. + +### -param startTime +The beginning of the time range in which to delete user activities. + +### -param endTime +The end of the time range in which to delete user activities. + +## -returns +An asynchronous action. + +## -remarks + +## -see-also + +## -examples +```csharp +public static async Task DeleteActiviesForDay(DateTime date) +{ + var startDate = date.Day; + var endDate = date.Day + TimeSpan.FromDays(1); + await Windows.ApplicationModel.UserActivities.Core.CoreUserActivityManager.DeleteUserActivitySessionsInTimeRangeAsync(UserActivityChannel.GetDefault(), startDate, endDate); +} +``` diff --git a/windows.applicationmodel.useractivities.core/windows_applicationmodel_useractivities_core.md b/windows.applicationmodel.useractivities.core/windows_applicationmodel_useractivities_core.md index c7f5553c39..db8449218a 100644 --- a/windows.applicationmodel.useractivities.core/windows_applicationmodel_useractivities_core.md +++ b/windows.applicationmodel.useractivities.core/windows_applicationmodel_useractivities_core.md @@ -4,16 +4,17 @@ --- # Windows.ApplicationModel.UserActivities.Core ## -description +Manages the creation and deletion of user activities. A **UserActivity** encapsulates a user's task that can be continued at a later time, and potentially on a different device. +For example, a mail app could create a **UserActivity** when the user starts creating a new email message. The user could pause working on the email and then work on it later on the same machine, or even another device. ## -remarks ## -see-also ## -examples - diff --git a/windows.applicationmodel.useractivities/iuseractivitycontentinfo.md b/windows.applicationmodel.useractivities/iuseractivitycontentinfo.md new file mode 100644 index 0000000000..76fdc79576 --- /dev/null +++ b/windows.applicationmodel.useractivities/iuseractivitycontentinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserActivities.IUserActivityContentInfo +-api-type: winrt interface +--- + + + +# Windows.ApplicationModel.UserActivities.IUserActivityContentInfo + +## -description +Represents the content metadata of this activity in JSON format. + +## -remarks +For example, if your activity was reading an RSS feed, the content might include the name of the article and its author. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/iuseractivitycontentinfo_tojson_1289546151.md b/windows.applicationmodel.useractivities/iuseractivitycontentinfo_tojson_1289546151.md new file mode 100644 index 0000000000..c6f60aed53 --- /dev/null +++ b/windows.applicationmodel.useractivities/iuseractivitycontentinfo_tojson_1289546151.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.IUserActivityContentInfo.ToJson +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.IUserActivityContentInfo.ToJson + +## -description +Provide the **UserActivityContentInfo** in the form of a JSON string. + +## -returns +The JSON content. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivity.md b/windows.applicationmodel.useractivities/useractivity.md index 5b33174ede..15fa2d0daf 100644 --- a/windows.applicationmodel.useractivities/useractivity.md +++ b/windows.applicationmodel.useractivities/useractivity.md @@ -11,7 +11,7 @@ public class UserActivity ## -description -Provides information about a task the user is engaged in. +A **UserActivity** is created by an app during its execution to notify the system of a user work stream that can be continued on another device, or at another time on the same device. It provides information about a task the user is engaged in. ## -remarks diff --git a/windows.applicationmodel.useractivities/useractivity_contentinfo.md b/windows.applicationmodel.useractivities/useractivity_contentinfo.md new file mode 100644 index 0000000000..1a4c7bc671 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivity_contentinfo.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.UserActivities.UserActivity.ContentInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivity.ContentInfo + +## -description +Gets or sets the content information object for this user activity. + +## -property-value +A content information object that implements [IUserActivityContentInfo](iuseractivitycontentinfo.md). + +## -remarks +The content information inside the **UserActivityContentInfo** object is stored in the JSON format. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityattribution.md b/windows.applicationmodel.useractivities/useractivityattribution.md new file mode 100644 index 0000000000..09405e6537 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityattribution.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserActivities.UserActivityAttribution +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityAttribution + +## -description +Provides visual information about a user activity. Overrides information the system provides about the user activity. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityattribution_addimagequery.md b/windows.applicationmodel.useractivities/useractivityattribution_addimagequery.md new file mode 100644 index 0000000000..a063e95ab5 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityattribution_addimagequery.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.UserActivities.UserActivityAttribution.AddImageQuery +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityAttribution.AddImageQuery + +## -description +Get or set whether allow Windows to append a query string to the image URI supplied from [IconUri](useractivityattribution_iconuri.md). + +## -property-value +**True** to allow windows to append a query string to the image URI; **false** otherwise. + +## -remarks +Set to **true** if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, an **IconUri** value of **www.website.com/images/hello.png** becomes **www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us**. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityattribution_alternatetext.md b/windows.applicationmodel.useractivities/useractivityattribution_alternatetext.md new file mode 100644 index 0000000000..87cfd3a443 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityattribution_alternatetext.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.UserActivities.UserActivityAttribution.AlternateText +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityAttribution.AlternateText + +## -description +Get or set the text that describes the icon. + +## -property-value +The alternative text string. + +## -remarks +Screen readers use the alternative text string to describe the icon. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityattribution_iconuri.md b/windows.applicationmodel.useractivities/useractivityattribution_iconuri.md new file mode 100644 index 0000000000..6d5c2c5d46 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityattribution_iconuri.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserActivities.UserActivityAttribution.IconUri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityAttribution.IconUri + +## -description +Get or set the Uniform Resource Identifier (URI) for the icon image. + +## -property-value +The URI that identifies the icon image. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityattribution_useractivityattribution_1221375020.md b/windows.applicationmodel.useractivities/useractivityattribution_useractivityattribution_1221375020.md new file mode 100644 index 0000000000..d180de3571 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityattribution_useractivityattribution_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.UserActivityAttribution.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityAttribution.UserActivityAttribution + +## -description +Create a **UserActivityAttribution** object. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityattribution_useractivityattribution_843413386.md b/windows.applicationmodel.useractivities/useractivityattribution_useractivityattribution_843413386.md new file mode 100644 index 0000000000..f7e6e1759f --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityattribution_useractivityattribution_843413386.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.UserActivityAttribution.#ctor(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityAttribution.UserActivityAttribution + +## -description +Create a **UserActivityAttribution** object with the specified icon image URI. + +## -parameters +### -param iconUri +The Uniform Resource Identifier (URI) of the icon image to use with this **UserActivityAttribution**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivitychannel_deleteactivityasync_575188325.md b/windows.applicationmodel.useractivities/useractivitychannel_deleteactivityasync_575188325.md new file mode 100644 index 0000000000..4423e02b0d --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivitychannel_deleteactivityasync_575188325.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.UserActivityChannel.DeleteActivityAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityChannel.DeleteActivityAsync + +## -description +Delete a specific user activity. + +## -parameters +### -param activityId +The identifier of the user activity to delete. + +## -returns +An asynchronous action. + +## -remarks +You can get the identifier of the user activity from [UserActivity.ActivityId](useractivity_activityid.md). +## -see-also + +## -examples +```csharp +UserActivityChannel channel = UserActivityChannel.GetDefault(); +string activityId = "/article?" + article.Link; +channel.DeleteActivity(activityId); +``` diff --git a/windows.applicationmodel.useractivities/useractivitychannel_deleteallactivitiesasync_894001156.md b/windows.applicationmodel.useractivities/useractivitychannel_deleteallactivitiesasync_894001156.md new file mode 100644 index 0000000000..d64b622d74 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivitychannel_deleteallactivitiesasync_894001156.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.UserActivityChannel.DeleteAllActivitiesAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityChannel.DeleteAllActivitiesAsync + +## -description +Deletes all of the user activities registered by this app. + +## -returns +An asynchronous action. + +## -remarks + +## -see-also + +## -examples +```csharp +UserActivityChannel.GetDefault().DeleteAllActivities(); +``` diff --git a/windows.applicationmodel.useractivities/useractivitycontentinfo.md b/windows.applicationmodel.useractivities/useractivitycontentinfo.md new file mode 100644 index 0000000000..0954410df8 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivitycontentinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserActivities.UserActivityContentInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityContentInfo + +## -description +Represents the content metadata of this activity in JSON format. + +## -remarks +For example, if your activity was reading an RSS feed, the content might include the name of the article and its author. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivitycontentinfo_fromjson_656909294.md b/windows.applicationmodel.useractivities/useractivitycontentinfo_fromjson_656909294.md new file mode 100644 index 0000000000..09a2135077 --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivitycontentinfo_fromjson_656909294.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.UserActivityContentInfo.FromJson(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityContentInfo.FromJson + +## -description +Creates the **UserActivityContentInfo** from a JSON string. + +## -parameters +### -param value +The content to store in JSON format. + +## -returns +A **UserActivityContentInfo** that contains the JSON data. + +## -remarks + +## -see-also + +## -examples +```csharp +userActivity.ContentMetadata = UserActivityContentInfo.FromJson(@" + { + ""@context"": ""http://schema.org"", + ""@type"": ""Article"", + ""author"": ""John Doe"", + ""name"": ""How to Tie a Reef Knot"" + }"; +``` diff --git a/windows.applicationmodel.useractivities/useractivitycontentinfo_tojson_1289546151.md b/windows.applicationmodel.useractivities/useractivitycontentinfo_tojson_1289546151.md new file mode 100644 index 0000000000..c3e01e909d --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivitycontentinfo_tojson_1289546151.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.UserActivities.UserActivityContentInfo.ToJson +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityContentInfo.ToJson + +## -description +Provides the **UserActivityContentInfo** in the form of a JSON string. + +## -returns +The JSON content. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.useractivities/useractivityvisualelements_attribution.md b/windows.applicationmodel.useractivities/useractivityvisualelements_attribution.md new file mode 100644 index 0000000000..f4da6fe08a --- /dev/null +++ b/windows.applicationmodel.useractivities/useractivityvisualelements_attribution.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.UserActivities.UserActivityVisualElements.Attribution +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserActivities.UserActivityVisualElements.Attribution + +## -description +Gets or sets the visual information about a user activity. + +## -property-value +The visual information such as the URI for the icon, text used by screen readers, and so on. + +## -remarks +This visual information overrides the visual information that the system provides about the user activity. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md index 056145e77f..026d7584f4 100644 --- a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md +++ b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md @@ -10,7 +10,7 @@ public IAsyncOperation UserDataTaskListLimitedWriteOperations.TryDeleteTas # Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryDeleteTaskAsync ## -description -Asynchronously attempts to delete a meeting. +Asynchronously attempts to delete a task. ## -params ## -param userDataTaskId diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md index 43e3c50693..9d63901280 100644 --- a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md @@ -10,9 +10,10 @@ public DateTime LastSuccessfulSyncTime { get; set; } # Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.LastSuccessfulSyncTime ## -description +Gets or sets the last time the [UserDataTaskList](userdatatasklist.md) was successfully synced with the server. ## -property-value -The last time the [UserDataTaskList](userdatatasklist.md) was successfully synced with the server. +The last time the **UserDataTaskList** was successfully synced with the server. ## -remarks diff --git a/windows.applicationmodel/designmode_designmode2enabled.md b/windows.applicationmodel/designmode_designmode2enabled.md new file mode 100644 index 0000000000..a60f5a34e9 --- /dev/null +++ b/windows.applicationmodel/designmode_designmode2enabled.md @@ -0,0 +1,57 @@ +--- +-api-id: P:Windows.ApplicationModel.DesignMode.DesignMode2Enabled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DesignMode.DesignMode2Enabled + +## -description +Used to enable/disable user code inside a XAML designer that targets the Windows 10 Fall Creators Update SDK, or later. + +## -property-value +**True** if the user code is running inside the XAML designer for a project that targets the Windows 10 Fall Creators Update or later; otherwise **false**. + +## -remarks +Starting with the Fall Creators Update, Visual Studio supports a new XAML designer. Use this property to determine when your code is running in the new designer. + +Note that [Windows.ApplicationModel.DesignMode.DesignModeEnabled](designmode_designmodeenabled.md) returns **true** when your code runs inside any version of the XAML designer, regardless of which SDK version you target. Most users should use this check unless you need to know specifically that your code is running in the new designer. + +The following table lists the functionality differences between the legacy XAML designer and the new designer in the Fall Creators Update: + +| | Legacy designer | Fall Creators Update designer | +|-----------|:------------------:|:------------------:| +|[CoreWindow](https://docs.microsoft.com/en-us/uwp/api/windows.ui.core.corewindow) |:x:|:heavy_check_mark:| +|[CoreDispatcher](https://docs.microsoft.com/en-us/uwp/api/windows.ui.core.coredispatcher) |:x:|:heavy_check_mark:| +|Threading model | Single-threaded apartment (STA) | Application single-threaded apartment (ASTA) | +|.NET Framework | Desktop | Core | +|UI Composition support |:x:|:heavy_check_mark:| +|Acrylic brush support |:x:|:heavy_check_mark:| +|Fluent design system | Limited | Full support | + +> [!NOTE] +> This property is available only in the presence of a developer certificate. + +## -see-also + +## -examples +The following code only executes when running inside a XAML designer, regardless of the SDK the designer targets. We recommend this check for most users. + +```csharp +if (Windows.ApplicationModel.DesignMode.DesignModeEnabled) +{ + // Code to execute when running inside any version of the XAML designer +} +``` + +The following code only executes when running inside a XAML designer if your project targets the Windows 10 Fall Creators Update SDK or later. + +```csharp +if (Windows.ApplicationModel.DesignMode.DesignMode2Enabled) +{ + // Code to execute when running inside a XAML designer that targets the Fall Creators Update SDK, or later. +} +``` diff --git a/windows.applicationmodel/designmode_designmodeenabled.md b/windows.applicationmodel/designmode_designmodeenabled.md index 312b266a23..7e27b896f1 100644 --- a/windows.applicationmodel/designmode_designmodeenabled.md +++ b/windows.applicationmodel/designmode_designmodeenabled.md @@ -13,14 +13,10 @@ public bool DesignModeEnabled { get; } Gets a value that indicates whether the process is running in design mode. ## -property-value -True if the process is running in design mode; otherwise false. +**True** if the process is running in design mode; otherwise **false**. ## -remarks -Use the [DesignModeEnabled](designmode_designmodeenabled.md) property when your custom types require special logic when running in a visual designer. For example, a Windows Library for JavaScript control can query the [DesignModeEnabled](designmode_designmodeenabled.md) property to determine whether to display placeholder data instead of live data from a web service. - -Your in-process custom types can check the design mode setting of the current process. Also, internal custom types that are activated in another process can check whether their caller is in design mode. - - +Use the [DesignModeEnabled](designmode_designmodeenabled.md) property when your custom types require special logic when running in a visual designer. For example, you can query this property to determine whether to display placeholder data instead of live data from a web service. > [!NOTE] > The [DesignModeEnabled](designmode_designmodeenabled.md) property is available only in the presence of a developer certificate. diff --git a/windows.applicationmodel/packagecatalog.md b/windows.applicationmodel/packagecatalog.md index c627e5fb09..a193fea490 100644 --- a/windows.applicationmodel/packagecatalog.md +++ b/windows.applicationmodel/packagecatalog.md @@ -10,7 +10,7 @@ public class PackageCatalog : Windows.ApplicationModel.IPackageCatalog, Windows. # Windows.ApplicationModel.PackageCatalog ## -description -Provides access to appx packages on the device. +Provides access to app packages on the device. ## -remarks diff --git a/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md b/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md index 76fa18b8b1..3f6f835792 100644 --- a/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md +++ b/windows.applicationmodel/packagecatalog_openforcurrentuser_396595415.md @@ -10,7 +10,7 @@ public Windows.ApplicationModel.PackageCatalog OpenForCurrentUser() # Windows.ApplicationModel.PackageCatalog.OpenForCurrentUser ## -description -Opens the catalog of appx packages on the device that are available to the current user. +Opens the catalog of app packages on the device that are available to the current user. ## -returns The catalog of packages for the current user. diff --git a/windows.applicationmodel/packagecatalog_packageinstalling.md b/windows.applicationmodel/packagecatalog_packageinstalling.md index e867dc3b73..7c7a1a85ec 100644 --- a/windows.applicationmodel/packagecatalog_packageinstalling.md +++ b/windows.applicationmodel/packagecatalog_packageinstalling.md @@ -10,7 +10,7 @@ public event Windows.Foundation.TypedEventHandler PackageInstalling PackageCatalog.RemoveOptionalPackagesAsync(IIterable optionalPackageFamilyNames) +--> + +# Windows.ApplicationModel.PackageCatalog.RemoveOptionalPackagesAsync + +## -description +Removes installed optional app packages from the user account. + +## -parameters + +### -param optionalPackageFamilyNames +A list of optional package family name strings. + +## -returns +The result of removing the optional package in the form of: [PackageCatalogRemoveOptionalPackagesResult](https://docs.microsoft.com/uwp/api/windows.applicationmodel.packagecatalogremoveoptionalpackagesresult). + +## -remarks +A package family name can be found in the FamilyName property of the [PackageId](https://docs.microsoft.com/uwp/api/windows.applicationmodel.packageid). + +## -see-also + +## -examples +This sample demonstrates removing all of the optional packages from a main app package. + +```csharp +public async void RemoveOptionalPackages() +{ + // Create a list of the optional package family names + List optionalPackageList = new List(); + foreach (var package in Windows.ApplicationModel.Package.Current.Dependencies) + { + if (package.IsOptional) + { + optionalPackageList.Add(package.Id.FamilyName); + } + } + + // Remove the optional packages from the list + PackageCatalog catalog = Windows.ApplicationModel.PackageCatalog.OpenForCurrentPackage(); + var removalResult = await catalog.RemoveOptionalPackagesAsync(optionalPackageList); + if (removalResult.ExtendedError != null) + { + throw removalResult.ExtendedError; + } +} +``` + diff --git a/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult.md b/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult.md new file mode 100644 index 0000000000..e8fab72d35 --- /dev/null +++ b/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.PackageCatalogRemoveOptionalPackagesResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.PackageCatalogRemoveOptionalPackagesResult + +## -description +Provides information on the status of removing optional packages. + +## -remarks + +## -see-also +[PackageCatalog](https://docs.microsoft.com/uwp/api/windows.applicationmodel.packagecatalog) + +## -examples + diff --git a/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult_extendederror.md b/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult_extendederror.md new file mode 100644 index 0000000000..19c43b89d6 --- /dev/null +++ b/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageCatalogRemoveOptionalPackagesResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageCatalogRemoveOptionalPackagesResult.ExtendedError + +## -description +Contains the extended error information for removing optional packages. + +## -property-value +The extended error information. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult_packagesremoved.md b/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult_packagesremoved.md new file mode 100644 index 0000000000..fb3b5290d9 --- /dev/null +++ b/windows.applicationmodel/packagecatalogremoveoptionalpackagesresult_packagesremoved.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageCatalogRemoveOptionalPackagesResult.PackagesRemoved +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageCatalogRemoveOptionalPackagesResult.PackagesRemoved + +## -description +A list of the optional packages that were successfully removed from the user account. + +## -property-value +A list of optional packages that were removed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel/packageinstallingeventargs_iscomplete.md b/windows.applicationmodel/packageinstallingeventargs_iscomplete.md index 81f912dd78..8f00e8e273 100644 --- a/windows.applicationmodel/packageinstallingeventargs_iscomplete.md +++ b/windows.applicationmodel/packageinstallingeventargs_iscomplete.md @@ -10,10 +10,10 @@ public bool IsComplete { get; } # Windows.ApplicationModel.PackageInstallingEventArgs.IsComplete ## -description -Indicates whether the appx package is done installing. +Indicates whether the app package is done installing. ## -property-value -**True** indicates that the appx package is done installing; **false**, otherwise. +**True** indicates that the app package is done installing; **false**, otherwise. ## -remarks diff --git a/windows.applicationmodel/packagestagingeventargs.md b/windows.applicationmodel/packagestagingeventargs.md index 72061342b2..b29d6d61d3 100644 --- a/windows.applicationmodel/packagestagingeventargs.md +++ b/windows.applicationmodel/packagestagingeventargs.md @@ -13,7 +13,7 @@ public class PackageStagingEventArgs : Windows.ApplicationModel.IPackageStagingE Provides information about the optional package that is being staged. ## -remarks -An appx package is staged when it is added to the device but is not yet registered. +An app package is staged when it is added to the device but is not yet registered. Apps only receive package events for their optional packages. diff --git a/windows.applicationmodel/packagestagingeventargs_iscomplete.md b/windows.applicationmodel/packagestagingeventargs_iscomplete.md index 9e571462bc..d761bad25a 100644 --- a/windows.applicationmodel/packagestagingeventargs_iscomplete.md +++ b/windows.applicationmodel/packagestagingeventargs_iscomplete.md @@ -10,10 +10,10 @@ public bool IsComplete { get; } # Windows.ApplicationModel.PackageStagingEventArgs.IsComplete ## -description -Indicates whether the appx package is done staging. +Indicates whether the app package is done staging. ## -property-value -**True** indicates that the appx package is done staging; **false**, otherwise. +**True** indicates that the app package is done staging; **false**, otherwise. ## -remarks diff --git a/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md b/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md index f757de4239..2a943f5d03 100644 --- a/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md +++ b/windows.applicationmodel/packageuninstallingeventargs_iscomplete.md @@ -10,10 +10,10 @@ public bool IsComplete { get; } # Windows.ApplicationModel.PackageUninstallingEventArgs.IsComplete ## -description -Indicates whether the appx package is done uninstalling. +Indicates whether the app package is done uninstalling. ## -property-value -**True** indicates that the appx package is done uninstalling; **false**, otherwise. +**True** indicates that the app package is done uninstalling; **false**, otherwise. ## -remarks diff --git a/windows.applicationmodel/packageupdatingeventargs_iscomplete.md b/windows.applicationmodel/packageupdatingeventargs_iscomplete.md index 412eb62d5d..85f5185625 100644 --- a/windows.applicationmodel/packageupdatingeventargs_iscomplete.md +++ b/windows.applicationmodel/packageupdatingeventargs_iscomplete.md @@ -10,10 +10,10 @@ public bool IsComplete { get; } # Windows.ApplicationModel.PackageUpdatingEventArgs.IsComplete ## -description -Indicates whether the appx package is done updating. +Indicates whether the app package is done updating. ## -property-value -**True** if the appx package is done updating; **false** otherwise. +**True** if the app package is done updating; **false** otherwise. ## -remarks diff --git a/windows.applicationmodel/startuptask.md b/windows.applicationmodel/startuptask.md index ae457adb6a..6538484e29 100644 --- a/windows.applicationmodel/startuptask.md +++ b/windows.applicationmodel/startuptask.md @@ -10,9 +10,31 @@ public class StartupTask : Windows.ApplicationModel.IStartupTask # Windows.ApplicationModel.StartupTask ## -description -Represents a background task that runs automatically whenever the user logs on to their device. +Represents a background task that runs automatically whenever the user logs in to their device. ## -remarks +This functionality is only supported on Windows Desktop. + +An app must register for the "windows.startup" extension category in its manifest to be activated at startup or when a user logs in. Although this does not automatically make the app activatable at startup. The user must first launch the app, and the app must request to be enabled for startup activation, which will trigger a user-consent prompt. + +```xml +desktop:Extension + Category="windows.startupTask" + Executable="bin\MyStartupTask.exe" + EntryPoint="Windows.FullTrustApplication"> + + +``` + +**Extension Category** must have the value "windows.startupTask" +**Extension Executable** is the relative path to the .exe to start +**Extension EntryPoint** must have the value "Windows.FullTrustApplication" +**StartupTask TaskId** is a unique identifier for your task. Using this identifier, your app can call the APIs in the Windows.ApplicationModel.StartupTask class to programmatically enable or disable a startup task. +**StartupTask Enabled** indicates whether the task first starts enabled or disabled. Enabled tasks will run the next time the user logs on (unless the user disables it). +**StartupTask DisplayName** is the name of the task that appears in Task Manager. ## -examples diff --git a/windows.applicationmodel/startuptask_requestenableasync_1565937345.md b/windows.applicationmodel/startuptask_requestenableasync_1565937345.md index 1fc2840e36..1bf187a1d6 100644 --- a/windows.applicationmodel/startuptask_requestenableasync_1565937345.md +++ b/windows.applicationmodel/startuptask_requestenableasync_1565937345.md @@ -10,7 +10,7 @@ public Windows.Foundation.IAsyncOperation -# Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.BytesSent - +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.BytesSent + ## -description +Gets the bytes that were sent. ## -property-value +The bytes that were sent. ## -remarks diff --git a/windows.devices.bluetooth/bluetoothdevice_bluetoothdeviceid.md b/windows.devices.bluetooth/bluetoothdevice_bluetoothdeviceid.md index 337461ca2d..8d83a7c886 100644 --- a/windows.devices.bluetooth/bluetoothdevice_bluetoothdeviceid.md +++ b/windows.devices.bluetooth/bluetoothdevice_bluetoothdeviceid.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.BluetoothDeviceId --api-type: winrt property ---- - +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDevice.BluetoothDeviceId +-api-type: winrt property +--- + -# Windows.Devices.Bluetooth.BluetoothDevice.BluetoothDeviceId - +# Windows.Devices.Bluetooth.BluetoothDevice.BluetoothDeviceId + ## -description +Gets the bluetooth device ID. ## -property-value +The bluetooth device ID. ## -remarks diff --git a/windows.devices.bluetooth/bluetoothdevice_deviceid.md b/windows.devices.bluetooth/bluetoothdevice_deviceid.md index ccff7cc4c3..2c1511e037 100644 --- a/windows.devices.bluetooth/bluetoothdevice_deviceid.md +++ b/windows.devices.bluetooth/bluetoothdevice_deviceid.md @@ -11,7 +11,7 @@ public string DeviceId { get; } # Windows.Devices.Bluetooth.BluetoothDevice.DeviceId ## -description -Gets the device ID. +Gets the device ID that came from the Windows.Devices.Enumeration.DeviceInformation.Id ## -property-value The ID of the device. diff --git a/windows.devices.bluetooth/bluetoothdeviceid_fromid_114571398.md b/windows.devices.bluetooth/bluetoothdeviceid_fromid_114571398.md index 214bb79bb0..86cb7cd67d 100644 --- a/windows.devices.bluetooth/bluetoothdeviceid_fromid_114571398.md +++ b/windows.devices.bluetooth/bluetoothdeviceid_fromid_114571398.md @@ -1,18 +1,20 @@ ---- --api-id: M:Windows.Devices.Bluetooth.BluetoothDeviceId.FromId(System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothDeviceId.FromId(System.String) +-api-type: winrt method +--- + -# Windows.Devices.Bluetooth.BluetoothDeviceId.FromId - +# Windows.Devices.Bluetooth.BluetoothDeviceId.FromId + ## -description +Creates a BluetoothDeviceId object from the device ID. ## -parameters ### -param deviceId +The device ID. ## -returns diff --git a/windows.devices.bluetooth/bluetoothledevice_bluetoothdeviceid.md b/windows.devices.bluetooth/bluetoothledevice_bluetoothdeviceid.md index 8edc2e7d9f..a03f1542d2 100644 --- a/windows.devices.bluetooth/bluetoothledevice_bluetoothdeviceid.md +++ b/windows.devices.bluetooth/bluetoothledevice_bluetoothdeviceid.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothDeviceId --api-type: winrt property ---- - +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothDeviceId +-api-type: winrt property +--- + -# Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothDeviceId - +# Windows.Devices.Bluetooth.BluetoothLEDevice.BluetoothDeviceId + ## -description +Gets the bluetooth device ID. ## -property-value +The bluetooth device ID. ## -remarks diff --git a/windows.devices.geolocation/geovisit.md b/windows.devices.geolocation/geovisit.md new file mode 100644 index 0000000000..8debe66527 --- /dev/null +++ b/windows.devices.geolocation/geovisit.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Devices.Geolocation.Geovisit +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.Geovisit + +## -description +Represents a Visit-related state change. See [Guidelines for using Visits tracking](https://docs.microsoft.com/windows/uwp/maps-and-location/guidelines-for-geofencing) for information on how to use this feature. + +## -remarks +This class is instantiated whenever a Visit-related state change has been obtained by the app. + +## -see-also +[GeovisitMonitor](GeovisitMonitor.md) +[GeovisitTrigger](https://docs.microsoft.com/uwp/api/windows.applicationmodel.background.geovisittrigger) + +## -examples + diff --git a/windows.devices.geolocation/geovisit_position.md b/windows.devices.geolocation/geovisit_position.md new file mode 100644 index 0000000000..0aebef155d --- /dev/null +++ b/windows.devices.geolocation/geovisit_position.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Geolocation.Geovisit.Position +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geovisit.Position + +## -description +Gets the location where this Visit-related state change took place. + +## -property-value +The location of the Visit-related state change. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisit_statechange.md b/windows.devices.geolocation/geovisit_statechange.md new file mode 100644 index 0000000000..324c898e6d --- /dev/null +++ b/windows.devices.geolocation/geovisit_statechange.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Geolocation.Geovisit.StateChange +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geovisit.StateChange + +## -description +Gets the type of state change that this [Geovisit](Geovisit.md) instance represents. + +## -property-value +A [VisitStateChange](VisitStateChange.md) value representing the type of change. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisit_timestamp.md b/windows.devices.geolocation/geovisit_timestamp.md new file mode 100644 index 0000000000..d9000e131b --- /dev/null +++ b/windows.devices.geolocation/geovisit_timestamp.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Geolocation.Geovisit.Timestamp +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.Geovisit.Timestamp + +## -description +Gets the time that this Visit-related state change happened. + +## -property-value +A [DateTime](https://docs.microsoft.com/uwp/api/windows.foundation.datetime) instance representing the time the state change happened. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor.md b/windows.devices.geolocation/geovisitmonitor.md new file mode 100644 index 0000000000..e2b685572f --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Devices.Geolocation.GeovisitMonitor +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor + +## -description +Handles the monitoring of a user's Visits without the use of background tasks. + +## -remarks + +## -see-also +[Geovisit](Geovisit.md) + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor_geovisitmonitor_1221375020.md b/windows.devices.geolocation/geovisitmonitor_geovisitmonitor_1221375020.md new file mode 100644 index 0000000000..0a443f6453 --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor_geovisitmonitor_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Devices.Geolocation.GeovisitMonitor.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor.GeovisitMonitor + +## -description +Initializes an instance of [GeovisitMonitor](GeovisitMonitor.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor_getlastreportasync_1716102232.md b/windows.devices.geolocation/geovisitmonitor_getlastreportasync_1716102232.md new file mode 100644 index 0000000000..6f54888d04 --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor_getlastreportasync_1716102232.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Geolocation.GeovisitMonitor.GetLastReportAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor.GetLastReportAsync + +## -description +Retrieves the latest Visit-related event the user has completed. + +## -returns +An asynchronous operation with a [Geovisit](Geovisit.md) instance representing the user's latest Visit. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor_monitoringscope.md b/windows.devices.geolocation/geovisitmonitor_monitoringscope.md new file mode 100644 index 0000000000..5714642105 --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor_monitoringscope.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Geolocation.GeovisitMonitor.MonitoringScope +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor.MonitoringScope + +## -description +Gets and the scope of Visits to monitor. + +## -property-value +A [VisitMonitoringScope](VisitMonitoringScope.md) value representing the scope of location monitoring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor_start_2001324547.md b/windows.devices.geolocation/geovisitmonitor_start_2001324547.md new file mode 100644 index 0000000000..609eaa4723 --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor_start_2001324547.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.Geolocation.GeovisitMonitor.Start(Windows.Devices.Geolocation.VisitMonitoringScope) +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor.Start + +## -description +Begins monitoring for Visit-related events. + +## -parameters +### -param value +A [VisitMonitoringScope](VisitMonitoringScope.md) value representing the intended scope of location monitoring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor_stop_1201535524.md b/windows.devices.geolocation/geovisitmonitor_stop_1201535524.md new file mode 100644 index 0000000000..a41e825422 --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor_stop_1201535524.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Devices.Geolocation.GeovisitMonitor.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor.Stop + +## -description +Stops monitoring for Visit-related events. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitmonitor_visitstatechanged.md b/windows.devices.geolocation/geovisitmonitor_visitstatechanged.md new file mode 100644 index 0000000000..2440ed3439 --- /dev/null +++ b/windows.devices.geolocation/geovisitmonitor_visitstatechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Geolocation.GeovisitMonitor.VisitStateChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Geolocation.GeovisitMonitor.VisitStateChanged + +## -description +Raised when the user's current Visit state has changed, provided this [GeovisitMonitor](GeovisitMonitor.md) is actively monitoring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisitstatechangedeventargs.md b/windows.devices.geolocation/geovisitstatechangedeventargs.md new file mode 100644 index 0000000000..239a72a0d8 --- /dev/null +++ b/windows.devices.geolocation/geovisitstatechangedeventargs.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.Devices.Geolocation.GeovisitStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.GeovisitStateChangedEventArgs + +## -description +Contains information about a [VisitStateChanged](GeovisitMonitor_VisitStateChanged.md) event. + +## -remarks +This class is instantiated when a [VisitStateChanged](GeovisitMonitor_VisitStateChanged.md) event is raised. + +## -see-also +[Geovisit](Geovisit.md) + +## -examples + diff --git a/windows.devices.geolocation/geovisitstatechangedeventargs_visit.md b/windows.devices.geolocation/geovisitstatechangedeventargs_visit.md new file mode 100644 index 0000000000..f8e09a01dc --- /dev/null +++ b/windows.devices.geolocation/geovisitstatechangedeventargs_visit.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Geolocation.GeovisitStateChangedEventArgs.Visit +-api-type: winrt property +--- + + + +# Windows.Devices.Geolocation.GeovisitStateChangedEventArgs.Visit + +## -description +Gets the Visit-related event corresponding to a [VisitStateChanged](GeovisitMonitor_VisitStateChanged.md) event that was raised. + +## -property-value +A [Geovisit](Geovisit.md) instance representing the Visit-related event that denotes a change in state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/geovisittriggerdetails.md b/windows.devices.geolocation/geovisittriggerdetails.md new file mode 100644 index 0000000000..2759bce72d --- /dev/null +++ b/windows.devices.geolocation/geovisittriggerdetails.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Devices.Geolocation.GeovisitTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Geolocation.GeovisitTriggerDetails + +## -description +Manages the details of a trigger for a Visits-related background task. + +## -remarks + +## -see-also +[Geovisit](Geovisit.md) + +## -examples + diff --git a/windows.devices.geolocation/geovisittriggerdetails_readreports_231406138.md b/windows.devices.geolocation/geovisittriggerdetails_readreports_231406138.md new file mode 100644 index 0000000000..d9c3eb260f --- /dev/null +++ b/windows.devices.geolocation/geovisittriggerdetails_readreports_231406138.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Geolocation.GeovisitTriggerDetails.ReadReports +-api-type: winrt method +--- + + + +# Windows.Devices.Geolocation.GeovisitTriggerDetails.ReadReports + +## -description +Gets a list of Visit-related state changes that the user has logged since they were last queried. + +## -returns +An [IVectorView](https://docs.microsoft.com/uwp/api/windows.foundation.collections.ivectorview_t_) of [Geovisit](Geovisit.md) instances representing the user's Visit-related state changes, starting with the earliest entries. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.geolocation/visitmonitoringscope.md b/windows.devices.geolocation/visitmonitoringscope.md new file mode 100644 index 0000000000..8bb5501b9c --- /dev/null +++ b/windows.devices.geolocation/visitmonitoringscope.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.Geolocation.VisitMonitoringScope +-api-type: winrt enum +--- + + + +# Windows.Devices.Geolocation.VisitMonitoringScope + +## -description +Contains values that describe the intended scope of location monitoring for use with the Visits feature. + +## -enum-fields +### -field Venue:0 +Monitor the Visist-related events that concern changes in buildings. + +### -field City:1 +Monitor only the Visit-related events that concern changes in cities. + +## -remarks +A value must be specified when setting up a [GeovisitTrigger](https://docs.microsoft.com/uwp/api/windows.applicationmodel.background.geovisittrigger) or [GeovisitMonitor](GeovisitMonitor.md), in order to determine which Visit-related events will be processed. + +## -see-also +[GeovisitMonitor](GeovisitMonitor.md) +[GeovisitTrigger](https://docs.microsoft.com/uwp/api/windows.applicationmodel.background.geovisittrigger) + +## -examples + diff --git a/windows.devices.geolocation/visitstatechange.md b/windows.devices.geolocation/visitstatechange.md new file mode 100644 index 0000000000..ac70bcef57 --- /dev/null +++ b/windows.devices.geolocation/visitstatechange.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.Devices.Geolocation.VisitStateChange +-api-type: winrt enum +--- + + + +# Windows.Devices.Geolocation.VisitStateChange + +## -description +Contains values that describe a Visit-related state change. + +## -enum-fields +### -field TrackingLost:0 +The device is unable to track location at this time. + +### -field OtherMovement:3 +The user moved significantly since the last Visit, but has not entered a new Visit. + +### -field Departed:2 +The user departed from a Visit. + +### -field Arrived:1 +The user arrived at a Visit. + +## -remarks + +## -see-also +[Geovisit](Geovisit.md) + +## -examples + diff --git a/windows.devices.humaninterfacedevice/windows_devices_humaninterfacedevice.md b/windows.devices.humaninterfacedevice/windows_devices_humaninterfacedevice.md index d8debcdfdb..48fde41abd 100644 --- a/windows.devices.humaninterfacedevice/windows_devices_humaninterfacedevice.md +++ b/windows.devices.humaninterfacedevice/windows_devices_humaninterfacedevice.md @@ -22,9 +22,6 @@ This namespace supports most HID devices. However, it blocks the top-level appli + HID_USAGE_PAGE_CONSUMER + HID_USAGE_PAGE_DIGITIZER + HID_USAGE_PAGE_SENSOR -+ HID_USAGE_PAGE_BARCODE_SCANNER -+ HID_USAGE_PAGE_WEIGHING_DEVICE -+ HID_USAGE_PAGE_MAGNETIC_STRIPE_READER + HID_USAGE_PAGE_TELEPHONY diff --git a/windows.devices.pointofservice/claimedlinedisplay.md b/windows.devices.pointofservice/claimedlinedisplay.md index 14d7ffcb5a..de9efea1f0 100644 --- a/windows.devices.pointofservice/claimedlinedisplay.md +++ b/windows.devices.pointofservice/claimedlinedisplay.md @@ -13,7 +13,7 @@ public class ClaimedLineDisplay : IClosable Represents a claimed line display device. ## -remarks -This object is created when the [LineDisplay.ClaimAsync](linedisplay_claimasync.md) method completes. Unlike other peripherals, the EnableAsync() method has been removed for line displays; Instead, the device is implicitly enabled whenever commands are sent that require the line display to be in an enabled state. +This object can be constructed directly, or by using [LineDisplay.ClaimAsync](linedisplay_claimasync.md). Unlike other peripherals, the EnableAsync() method has been removed for line displays. Instead, the device is implicitly enabled whenever commands are sent that require the line display to be in an enabled state. ## -see-also diff --git a/windows.devices.pointofservice/claimedlinedisplay_checkhealthasync_1543183748.md b/windows.devices.pointofservice/claimedlinedisplay_checkhealthasync_1543183748.md new file mode 100644 index 0000000000..4b399ae230 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_checkhealthasync_1543183748.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.CheckHealthAsync(Windows.Devices.PointOfService.UnifiedPosHealthCheckLevel) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.CheckHealthAsync + +## -description +Gets the device's health state asynchronously. + +## -parameters +### -param level +The specified health check level. + +## -returns +This value is intended to be reflected in the app interface immediately so the user of the app can interpret it. For example, it will return “OK” as the health string if the device state is good. + +## -remarks +This feature behaves identically to corresponding features in the other POS peripherals, and support for this operation is required by the UPOS standard. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_checkpowerstatusasync_1107655958.md b/windows.devices.pointofservice/claimedlinedisplay_checkpowerstatusasync_1107655958.md new file mode 100644 index 0000000000..78ca5b3a2a --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_checkpowerstatusasync_1107655958.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.CheckPowerStatusAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.CheckPowerStatusAsync + +## -description +Gets the current power status of the device. + +## -returns +The current power status of the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_customglyphs.md b/windows.devices.pointofservice/claimedlinedisplay_customglyphs.md new file mode 100644 index 0000000000..c8db4c469b --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_customglyphs.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.CustomGlyphs +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.CustomGlyphs + +## -description +Gets the line display's custom glyph list, if the feature is supported. + +## -property-value +The line display's [LineDisplayCustomGlyphs](LineDisplayCustomGlyphs.md) object. + +## -remarks +When CanDisplayCustomGlyphs is True this property holds the LineDisplayCustomGlyphs object for this line display device. When Capabilities.CanDisplayCustomGlyphs is set to False this property is set to null. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_getattributes_262223912.md b/windows.devices.pointofservice/claimedlinedisplay_getattributes_262223912.md new file mode 100644 index 0000000000..d82aa6b73b --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_getattributes_262223912.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.GetAttributes +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.GetAttributes + +## -description +Gets the attributes of the line display. + +## -returns +The attributes of the line display. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_getstatisticsasync_980600774.md b/windows.devices.pointofservice/claimedlinedisplay_getstatisticsasync_980600774.md new file mode 100644 index 0000000000..59d68e0be4 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_getstatisticsasync_980600774.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.GetStatisticsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.GetStatisticsAsync + +## -description +Retrieves the requested statistics from the line display. + +## -parameters +### -param statisticsCategories +The list of statistics to retrieve. ++ An empty list retrieves all statistics. ++ To retrieve specific statistics defined by the manufacturer, include the manufacturer-specified statistic names such as "name1" or "name2". ++ Include [LineDisplayStatisticsCategorySelector.ManufacturerStatistics](linedisplaystatisticscategoryselector_manufacturerstatistics.md) and [LineDisplayStatisticsCategorySelector.UnifiedPosStatistics](linedisplaystatisticscategoryselector_unifiedposstatistics.md) to retrieve manufacturer-specific and UnifiedPOS statistics respectively. + +## -returns +An XML string representing the requested statistics. + +## -remarks + +## -see-also +[LineDisplayStatisticsCategorySelector](linedisplaystatisticscategoryselector.md) + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_maxbitmapsizeinpixels.md b/windows.devices.pointofservice/claimedlinedisplay_maxbitmapsizeinpixels.md new file mode 100644 index 0000000000..55214abfbe --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_maxbitmapsizeinpixels.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.MaxBitmapSizeInPixels +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.MaxBitmapSizeInPixels + +## -description +Gets the maximum bitmap size. + +## -property-value +The maximum bitmap size in pixels. + +## -remarks +When bitmaps are supported (when [LineDisplayCapabilities.CanDisplayBitmaps](LineDisplayCapabilities_CanDisplayBitmaps.md) is True) this read-only property describes the size of the screen that can display bitmaps as number of horizontal and vertical pixels. The maximum number of pixels in each direction is 65,535. When bitmaps are not supported by the device ([LineDisplayCapabilities.CanDisplayBitmaps](LineDisplayCapabilities_CanDisplayBitmaps.md) is False) the value of this property is {0, 0}. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_statusupdated.md b/windows.devices.pointofservice/claimedlinedisplay_statusupdated.md new file mode 100644 index 0000000000..a6127cd105 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_statusupdated.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedLineDisplay.StatusUpdated +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.StatusUpdated + +## -description +Notifies the application that there is a change in the power status of the line display. + +## -remarks +The event values are the same as the values returned by [CheckPowerStatusAsync](claimedlinedisplay_checkpowerstatusasync). + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_supportedcharactersets.md b/windows.devices.pointofservice/claimedlinedisplay_supportedcharactersets.md new file mode 100644 index 0000000000..8c19df9623 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_supportedcharactersets.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.SupportedCharacterSets +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.SupportedCharacterSets + +## -description +Gets the character sets supported by the line display. + +## -property-value +The character set numbers supported. + +## -remarks +Each character set is identified by a number which may be either a device-specific character set number or a code page, including 997 (Unicode), ASCII (998) and ANSI (999). + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_supportedscreensizesincharacters.md b/windows.devices.pointofservice/claimedlinedisplay_supportedscreensizesincharacters.md new file mode 100644 index 0000000000..045389dffa --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_supportedscreensizesincharacters.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.SupportedScreenSizesInCharacters +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.SupportedScreenSizesInCharacters + +## -description +Gets the screen sizes supported by the line display. + +## -property-value +A list containting the sizes that the device supports. Each size is represented as a pair of rows and columns. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_trycleardescriptorsasync_1093801933.md b/windows.devices.pointofservice/claimedlinedisplay_trycleardescriptorsasync_1093801933.md new file mode 100644 index 0000000000..da86e0dcfc --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_trycleardescriptorsasync_1093801933.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TryClearDescriptorsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TryClearDescriptorsAsync + +## -description +Attempts to asynchronously clear all descriptions. + +## -returns +Returns True if all descriptors are successfully cleared; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_trycreatewindowasync_796137436.md b/windows.devices.pointofservice/claimedlinedisplay_trycreatewindowasync_796137436.md new file mode 100644 index 0000000000..bc7e5066f0 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_trycreatewindowasync_796137436.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TryCreateWindowAsync(Windows.Foundation.Rect,Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TryCreateWindowAsync + +## -description +Attempts to asynchronously create a [LineDisplayWindow](linedisplaywindow.md). + +## -parameters +### -param viewport +The viewport’s origin device row, origin device column, width in rows and height in columns. + +### -param windowSize +The numbers of rows and the number of columns in the window. + +## -returns +A new [LineDisplayWindow](linedisplaywindow.md) object, representing a new window for the device. + +## -remarks +When [LineDisplayCapabiliaties.SupportedWindows](LineDisplayCapabiliaties_SupportedWindows.md) is greater than 0 this method can be called to create a new [LineDisplayWindow](linedisplaywindow.md) object representing a new window for the device. The new window is not automatically set as the current window when it is created, to set that window as current set the [LineDisplayAttributes.CurrentWindow](LineDisplayAttributes_CurrentWindow.md) property to point to this [LineDisplayWindow](linedisplaywindow.md) object, or on that same [LineDisplayWindow](linedisplaywindow.md) object call its [TryRefreshAsync](linedisplaywindow_tryrefreshasync_1864090804.md) method. + +Calling this method when [LineDisplayCapabiliaties.SupportedWindows](LineDisplayCapabilities_SupportedWindows.md) is 0 will result in an exception. + +The window size must be at least as large as the viewport size, and it may be larger than its viewport in at most one direction. When [LineDisplayCapabilities.IsVerticalMarqueeSupported](LineDisplayCapabilities_IsVerticalMarqueeSupported.md) is True, the window may be larger than the viewport in the vertical dimension. When [LineDisplayCapabilities.IsHorizontalMarqueeSupported](LineDisplayCapabilities_IsHorizontalMarqueeSupported.md) is True, the window may be larger than the viewport in the horizontal dimension. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_trysetdescriptorasync_1262854382.md b/windows.devices.pointofservice/claimedlinedisplay_trysetdescriptorasync_1262854382.md new file mode 100644 index 0000000000..98620c6213 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_trysetdescriptorasync_1262854382.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TrySetDescriptorAsync(System.UInt32,Windows.Devices.PointOfService.LineDisplayDescriptorState) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TrySetDescriptorAsync + +## -description +Attempts to asynchronously set a descriptor using the specified attribute. + + + +## -parameters +### -param descriptor +The descriptor to be set. Must have a value between 0 and [LineDisplayCapabilities.SupportedDescriptors](LineDisplayCapabilities_SupportedDescriptors.md) - 1. + +### -param descriptorState +The state to give to the descriptor. + +## -returns +Returns True if the descriptor was set successfully; otherwise, False. + +## -remarks +[LineDisplayCapabilities.SupportedDescriptors](LineDisplayCapabilities_SupportedDescriptors.md) must be greater than zero for this method to be successfully executed. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_1594086865.md b/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_1594086865.md new file mode 100644 index 0000000000..552d135f8c --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_1594086865.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TryStoreStorageFileBitmapAsync(Windows.Storage.StorageFile,Windows.Devices.PointOfService.LineDisplayHorizontalAlignment,Windows.Devices.PointOfService.LineDisplayVerticalAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TryStoreStorageFileBitmapAsync + +## -description +Attempts to asynchronously store a bitmap image from a [StorageFile](../windows.storage/storagefile.md) for later display on the line display device. + +## -parameters +### -param bitmap +A [StorageFile](../windows.storage/storagefile.md) that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats. + +### -param horizontalAlignment +Determines how the bitmap will be horizontally aligned relative to its originating character cell. + +### -param verticalAlignment +Determines how the bitmap will be vertically aligned relative to its originating character cell. + +## -returns +True if the bitmap is stored successfully, False if a failure occurs. + +## -remarks +- The bitmap [StorageFile](../windows.storage/storagefile.md) must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception. +- Calling this method when [LineDisplayCapabiliaties.CanDisplayBitmaps](LineDisplayCapabilities_CanDisplayBitmaps.md) is False will result in an exception. +- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using [LineDisplayStoredBitmap.TryDeleteAsync](linedisplaystoredbitmap_trydeleteasync_41251962.md). + +## -see-also +[LineDisplayStoredBitmap.EscapeSequence](LineDisplayStoredBitmap_EscapeSequence.md) +[LineDisplayWindow.TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap)](linedisplaywindow_trydisplaystoredbitmapatcursorasync_100389007.md) +[LineDisplayStoredBitmap.TryDeleteAsync()](linedisplaystoredbitmap_trydeleteasync_41251962.md) + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_2059661295.md b/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_2059661295.md new file mode 100644 index 0000000000..171fcd7f09 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_2059661295.md @@ -0,0 +1,45 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TryStoreStorageFileBitmapAsync(Windows.Storage.StorageFile,Windows.Devices.PointOfService.LineDisplayHorizontalAlignment,Windows.Devices.PointOfService.LineDisplayVerticalAlignment,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TryStoreStorageFileBitmapAsync + +## -description +Attempts to asynchronously store a bitmap image from a [StorageFile](../windows.storage/storagefile.md) for later display on the line display device. + +## -parameters +### -param bitmap +A [StorageFile](../windows.storage/storagefile.md) that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats. + +### -param horizontalAlignment +Determines how the bitmap will be horizontally aligned relative to its originating character cell. + +### -param verticalAlignment +Determines how the bitmap will be vertically aligned relative to its originating character cell. + +### -param widthInPixels +The displayed bitmap width in pixels, if different from the original bitmap width. Height will be calculated proportionally. + +## -returns +True if the bitmap is stored successfully, False if a failure occurs. + +## -remarks +- The bitmap [StorageFile](../windows.storage/storagefile.md) must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception. +- Calling this method when [LineDisplayCapabiliaties.CanDisplayBitmaps](LineDisplayCapabilities_CanDisplayBitmaps.md) is False will result in an exception. +- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using [LineDisplayStoredBitmap.TryDeleteAsync](linedisplaystoredbitmap_trydeleteasync_41251962.md). +- Passing a bitmap width greater than [ClaimedLineDisplay.MaxBitmapSizeInPixels](claimedlinedisplay_maxbitmapsizeinpixels.md) will result in an exception. + +## -see-also +[LineDisplayStoredBitmap.EscapeSequence](LineDisplayStoredBitmap_EscapeSequence.md) +[LineDisplayWindow.TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap)](linedisplaywindow_trydisplaystoredbitmapatcursorasync_100389007.md) +[LineDisplayStoredBitmap.TryDeleteAsync()](linedisplaystoredbitmap_trydeleteasync_41251962.md) + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_649753029.md b/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_649753029.md new file mode 100644 index 0000000000..62c2fc8be5 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_trystorestoragefilebitmapasync_649753029.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TryStoreStorageFileBitmapAsync(Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TryStoreStorageFileBitmapAsync + +## -description +Attempts to asynchronously store a bitmap image from a [StorageFile](../windows.storage/storagefile.md) for later display on the line display device. + +## -parameters +### -param bitmap +A [StorageFile](../windows.storage/storagefile.md) that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats. + +## -returns +True if the bitmap is stored successfully, False if a failure occurs. + +## -remarks +- The bitmap [StorageFile](../windows.storage/storagefile.md) must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception. +- Calling this method when [LineDisplayCapabiliaties.CanDisplayBitmaps](LineDisplayCapabilities_CanDisplayBitmaps.md) is False will result in an exception. +- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using [LineDisplayStoredBitmap.TryDeleteAsync](linedisplaystoredbitmap_trydeleteasync_41251962.md). + +## -see-also +[LineDisplayStoredBitmap.EscapeSequence](LineDisplayStoredBitmap_EscapeSequence.md) +[LineDisplayWindow.TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap)](linedisplaywindow_trydisplaystoredbitmapatcursorasync_100389007.md) +[LineDisplayStoredBitmap.TryDeleteAsync()](linedisplaystoredbitmap_trydeleteasync_41251962.md) + +## -examples + diff --git a/windows.devices.pointofservice/claimedlinedisplay_tryupdateattributesasync_1303674463.md b/windows.devices.pointofservice/claimedlinedisplay_tryupdateattributesasync_1303674463.md new file mode 100644 index 0000000000..5f370e601b --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_tryupdateattributesasync_1303674463.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.TryUpdateAttributesAsync(Windows.Devices.PointOfService.LineDisplayAttributes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.TryUpdateAttributesAsync + +## -description +Updates the device attributes. + +## -parameters +### -param attributes +The updated attributes to be applied to the device. + +## -returns +Returns True if the attributes were successfully updated; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplay_checkpowerstatusasync_1107655958.md b/windows.devices.pointofservice/linedisplay_checkpowerstatusasync_1107655958.md new file mode 100644 index 0000000000..bd8a123411 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_checkpowerstatusasync_1107655958.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.CheckPowerStatusAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.CheckPowerStatusAsync + +## -description +Gets the current power status of the device. + +## -returns +The power status of the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplay_statisticscategoryselector.md b/windows.devices.pointofservice/linedisplay_statisticscategoryselector.md new file mode 100644 index 0000000000..52e48dba65 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_statisticscategoryselector.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.StatisticsCategorySelector +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.StatisticsCategorySelector + +## -description +Gets the standard UnifiedPOS statistics category selector strings. + +## -property-value +The standard UnifiedPOS statistics category selector strings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes.md b/windows.devices.pointofservice/linedisplayattributes.md new file mode 100644 index 0000000000..be8a21bb36 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayAttributes +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes + +## -description +Represents the attributes of a [line display](linedisplay.md) device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_blinkrate.md b/windows.devices.pointofservice/linedisplayattributes_blinkrate.md new file mode 100644 index 0000000000..3adfde2581 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_blinkrate.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.BlinkRate +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.BlinkRate + +## -description +Gets or sets the blink rate of the line display. + +## -property-value +The blink rate in milliseconds. + +## -remarks +When the device supports blinking ([LineDisplayCapabilities.CanBlink](LineDisplayCapabilities_CanBlink.md) is not NotSupported) this writeable property configures the current blink cycle time. A blink cycle is the period of time when text completes an on-off-on cycle during blinking. After this property is set, the device driver (the Service Object) typically sets the blink rate to the closest supported rate. + +When the device does not support blinking ([LineDisplayCapabilities.CanBlink](LineDisplayCapabilities_CanBlink.md) is NotSupported) this property is fixed to a value of 0 and cannot be changed. + +The default value of this property is 0. + +Changes to this property are committed to the device on the next call of [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_brightness.md b/windows.devices.pointofservice/linedisplayattributes_brightness.md new file mode 100644 index 0000000000..19dd9f4e41 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_brightness.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.Brightness +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.Brightness + +## -description +Gets or sets the brightness of the line display. + +## -property-value +The brightness of the line display. + +## -remarks +When the device supports brightness adjustment ([LineDisplayCapabilities.IsBrightnessSupported](LineDisplayCapabilities_IsBrightnessSupported.md) is True) this writeable property configures the current screen brightness, in percent (valid values are positive integers from 0 to 100, inclusive). All devices support 100% (maximum brightness) and 0% (blank screen). Some devices also support dimming values in between these limits. In all cases the device driver (the Service Object) maps the requested brightness value to the closest value supported by the Hardware device. + +The default value of this property is 100. + +Changes to this property are committed to the device on the next call to [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_characterset.md b/windows.devices.pointofservice/linedisplayattributes_characterset.md new file mode 100644 index 0000000000..c834f220af --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_characterset.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.CharacterSet +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.CharacterSet + +## -description +Gets or sets the current character set used by the device to display characters. + +## -property-value +The current character set. + +## -remarks +Valid values for this property are the values stored in [ClaimedLineDisplay.SupportedCharacterSets](ClaimedLineDisplay_SupportedCharacterSets.md). + +Changes to this property are committed to the device on the next call to [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_currentwindow.md b/windows.devices.pointofservice/linedisplayattributes_currentwindow.md new file mode 100644 index 0000000000..37415b4eec --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_currentwindow.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.CurrentWindow +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.CurrentWindow + +## -description +Gets or sets the current window to which text is displayed. + +## -property-value +The current window to which text is displayed. + +## -remarks +Setting the current window does not refresh that window's viewport. If the viewports of the current window and another window overlap, and the other window has changed content within the viewport, then refreshWindow may be called to restore the window's viewport contents. + +Changes to this property are committed to the device on the next call to [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_ischaractersetmappingenabled.md b/windows.devices.pointofservice/linedisplayattributes_ischaractersetmappingenabled.md new file mode 100644 index 0000000000..d9314c3a16 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_ischaractersetmappingenabled.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.IsCharacterSetMappingEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.IsCharacterSetMappingEnabled + +## -description +Gets or sets whether character set mapping is enabled. + +## -property-value +True if character set mapping is enabled; otherwise, False. + +## -remarks +When [LineDisplayCapabilities.CanMapCharacterSets](LineDisplayCapabilities.CanMapCharacterSets) is True, this writeable property controls whether character mapping is enabled. When character mapping is enabled, characters sent by the application are mapped by the device driver/the Service Object to the characters supported by the device. + +When [LineDisplayCapabilities.CanMapCharacterSets](LineDisplayCapabilities.CanMapCharacterSets) is False the value of this property is fixed to False and cannot be changed. + +Changes to this property are committed to the device on the next call to [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_ispowernotifyenabled.md b/windows.devices.pointofservice/linedisplayattributes_ispowernotifyenabled.md new file mode 100644 index 0000000000..52d02c0d57 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_ispowernotifyenabled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.IsPowerNotifyEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.IsPowerNotifyEnabled + +## -description +Gets or sets whether the device is enabled to notify the user of power state changes. + +## -property-value +True if power state notifications are enabled; otherwise, False. + +## -remarks +Power state notifications are delivered via [ClaimedLineDisplay.StatusUpdated](ClaimedLineDisplay_StatusUpdated.md). The property's default value is False (meaning that the device does not send power state notifications even if the app is subscribed to the [ClaimedLineDisplay.StatusUpdated](ClaimedLineDisplay_StatusUpdated.md) event). This property can be set to True only when [LineDisplayCapabilities.PowerReportingType](LineDisplayCapabilities_PowerReportingType.md) is not set to UnknownPowerReportingType. + +Changes to this property are committed to the device on the next call to [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayattributes_screensizeincharacters.md b/windows.devices.pointofservice/linedisplayattributes_screensizeincharacters.md new file mode 100644 index 0000000000..982552b507 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayattributes_screensizeincharacters.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayAttributes.ScreenSizeInCharacters +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayAttributes.ScreenSizeInCharacters + +## -description +Gets or sets the current screen size. + +## -property-value +The current screen size in characters. + +## -remarks +When the device supports multiple screen sizes ([LineDisplayCapabilities.CanChangeScreenSize](linedisplaycapabilities_canchangescreensize.md) is True) this writeable property configures the current screen size. When bitmaps are also supported, changing the ScreenSizeinCharacters property may cause MaxBitmapSize to change to a new value. + +When the device supports only one screen size ([LineDisplayCapabilities.CanChangeScreenSize](linedisplaycapabilities_canchangescreensize.md) is False) this property supports only one value, behaving as a read-only property. + +Changes to this property are committed to the device on the next call to [ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md). + +## -see-also +[ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes)](claimedlinedisplay_tryupdateattributesasync_1303674463.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor.md b/windows.devices.pointofservice/linedisplaycursor.md new file mode 100644 index 0000000000..5139b6d3a9 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayCursor +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor + +## -description +Represents a line display cursor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_cancustomize.md b/windows.devices.pointofservice/linedisplaycursor_cancustomize.md new file mode 100644 index 0000000000..69079b23c2 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_cancustomize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.CanCustomize +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.CanCustomize + +## -description +Gets whether the line display device supports customizing the cursor style. + +## -property-value +True if the device supports customizing the cursor style; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_getattributes_262223912.md b/windows.devices.pointofservice/linedisplaycursor_getattributes_262223912.md new file mode 100644 index 0000000000..a53ae0da7c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_getattributes_262223912.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayCursor.GetAttributes +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.GetAttributes + +## -description +Gets the attributes of the line display cursor. + +## -returns +The attributes of the line display cursor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_isblinksupported.md b/windows.devices.pointofservice/linedisplaycursor_isblinksupported.md new file mode 100644 index 0000000000..e18cf0552e --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_isblinksupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.IsBlinkSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.IsBlinkSupported + +## -description +Gets whether cursor blinking is supported. + +## -property-value +True if cursor blinking is supported; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_isblocksupported.md b/windows.devices.pointofservice/linedisplaycursor_isblocksupported.md new file mode 100644 index 0000000000..6cd834ee99 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_isblocksupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.IsBlockSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.IsBlockSupported + +## -description +Gets whether a block cursor is supported. + +## -property-value +True if a block cursor is supported; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_ishalfblocksupported.md b/windows.devices.pointofservice/linedisplaycursor_ishalfblocksupported.md new file mode 100644 index 0000000000..718df0f5d5 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_ishalfblocksupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.IsHalfBlockSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.IsHalfBlockSupported + +## -description +Gets whether a half-block cursor is supported. + +## -property-value +True if a half-block cursor is supported; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_isothersupported.md b/windows.devices.pointofservice/linedisplaycursor_isothersupported.md new file mode 100644 index 0000000000..7698c554dc --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_isothersupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.IsOtherSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.IsOtherSupported + +## -description +Gets whether another type (unknown as per UnifiedPOS) of cursor is supported. + +## -property-value +True if another type of cursor is supported; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_isreversesupported.md b/windows.devices.pointofservice/linedisplaycursor_isreversesupported.md new file mode 100644 index 0000000000..e765f5378c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_isreversesupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.IsReverseSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.IsReverseSupported + +## -description +Gets whether an inverted cursor is supported. + +## -property-value +True if an inverted cursor is supported; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_isunderlinesupported.md b/windows.devices.pointofservice/linedisplaycursor_isunderlinesupported.md new file mode 100644 index 0000000000..3d4d01be9d --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_isunderlinesupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursor.IsUnderlineSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.IsUnderlineSupported + +## -description +Gets whether an underlined cursor is supported. + +## -property-value +True if an underline cursor is supported; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursor_tryupdateattributesasync_248842415.md b/windows.devices.pointofservice/linedisplaycursor_tryupdateattributesasync_248842415.md new file mode 100644 index 0000000000..894ee1ea6c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursor_tryupdateattributesasync_248842415.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayCursor.TryUpdateAttributesAsync(Windows.Devices.PointOfService.LineDisplayCursorAttributes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursor.TryUpdateAttributesAsync + +## -description +Attempts to asynchronously update the attributes of the line display curor. + +## -parameters +### -param attributes +The attributes to be applied to the cursor. + +## -returns +Returns True if the attributes were successfully updated; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursorattributes.md b/windows.devices.pointofservice/linedisplaycursorattributes.md new file mode 100644 index 0000000000..083f55a4ea --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursorattributes.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayCursorAttributes +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursorAttributes + +## -description +Represents the attributes of a line display cursor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursorattributes_cursortype.md b/windows.devices.pointofservice/linedisplaycursorattributes_cursortype.md new file mode 100644 index 0000000000..7135763ec8 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursorattributes_cursortype.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursorAttributes.CursorType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursorAttributes.CursorType + +## -description +Gets or sets the type of cursor used by the line display. + +## -property-value +The type of cursor used. + +## -remarks +Changes to this property are committed to the device on the next call to [LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md). + +## -see-also +[LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursorattributes_isautoadvanceenabled.md b/windows.devices.pointofservice/linedisplaycursorattributes_isautoadvanceenabled.md new file mode 100644 index 0000000000..ac2780915a --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursorattributes_isautoadvanceenabled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursorAttributes.IsAutoAdvanceEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursorAttributes.IsAutoAdvanceEnabled + +## -description +Gets or sets whether automatic advancing of the cursor is enabled. + +## -property-value +True if automatic advancing is enabled; otherwise, False. + +## -remarks +When set to True, the cursor’s Position will be automatically updated to point to the next character to be displayed, whenever text is displayed. When False, the cursor position will not be automatically updated when characters are displayed. + +Changes to this property are committed to the device on the next call to [LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md). + +## -see-also +[LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursorattributes_isblinkenabled.md b/windows.devices.pointofservice/linedisplaycursorattributes_isblinkenabled.md new file mode 100644 index 0000000000..127e7b6db5 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursorattributes_isblinkenabled.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursorAttributes.IsBlinkEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursorAttributes.IsBlinkEnabled + +## -description +Gets or sets whether blinking is enabled on the cursor. + +## -property-value +True if blinking is enabled; otherwise, False. + +## -remarks +Changes to this property are committed to the device on the next call to [LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md). + +## -see-also +[LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursorattributes_position.md b/windows.devices.pointofservice/linedisplaycursorattributes_position.md new file mode 100644 index 0000000000..b8ab6fa35d --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursorattributes_position.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCursorAttributes.Position +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursorAttributes.Position + +## -description +Gets or sets the position of the cursor. + +## -property-value +The position of the cursor. + +## -remarks +The maximum cursor position is described by the cursor owner’s LineDisplayWindow.Size property. + +The default value of this property is {0,0}. + +Changes to this property are committed to the device on the next call to [LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md). + +## -see-also +[LineDisplayCursor.TryUpdateAttributesAsync(LineDisplayCursorAttributes)](linedisplaycursor_tryupdateattributesasync_248842415.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycursortype.md b/windows.devices.pointofservice/linedisplaycursortype.md new file mode 100644 index 0000000000..79797c6bb6 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycursortype.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayCursorType +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayCursorType + +## -description +Defines the constants that indicate the type of cursor a line display is using. + +## -enum-fields +### -field Underline:3 +An underline cursor. + +### -field Reverse:4 +An inverted cursor. + +### -field Other:5 +Another type of cursor (not part of the UnifiedPOS specification). + +### -field None:0 +No cursor. + +### -field HalfBlock:2 +A half-block cursor. + +### -field Block:1 +A block cursor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycustomglyphs.md b/windows.devices.pointofservice/linedisplaycustomglyphs.md new file mode 100644 index 0000000000..b62462f33e --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycustomglyphs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayCustomGlyphs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayCustomGlyphs + +## -description +Represents a set of custom glyphs to be used by a line display. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycustomglyphs_sizeinpixels.md b/windows.devices.pointofservice/linedisplaycustomglyphs_sizeinpixels.md new file mode 100644 index 0000000000..7a6eb4a42d --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycustomglyphs_sizeinpixels.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCustomGlyphs.SizeInPixels +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCustomGlyphs.SizeInPixels + +## -description +Gets the glyph dimensions (based on the number of pixels for a character cell) supported by the device + +## -property-value +The glyph dimensions, in pixels. + +## -remarks + +## -see-also + +## -examples \ No newline at end of file diff --git a/windows.devices.pointofservice/linedisplaycustomglyphs_supportedglyphcodes.md b/windows.devices.pointofservice/linedisplaycustomglyphs_supportedglyphcodes.md new file mode 100644 index 0000000000..a851fd0182 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycustomglyphs_supportedglyphcodes.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCustomGlyphs.SupportedGlyphCodes +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCustomGlyphs.SupportedGlyphCodes + +## -description +Gets the list of character codes available for redefinition as custom glyphs. + +## -property-value +The list of character codes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaycustomglyphs_tryredefineasync_414399021.md b/windows.devices.pointofservice/linedisplaycustomglyphs_tryredefineasync_414399021.md new file mode 100644 index 0000000000..b4e7c21f1a --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycustomglyphs_tryredefineasync_414399021.md @@ -0,0 +1,37 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayCustomGlyphs.TryRedefineAsync(System.UInt32,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayCustomGlyphs.TryRedefineAsync + +## -description +Attempts to asynchronously define a custom glyph. + +## -parameters +### -param glyphCode +The character for which the glyph will be defined. + +### -param glyphData +The glyph data. + +## -returns +Returns True if the glyph was successfully defined; otherwise, False. + +## -remarks +The glyph is defined as bits representing each pixel packed into bytes, using whole bytes to represent each row. + +The minimum number of bytes are sent for each row, based on [LineDisplayCustomGlyphs.SizeInPixels](linedisplaycustomglyphs_sizeinpixels.md) and using 8 bits per byte. Bytes are sent left-to-right across each row; if more than one byte is required per row, the leftmost byte is sent first. The lowest-order bit within a byte represents the rightmost pixel. Bits that do not represent pixels are the highest order bits and their value is ignored. Rows are sent from the top down. + +A 10 pixel wide glyph would have the two leftmost pixels represented in bits 1 and 0 of the first byte, respectively. The remaining 8 pixels would be represented in the second byte. + +Enough rows must be sent to define the entire character. The hardware defines whether changing the definition of a glyph causes currently displayed characters to change or the change appears only when next drawn. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaydescriptorstate.md b/windows.devices.pointofservice/linedisplaydescriptorstate.md new file mode 100644 index 0000000000..07a977b25e --- /dev/null +++ b/windows.devices.pointofservice/linedisplaydescriptorstate.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayDescriptorState +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayDescriptorState + +## -description +Defines the constants that indicate the state of a line display descriptor. + +## -enum-fields +### -field On:1 +Turns the descriptor on. + +### -field Off:0 +Turns the descriptor off. + +### -field Blink:2 +Sets the descriptor to blinking. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayhorizontalalignment.md b/windows.devices.pointofservice/linedisplayhorizontalalignment.md new file mode 100644 index 0000000000..e6e025961c --- /dev/null +++ b/windows.devices.pointofservice/linedisplayhorizontalalignment.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayHorizontalAlignment +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayHorizontalAlignment + +## -description +Defines the constants that indicate the horizontal alignment of text on a line display, relative to the current text character position. + +## -enum-fields +### -field Left:0 +Align the bitmap's left edge with the leftmost pixel of the current charcter position. + +### -field Center:1 +Align the bitmap in the horizontal center of the current character position. + +### -field Right:2 +Align the bitmap's right edge with the rightmost pixel of the current charcter position. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarquee.md b/windows.devices.pointofservice/linedisplaymarquee.md new file mode 100644 index 0000000000..47f16678a7 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarquee.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayMarquee +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarquee + +## -description +Represents an object containing properties describing and allowing control of marquee scrolling on a line display. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarquee_format.md b/windows.devices.pointofservice/linedisplaymarquee_format.md new file mode 100644 index 0000000000..72a02a1518 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarquee_format.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayMarquee.Format +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarquee.Format + +## -description +Gets or sets the current format of the marquee. + +## -property-value +The current format of the marquee. + +## -remarks +When set to None, marquee scrolling is disabled. Changes to this property are committed to the device on the next call to [LineDisplayMarquee.TryStartScrollingAsync()](linedisplaymarquee_trystartscrollingasync_221236205.md). + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarquee_repeatwaitinterval.md b/windows.devices.pointofservice/linedisplaymarquee_repeatwaitinterval.md new file mode 100644 index 0000000000..54ccb9942c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarquee_repeatwaitinterval.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayMarquee.RepeatWaitInterval +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarquee.RepeatWaitInterval + +## -description +Gets or sets the marquee repeat wait period. + +## -property-value +The delay between finishing a marquee scroll and starting over again. + +## -remarks +The default value of this property is 0. Changes to this property are committed to the device on the next call to [LineDisplayMarquee.TryStartScrollingAsync()](linedisplaymarquee_trystartscrollingasync_221236205.md). + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarquee_scrollwaitinterval.md b/windows.devices.pointofservice/linedisplaymarquee_scrollwaitinterval.md new file mode 100644 index 0000000000..4f54275651 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarquee_scrollwaitinterval.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayMarquee.ScrollWaitInterval +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarquee.ScrollWaitInterval + +## -description +Gets or sets the scroll wait interval. + +## -property-value +The delay between placing or walking each character in the marquee. + +## -remarks +The default value of this property is 0. Changes to this property are committed to the device on the next call to [LineDisplayMarquee.TryStartScrollingAsync()](linedisplaymarquee_trystartscrollingasync_221236205.md). + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarquee_trystartscrollingasync_221236205.md b/windows.devices.pointofservice/linedisplaymarquee_trystartscrollingasync_221236205.md new file mode 100644 index 0000000000..87b1271b03 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarquee_trystartscrollingasync_221236205.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayMarquee.TryStartScrollingAsync(Windows.Devices.PointOfService.LineDisplayScrollDirection) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarquee.TryStartScrollingAsync + +## -description +Attempts to asynchronously cause the window which owns this marquee to enter Marquee Mode and start scrolling. + +## -parameters +### -param direction +The direction in which to start scrolling. + +## -returns +Returns True if the marquee successfully started scrolling; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarquee_trystopscrollingasync_87706321.md b/windows.devices.pointofservice/linedisplaymarquee_trystopscrollingasync_87706321.md new file mode 100644 index 0000000000..612528ab97 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarquee_trystopscrollingasync_87706321.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayMarquee.TryStopScrollingAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarquee.TryStopScrollingAsync + +## -description +Attempts to asynchronously exit Marquee mode and/or Marquee Init mode. Format is set to None. + +## -returns +Returns True if the marquee was successfully stopped; otherwise, False. + +## -remarks +If the device is not already claimed when this method is called, this method will claim the device (without delay) and enable the device. If the device is already claimed by another process the call will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaymarqueeformat.md b/windows.devices.pointofservice/linedisplaymarqueeformat.md new file mode 100644 index 0000000000..9a7d756103 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaymarqueeformat.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayMarqueeFormat +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayMarqueeFormat + +## -description +Defines the constants that indicate the marquee format for the current window. + +## -enum-fields +### -field Walk:1 +The display is populated by walking data from the opposite end of the display as the scrolling direction. For example, if the scrolling direction is Left, then the viewport is filled by bringing characters in from the the right side and scrolling them to the left. + +### -field Place:2 +The display is populated by placing data. For example, if the scrolling direction is left, then the viewport is filled by placing characters starting at the left side, and beginning scrolling only after the viewport is full. + +### -field None:0 +Marquee scrolling is disabled. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaypowerstatus.md b/windows.devices.pointofservice/linedisplaypowerstatus.md new file mode 100644 index 0000000000..8c61e6b22b --- /dev/null +++ b/windows.devices.pointofservice/linedisplaypowerstatus.md @@ -0,0 +1,36 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayPowerStatus +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayPowerStatus + +## -description +Defines the constants that indicate the power status of a line display. + +## -enum-fields +### -field Unknown:0 +The power state is unknown. + +### -field Online:1 +The line display is online. + +### -field OffOrOffline:4 +The line display is either off or offline. + +### -field Offline:3 +The line display is offline. + +### -field Off:2 +The line display is off. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystatisticscategoryselector.md b/windows.devices.pointofservice/linedisplaystatisticscategoryselector.md new file mode 100644 index 0000000000..0dc7687b89 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystatisticscategoryselector.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector + +## -description +Represents a standard statistics category selector. + +## -remarks + +## -see-also +[ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md) + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystatisticscategoryselector_allstatistics.md b/windows.devices.pointofservice/linedisplaystatisticscategoryselector_allstatistics.md new file mode 100644 index 0000000000..d07d51d176 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystatisticscategoryselector_allstatistics.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector.AllStatistics +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector.AllStatistics + +## -description +Retrieves all device statistics when provided to [ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md). + +## -property-value +The UnifiedPOS value for retrieving all statistics from a device. + +## -remarks +[ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md) + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystatisticscategoryselector_manufacturerstatistics.md b/windows.devices.pointofservice/linedisplaystatisticscategoryselector_manufacturerstatistics.md new file mode 100644 index 0000000000..4b0da8f151 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystatisticscategoryselector_manufacturerstatistics.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector.ManufacturerStatistics +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector.ManufacturerStatistics + +## -description +Retrieves manufacturer-defined statistics when provided to [ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md. + +## -property-value +The UnifiedPOS value for retrieving manufacturer-defined statistics from a device. + +## -remarks +[ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md) + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystatisticscategoryselector_unifiedposstatistics.md b/windows.devices.pointofservice/linedisplaystatisticscategoryselector_unifiedposstatistics.md new file mode 100644 index 0000000000..9f5d1fe7b9 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystatisticscategoryselector_unifiedposstatistics.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector.UnifiedPosStatistics +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayStatisticsCategorySelector.UnifiedPosStatistics + +## -description +Retrieves UnifiedPOS statistics when provided to [ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md). + +## -property-value +The UnifiedPOS value for retrieving UnifiedPOS statistics from a device. + +## -remarks +[ClaimedLineDisplay.GetStatisticsAsync(IEnumerable)](claimedlinedisplay_getstatisticsasync_980600774.md) + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystatusupdatedeventargs.md b/windows.devices.pointofservice/linedisplaystatusupdatedeventargs.md new file mode 100644 index 0000000000..fbcef045e3 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystatusupdatedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayStatusUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayStatusUpdatedEventArgs + +## -description +Provides event data for power state changes in the line display device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystatusupdatedeventargs_status.md b/windows.devices.pointofservice/linedisplaystatusupdatedeventargs_status.md new file mode 100644 index 0000000000..884637453f --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystatusupdatedeventargs_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayStatusUpdatedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayStatusUpdatedEventArgs.Status + +## -description +Gets the current power status of the device. + +## -property-value +The current power status of the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystoredbitmap.md b/windows.devices.pointofservice/linedisplaystoredbitmap.md new file mode 100644 index 0000000000..9f58dbf647 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystoredbitmap.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayStoredBitmap +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayStoredBitmap + +## -description +Represents an object used to store a bitmap via the LineDisplayWindow.StoreBitmapAsync method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystoredbitmap_escapesequence.md b/windows.devices.pointofservice/linedisplaystoredbitmap_escapesequence.md new file mode 100644 index 0000000000..8d7e131360 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystoredbitmap_escapesequence.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayStoredBitmap.EscapeSequence +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayStoredBitmap.EscapeSequence + +## -description +Gets the UnifiedPOS escape sequence that is used to print images inline with text. + +## -property-value +A string that, when printed to the line display device, displays this bitmap at the cursor position. + +## -remarks +Using this escape sequence after TryDeleteAsync has been called yields indeterminate results. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaystoredbitmap_trydeleteasync_41251962.md b/windows.devices.pointofservice/linedisplaystoredbitmap_trydeleteasync_41251962.md new file mode 100644 index 0000000000..1d464ee818 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaystoredbitmap_trydeleteasync_41251962.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayStoredBitmap.TryDeleteAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayStoredBitmap.TryDeleteAsync + +## -description +Attempts to asynchronously delete the stored bitmap. + +## -returns +Returns True if the bitmap was successfully deleted; otherwise, False. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplayverticalalignment.md b/windows.devices.pointofservice/linedisplayverticalalignment.md new file mode 100644 index 0000000000..b2d59125ea --- /dev/null +++ b/windows.devices.pointofservice/linedisplayverticalalignment.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayVerticalAlignment +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayVerticalAlignment + +## -description +Defines the constants that indicate the vertical alignment of text on a line display, relative to the current text character position. + +## -enum-fields +### -field Top:0 +Align the bitmap's top edge with the topmost pixel of the current charcter position. + +### -field Center:1 +Align the bitmap in the vertical center of the current character position. + +### -field Bottom:2 +Align the bitmap's bottom edge with the bottommost pixel of the current charcter position. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow.md b/windows.devices.pointofservice/linedisplaywindow.md index 176e8384af..1b1f11b940 100644 --- a/windows.devices.pointofservice/linedisplaywindow.md +++ b/windows.devices.pointofservice/linedisplaywindow.md @@ -1,19 +1,18 @@ ---- --api-id: T:Windows.Devices.PointOfService.LineDisplayWindow --api-type: winrt class ---- - +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayWindow +-api-type: winrt class +--- + -# Windows.Devices.PointOfService.LineDisplayWindow - +# Windows.Devices.PointOfService.LineDisplayWindow + ## -description -Represents the line display window. +Represents a line display window. ## -remarks -This object is retrieved when you access the [DefaultWindow](claimedlinedisplay_defaultwindow.md) property of the [ClaimedLineDisplay](claimedlinedisplay.md) object. ## -see-also diff --git a/windows.devices.pointofservice/linedisplaywindow_close_811482585.md b/windows.devices.pointofservice/linedisplaywindow_close_811482585.md index ec2a8775c0..02413b48b2 100644 --- a/windows.devices.pointofservice/linedisplaywindow_close_811482585.md +++ b/windows.devices.pointofservice/linedisplaywindow_close_811482585.md @@ -1,20 +1,21 @@ ---- --api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.Close --api-type: winrt method ---- - +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.Close +-api-type: winrt method +--- + -# Windows.Devices.PointOfService.LineDisplayWindow.Close - +# Windows.Devices.PointOfService.LineDisplayWindow.Close + ## -description -Close the line display window. +Closes the line display window resource, destroying the window on the device. ## -parameters ## -remarks +Closing a window does not remove any content that it is displaying on the device. Use [LineDisplay.TryClearTextAsync()](linedisplaywindow_trycleartextasync_2039536783.md) to clear window contents before destroying it. ## -see-also diff --git a/windows.devices.pointofservice/linedisplaywindow_cursor.md b/windows.devices.pointofservice/linedisplaywindow_cursor.md new file mode 100644 index 0000000000..bdc793ccb5 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_cursor.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayWindow.Cursor +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.Cursor + +## -description +Gets the cursor of the line display window. + +## -property-value +The cursor of the line display window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_marquee.md b/windows.devices.pointofservice/linedisplaywindow_marquee.md new file mode 100644 index 0000000000..e9ae902434 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_marquee.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayWindow.Marquee +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.Marquee + +## -description +Gets the line display marquee. + +## -property-value +The line display marquee. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_readcharacteratcursorasync_1331876971.md b/windows.devices.pointofservice/linedisplaywindow_readcharacteratcursorasync_1331876971.md new file mode 100644 index 0000000000..bc7efaf824 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_readcharacteratcursorasync_1331876971.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.ReadCharacterAtCursorAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.ReadCharacterAtCursorAsync + +## -description +Attempts to asynchronously read the currently displayed character at the current cursor position. + +## -returns +Returns the code for the character at the current cursor position. Returns 0 if the method fails. + +## -remarks +This method requires [LineDisplayCapabilities.CanReadCharacterAtCursor](linedisplaycapabilities_canreadcharacteratcursor.md) to be True to be succesfully executed. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md b/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md index d250d2c1ad..71313f720f 100644 --- a/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md +++ b/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md @@ -1,16 +1,16 @@ ---- --api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryClearTextAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryClearTextAsync +-api-type: winrt method +--- + -# Windows.Devices.PointOfService.LineDisplayWindow.TryClearTextAsync - +# Windows.Devices.PointOfService.LineDisplayWindow.TryClearTextAsync + ## -description -Clears the current window. Changers all characters to blanks, clears any bitmaps displayed in the window, exits **Marquee Mode** if it is being used, clears and sets **InterCharacterWait** to 0, and **Cursor.Position** to {0,0}. +Clears the current window. Changers all characters to blanks, clears any bitmaps displayed in the window, and sets **Cursor.Position** to {0,0}. ## -parameters diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_1536408927.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_1536408927.md new file mode 100644 index 0000000000..300d00e8d6 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_1536408927.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync(Windows.Storage.StorageFile,Windows.Devices.PointOfService.LineDisplayHorizontalAlignment,Windows.Devices.PointOfService.LineDisplayVerticalAlignment) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync + +## -description +Attempts to asynchronously display a bitmap from a storage file at the current cursor position. + +## -parameters +### -param bitmap +The bitmap to be displayed. + +### -param horizontalAlignment +The horizontal alignment of the bitmap relative to the current text character position. + +### -param verticalAlignment +The vertical alignment of the bitmap relative to the current text character position. + +## -returns +Return True if the bitmap was successfully displayed; otherwise, False. + +## -remarks +If the [LineDisplayCapabilities.CanDisplayBitmaps](linedisplaycapabilities_candisplaybitmaps.md) value is False, this method will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_2119403361.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_2119403361.md new file mode 100644 index 0000000000..65a5ae5350 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_2119403361.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync(Windows.Storage.StorageFile,Windows.Devices.PointOfService.LineDisplayHorizontalAlignment,Windows.Devices.PointOfService.LineDisplayVerticalAlignment,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync + +## -description +Attempts to asynchronously display a bitmap from a storage file at the current cursor position, at a particular width. + +## -parameters +### -param bitmap +The bitmap to be displayed. + +### -param horizontalAlignment +The horizontal alignment of the bitmap relative to the current text character position. + +### -param verticalAlignment +The vertical alignment of the bitmap relative to the current text character position. + +### -param widthInPixels +The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled). + +## -returns +Return True if the bitmap was successfully displayed; otherwise, False. + +## -remarks +If the [LineDisplayCapabilities.CanDisplayBitmaps](linedisplaycapabilities_candisplaybitmaps.md) value is False, this method will fail. + +If the provided widthInPixels value is larger than [ClaimedLineDisplay.MaxBitmapSizeInPixels](claimedlinedisplay_maxbitmapsizeinpixels.md), this method will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_573184331.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_573184331.md new file mode 100644 index 0000000000..1e0c30a771 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatcursorasync_573184331.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync(Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync + +## -description +Attempts to asynchronously display a bitmap from a storage file at the current cursor position. + +## -parameters +### -param bitmap +The bitmap to be displayed. + +## -returns +Return True if the bitmap was successfully displayed; otherwise, False. + +## -remarks +If the [LineDisplayCapabilities.CanDisplayBitmaps](linedisplaycapabilities_candisplaybitmaps.md) value is False, this method will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatpointasync_1816627683.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatpointasync_1816627683.md new file mode 100644 index 0000000000..8b6d3ddbb4 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatpointasync_1816627683.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtPointAsync(Windows.Storage.StorageFile,Windows.Foundation.Point,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtPointAsync + +## -description +Attempts to asynchronously display a bitmap from a storage file at a particular point, scaled to a particular width. + +## -parameters +### -param bitmap +The bitmap to be displayed. + +### -param offsetInPixels +The number of pixels to offset the bitmap display from the top-left corner of the screen, {0,0}. + +### -param widthInPixels +The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled). + +## -returns +Return True if the bitmap was successfully displayed; otherwise, False. + +## -remarks +If the [LineDisplayCapabilities.CanDisplayBitmaps](linedisplaycapabilities_candisplaybitmaps.md) value is False, this method will fail. + +If the provided widthInPixels value is larger than [ClaimedLineDisplay.MaxBitmapSizeInPixels](claimedlinedisplay_maxbitmapsizeinpixels.md), this method will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatpointasync_22571779.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatpointasync_22571779.md new file mode 100644 index 0000000000..010577fcec --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoragefilebitmapatpointasync_22571779.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtPointAsync(Windows.Storage.StorageFile,Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStorageFileBitmapAtPointAsync + +## -description +Attempts to asynchronously display a bitmap from a storage file at a particular point. + +## -parameters +### -param bitmap +The bitmap to be displayed. + +### -param offsetInPixels +The number of pixels to offset the bitmap display from the top-left corner of the screen, {0,0}. + +## -returns +Return True if the bitmap was successfully displayed; otherwise, False. + +## -remarks +If the [LineDisplayCapabilities.CanDisplayBitmaps](linedisplaycapabilities_candisplaybitmaps.md) value is False, this method will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaystoredbitmapatcursorasync_100389007.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoredbitmapatcursorasync_100389007.md new file mode 100644 index 0000000000..7e5541fc62 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaystoredbitmapatcursorasync_100389007.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStoredBitmapAtCursorAsync(Windows.Devices.PointOfService.LineDisplayStoredBitmap) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayStoredBitmapAtCursorAsync + +## -description +Attempts to asynchronously display a stored bitmap from at LineDisplayStoredBitmap object at the current cursor position. + +## -parameters +### -param bitmap +The bitmap to be displayed. + +## -returns +Returns True if the bitmap was successfully displayed; otherwise, False. + +## -remarks +If the [LineDisplayCapabilities.CanDisplayBitmaps](linedisplaycapabilities_candisplaybitmaps.md) value is False, this method will fail. + +## -see-also + +## -examples + diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md index aba3f0214c..394ec1c0fd 100644 --- a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md @@ -1,14 +1,14 @@ ---- --api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String,Windows.Devices.PointOfService.LineDisplayTextAttribute) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String,Windows.Devices.PointOfService.LineDisplayTextAttribute) +-api-type: winrt method +--- + -# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync - +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync + ## -description Try to display the specified text in the line display window, using the specified display attribute. @@ -19,6 +19,7 @@ The text to be displayed. ### -param displayAttribute The display attribute to be applied to the window. + ## -returns True if the text was displayed successfully; otherwise, false. diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md index bd5a5f51fc..842635555f 100644 --- a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md @@ -1,14 +1,14 @@ ---- --api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String) +-api-type: winrt method +--- + -# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync - +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync + ## -description Try to display the specified text in the line display window. diff --git a/windows.devices.pointofservice/magneticstripereaderstatus.md b/windows.devices.pointofservice/magneticstripereaderstatus.md index d40a9b128b..532f79635f 100644 --- a/windows.devices.pointofservice/magneticstripereaderstatus.md +++ b/windows.devices.pointofservice/magneticstripereaderstatus.md @@ -11,7 +11,7 @@ public enum Windows.Devices.PointOfService.MagneticStripeReaderStatus : int # MagneticStripeReaderStatus ## -description -Defines the constants that indicates the device authentication status. +Defines the constants that indicate the device authentication status. ## -enum-fields ### -field Unauthenticated:0 diff --git a/windows.devices.sensors.custom/customsensor_maxbatchsize.md b/windows.devices.sensors.custom/customsensor_maxbatchsize.md new file mode 100644 index 0000000000..a1d6495526 --- /dev/null +++ b/windows.devices.sensors.custom/customsensor_maxbatchsize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](customsensor_reportlatency.md). The maximum latency equals the [ReportInterval](customsensor_reportinterval.md) times the [MaxBatchSize](customsensor_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). +## -see-also + +## -examples + diff --git a/windows.devices.sensors.custom/customsensor_reportlatency.md b/windows.devices.sensors.custom/customsensor_reportlatency.md new file mode 100644 index 0000000000..1f2e7f6036 --- /dev/null +++ b/windows.devices.sensors.custom/customsensor_reportlatency.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensor.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensor.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](customsensor_readingchanged.md) events. + +Not all sensors support [ReportLatency](customsensor_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](customsensor_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](customsensor_reportlatency.md) equals the [MaxBatchSize](customsensor_maxbatchsize.md) times the [ReportInterval](customsensor_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](customsensor_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](customsensor_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -see-also + +## -examples + diff --git a/windows.devices.sensors.custom/customsensorreading_performancecount.md b/windows.devices.sensors.custom/customsensorreading_performancecount.md new file mode 100644 index 0000000000..425ecc609e --- /dev/null +++ b/windows.devices.sensors.custom/customsensorreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.Custom.CustomSensorReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Custom.CustomSensorReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/accelerometer_fromidasync_1322863552.md b/windows.devices.sensors/accelerometer_fromidasync_1322863552.md new file mode 100644 index 0000000000..0307fe858c --- /dev/null +++ b/windows.devices.sensors/accelerometer_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.Accelerometer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Accelerometer.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [Accelerometer](accelerometer.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/accelerometer_getdeviceselector_709887072.md b/windows.devices.sensors/accelerometer_getdeviceselector_709887072.md new file mode 100644 index 0000000000..6d38322df4 --- /dev/null +++ b/windows.devices.sensors/accelerometer_getdeviceselector_709887072.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.Accelerometer.GetDeviceSelector(Windows.Devices.Sensors.AccelerometerReadingType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Accelerometer.GetDeviceSelector + +## -description +Gets the device selector. + +## -parameters +### -param readingType +The type of sensor to retrieve. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/accelerometerreading_performancecount.md b/windows.devices.sensors/accelerometerreading_performancecount.md new file mode 100644 index 0000000000..167c5ab3f4 --- /dev/null +++ b/windows.devices.sensors/accelerometerreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/accelerometerreading_properties.md b/windows.devices.sensors/accelerometerreading_properties.md new file mode 100644 index 0000000000..7a832a046b --- /dev/null +++ b/windows.devices.sensors/accelerometerreading_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.AccelerometerReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AccelerometerReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/activitysensor_fromidasync_1322863552.md b/windows.devices.sensors/activitysensor_fromidasync_1322863552.md index 6adfc7e3a4..a335f6aca0 100644 --- a/windows.devices.sensors/activitysensor_fromidasync_1322863552.md +++ b/windows.devices.sensors/activitysensor_fromidasync_1322863552.md @@ -14,7 +14,7 @@ Asynchronously obtains the sensor from its identifier. ## -parameters ### -param deviceId -The sensor identifier. +[The sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) ## -returns Returns the [ActivitySensor](activitysensor.md) object from its identifier. @@ -25,6 +25,5 @@ Returns the [ActivitySensor](activitysensor.md) object from its identifier. ## -see-also - ## -capabilities activity \ No newline at end of file diff --git a/windows.devices.sensors/altimeter_maxbatchsize.md b/windows.devices.sensors/altimeter_maxbatchsize.md new file mode 100644 index 0000000000..17886f38cb --- /dev/null +++ b/windows.devices.sensors/altimeter_maxbatchsize.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Devices.Sensors.Altimeter.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Altimeter.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](altimeter_reportlatency.md). The maximum latency equals the [ReportInterval](altimeter_reportinterval.md) times the [MaxBatchSize](altimeter_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/altimeter_reportlatency.md b/windows.devices.sensors/altimeter_reportlatency.md new file mode 100644 index 0000000000..00de27ba1b --- /dev/null +++ b/windows.devices.sensors/altimeter_reportlatency.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.Devices.Sensors.Altimeter.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Altimeter.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](altimeter_readingchanged.md) events. + +Not all sensors support [ReportLatency](altimeter_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](altimeter_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](altimeter_reportlatency.md) equals the [MaxBatchSize](altimeter_maxbatchsize.md) times the [ReportInterval](altimeter_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](altimeter_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](altimeter_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/altimeterreading_performancecount.md b/windows.devices.sensors/altimeterreading_performancecount.md new file mode 100644 index 0000000000..ac54220b25 --- /dev/null +++ b/windows.devices.sensors/altimeterreading_performancecount.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.Sensors.AltimeterReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AltimeterReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/altimeterreading_properties.md b/windows.devices.sensors/altimeterreading_properties.md new file mode 100644 index 0000000000..031e3a88b8 --- /dev/null +++ b/windows.devices.sensors/altimeterreading_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.AltimeterReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.AltimeterReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/barometer_fromidasync_1322863552.md b/windows.devices.sensors/barometer_fromidasync_1322863552.md new file mode 100644 index 0000000000..283c446974 --- /dev/null +++ b/windows.devices.sensors/barometer_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.Barometer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Barometer.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [Barometer](Barometer.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/barometer_getdeviceselector_838466080.md b/windows.devices.sensors/barometer_getdeviceselector_838466080.md new file mode 100644 index 0000000000..dec0b5d8ce --- /dev/null +++ b/windows.devices.sensors/barometer_getdeviceselector_838466080.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Sensors.Barometer.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Barometer.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/barometer_maxbatchsize.md b/windows.devices.sensors/barometer_maxbatchsize.md new file mode 100644 index 0000000000..d2d7c393f1 --- /dev/null +++ b/windows.devices.sensors/barometer_maxbatchsize.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.Devices.Sensors.Barometer.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Barometer.MaxBatchSize + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](Barometer_readingchanged.md) events. + +Not all sensors support [ReportLatency](Barometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](Barometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](Barometer_reportlatency.md) equals the [MaxBatchSize](Barometer_maxbatchsize.md) times the [ReportInterval](Barometer_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](Barometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](Barometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometer_reportlatency.md b/windows.devices.sensors/barometer_reportlatency.md new file mode 100644 index 0000000000..446c601c6c --- /dev/null +++ b/windows.devices.sensors/barometer_reportlatency.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.Devices.Sensors.Barometer.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Barometer.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](Barometer_readingchanged.md) events. + +Not all sensors support [ReportLatency](Barometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](Barometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](Barometer_reportlatency.md) equals the [MaxBatchSize](Barometer_maxbatchsize.md) times the [ReportInterval](Barometer_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](Barometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](Barometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/barometerreading_performancecount.md b/windows.devices.sensors/barometerreading_performancecount.md new file mode 100644 index 0000000000..a73ccd02c4 --- /dev/null +++ b/windows.devices.sensors/barometerreading_performancecount.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.Sensors.BarometerReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.BarometerReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/barometerreading_properties.md b/windows.devices.sensors/barometerreading_properties.md new file mode 100644 index 0000000000..571d4222c8 --- /dev/null +++ b/windows.devices.sensors/barometerreading_properties.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.Sensors.BarometerReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.BarometerReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples \ No newline at end of file diff --git a/windows.devices.sensors/compass_fromidasync_1322863552.md b/windows.devices.sensors/compass_fromidasync_1322863552.md new file mode 100644 index 0000000000..b148775631 --- /dev/null +++ b/windows.devices.sensors/compass_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.Compass.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Compass.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [Compass](Compass.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/compass_getdeviceselector_838466080.md b/windows.devices.sensors/compass_getdeviceselector_838466080.md new file mode 100644 index 0000000000..bfbe50da77 --- /dev/null +++ b/windows.devices.sensors/compass_getdeviceselector_838466080.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Sensors.Compass.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Compass.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/compass_maxbatchsize.md b/windows.devices.sensors/compass_maxbatchsize.md new file mode 100644 index 0000000000..41128e4cb7 --- /dev/null +++ b/windows.devices.sensors/compass_maxbatchsize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.Compass.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Compass.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](Compass_reportlatency.md). The maximum latency equals the [ReportInterval](Compass_reportinterval.md) times the [MaxBatchSize](Compass_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/compass_reportlatency.md b/windows.devices.sensors/compass_reportlatency.md new file mode 100644 index 0000000000..d8f073a3e5 --- /dev/null +++ b/windows.devices.sensors/compass_reportlatency.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.Devices.Sensors.Compass.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Compass.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](Compass_readingchanged.md) events. + +Not all sensors support [ReportLatency](Compass_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](Compass_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](Compass_reportlatency.md) equals the [MaxBatchSize](Compass_maxbatchsize.md) times the [ReportInterval](Compass_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](Compass_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](Compass_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/compassreading_performancecount.md b/windows.devices.sensors/compassreading_performancecount.md new file mode 100644 index 0000000000..d72b41a8a4 --- /dev/null +++ b/windows.devices.sensors/compassreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.CompassReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/compassreading_properties.md b/windows.devices.sensors/compassreading_properties.md new file mode 100644 index 0000000000..d29e2992a9 --- /dev/null +++ b/windows.devices.sensors/compassreading_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.CompassReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.CompassReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/gyrometer_fromidasync_1322863552.md b/windows.devices.sensors/gyrometer_fromidasync_1322863552.md new file mode 100644 index 0000000000..3f69be38ef --- /dev/null +++ b/windows.devices.sensors/gyrometer_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.Gyrometer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Gyrometer.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [Gyrometer](Gyrometer.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/gyrometer_getdeviceselector_838466080.md b/windows.devices.sensors/gyrometer_getdeviceselector_838466080.md new file mode 100644 index 0000000000..1ec384b827 --- /dev/null +++ b/windows.devices.sensors/gyrometer_getdeviceselector_838466080.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Sensors.Gyrometer.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Gyrometer.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/gyrometer_maxbatchsize.md b/windows.devices.sensors/gyrometer_maxbatchsize.md new file mode 100644 index 0000000000..01d1cae79e --- /dev/null +++ b/windows.devices.sensors/gyrometer_maxbatchsize.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Sensors.Gyrometer.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Gyrometer.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](Gyrometer_reportlatency.md). The maximum latency equals the [ReportInterval](Gyrometer_reportinterval.md) times the [MaxBatchSize](Gyrometer_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/gyrometer_reportlatency.md b/windows.devices.sensors/gyrometer_reportlatency.md new file mode 100644 index 0000000000..125da51abc --- /dev/null +++ b/windows.devices.sensors/gyrometer_reportlatency.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.Devices.Sensors.Gyrometer.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Gyrometer.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](Gyrometer_readingchanged.md) events. + +Not all sensors support [ReportLatency](Gyrometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](Gyrometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](Gyrometer_reportlatency.md) equals the [MaxBatchSize](Gyrometer_maxbatchsize.md) times the [ReportInterval](Gyrometer_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](Gyrometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](Gyrometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/gyrometerreading_performancecount.md b/windows.devices.sensors/gyrometerreading_performancecount.md new file mode 100644 index 0000000000..916f84f3ee --- /dev/null +++ b/windows.devices.sensors/gyrometerreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/gyrometerreading_properties.md b/windows.devices.sensors/gyrometerreading_properties.md new file mode 100644 index 0000000000..e3aef1d922 --- /dev/null +++ b/windows.devices.sensors/gyrometerreading_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.GyrometerReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.GyrometerReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/inclinometer_fromidasync_1322863552.md b/windows.devices.sensors/inclinometer_fromidasync_1322863552.md new file mode 100644 index 0000000000..3709394856 --- /dev/null +++ b/windows.devices.sensors/inclinometer_fromidasync_1322863552.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.Sensors.Inclinometer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Inclinometer.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [Inclinometer](Inclinometer.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/inclinometer_getdeviceselector_2021708380.md b/windows.devices.sensors/inclinometer_getdeviceselector_2021708380.md new file mode 100644 index 0000000000..137994b416 --- /dev/null +++ b/windows.devices.sensors/inclinometer_getdeviceselector_2021708380.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.Sensors.Inclinometer.GetDeviceSelector(Windows.Devices.Sensors.SensorReadingType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Inclinometer.GetDeviceSelector + +## -description +Gets the device selector. + +## -parameters +### -param readingType +The type of sesnsor to retrieve. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/inclinometer_maxbatchsize.md b/windows.devices.sensors/inclinometer_maxbatchsize.md new file mode 100644 index 0000000000..54da7d5374 --- /dev/null +++ b/windows.devices.sensors/inclinometer_maxbatchsize.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](Inclinometer_reportlatency.md). The maximum latency equals the [ReportInterval](Inclinometer_reportinterval.md) times the [MaxBatchSize](Inclinometer_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/inclinometer_reportlatency.md b/windows.devices.sensors/inclinometer_reportlatency.md new file mode 100644 index 0000000000..58747b2170 --- /dev/null +++ b/windows.devices.sensors/inclinometer_reportlatency.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.Devices.Sensors.Inclinometer.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Inclinometer.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](Inclinometer_readingchanged.md) events. + +Not all sensors support [ReportLatency](Inclinometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](Inclinometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](Inclinometer_reportlatency.md) equals the [MaxBatchSize](Inclinometer_maxbatchsize.md) times the [ReportInterval](Inclinometer_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](Inclinometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](Inclinometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/inclinometerreading_performancecount.md b/windows.devices.sensors/inclinometerreading_performancecount.md new file mode 100644 index 0000000000..8ceae80c79 --- /dev/null +++ b/windows.devices.sensors/inclinometerreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/inclinometerreading_properties.md b/windows.devices.sensors/inclinometerreading_properties.md new file mode 100644 index 0000000000..32ed95e96d --- /dev/null +++ b/windows.devices.sensors/inclinometerreading_properties.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.Sensors.InclinometerReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.InclinometerReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/lightsensor_fromidasync_1322863552.md b/windows.devices.sensors/lightsensor_fromidasync_1322863552.md new file mode 100644 index 0000000000..1183e67b63 --- /dev/null +++ b/windows.devices.sensors/lightsensor_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.LightSensor.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.LightSensor.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [LightSensor](LightSensor.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/lightsensor_getdeviceselector_838466080.md b/windows.devices.sensors/lightsensor_getdeviceselector_838466080.md new file mode 100644 index 0000000000..229d50c236 --- /dev/null +++ b/windows.devices.sensors/lightsensor_getdeviceselector_838466080.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Sensors.LightSensor.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.LightSensor.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/lightsensor_maxbatchsize.md b/windows.devices.sensors/lightsensor_maxbatchsize.md new file mode 100644 index 0000000000..3e3e3f0992 --- /dev/null +++ b/windows.devices.sensors/lightsensor_maxbatchsize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.LightSensor.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensor.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](LightSensor_reportlatency.md). The maximum latency equals the [ReportInterval](LightSensor_reportinterval.md) times the [MaxBatchSize](LightSensor_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/lightsensor_reportlatency.md b/windows.devices.sensors/lightsensor_reportlatency.md new file mode 100644 index 0000000000..42e1782823 --- /dev/null +++ b/windows.devices.sensors/lightsensor_reportlatency.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.Devices.Sensors.LightSensor.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensor.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](LightSensor_readingchanged.md) events. + +Not all sensors support [ReportLatency](LightSensor_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](LightSensor_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](LightSensor_reportlatency.md) equals the [MaxBatchSize](LightSensor_maxbatchsize.md) times the [ReportInterval](LightSensor_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](LightSensor_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](LightSensor_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/lightsensorreading_performancecount.md b/windows.devices.sensors/lightsensorreading_performancecount.md new file mode 100644 index 0000000000..367129895d --- /dev/null +++ b/windows.devices.sensors/lightsensorreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.LightSensorReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensorReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/lightsensorreading_properties.md b/windows.devices.sensors/lightsensorreading_properties.md new file mode 100644 index 0000000000..6ed32ee04b --- /dev/null +++ b/windows.devices.sensors/lightsensorreading_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.LightSensorReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.LightSensorReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/magnetometer_fromidasync_1322863552.md b/windows.devices.sensors/magnetometer_fromidasync_1322863552.md new file mode 100644 index 0000000000..5dadbb51e4 --- /dev/null +++ b/windows.devices.sensors/magnetometer_fromidasync_1322863552.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.Sensors.Magnetometer.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Magnetometer.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [Magnetometer](Magnetometer.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/magnetometer_getdeviceselector_838466080.md b/windows.devices.sensors/magnetometer_getdeviceselector_838466080.md new file mode 100644 index 0000000000..e6147d46f2 --- /dev/null +++ b/windows.devices.sensors/magnetometer_getdeviceselector_838466080.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Sensors.Magnetometer.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.Magnetometer.GetDeviceSelector + +## -description +Gets the device selector. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/magnetometer_maxbatchsize.md b/windows.devices.sensors/magnetometer_maxbatchsize.md new file mode 100644 index 0000000000..5ebaf105d9 --- /dev/null +++ b/windows.devices.sensors/magnetometer_maxbatchsize.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Sensors.Magnetometer.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Magnetometer.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](Magnetometer_reportlatency.md). The maximum latency equals the [ReportInterval](Magnetometer_reportinterval.md) times the [MaxBatchSize](Magnetometer_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also + diff --git a/windows.devices.sensors/magnetometer_reportlatency.md b/windows.devices.sensors/magnetometer_reportlatency.md new file mode 100644 index 0000000000..0e31959b89 --- /dev/null +++ b/windows.devices.sensors/magnetometer_reportlatency.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.Devices.Sensors.Magnetometer.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.Magnetometer.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](Magnetometer_readingchanged.md) events. + +Not all sensors support [ReportLatency](Magnetometer_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](Magnetometer_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](Magnetometer_reportlatency.md) equals the [MaxBatchSize](Magnetometer_maxbatchsize.md) times the [ReportInterval](Magnetometer_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](Magnetometer_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](Magnetometer_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/magnetometerreading_performancecount.md b/windows.devices.sensors/magnetometerreading_performancecount.md new file mode 100644 index 0000000000..1cbec43cb1 --- /dev/null +++ b/windows.devices.sensors/magnetometerreading_performancecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/magnetometerreading_properties.md b/windows.devices.sensors/magnetometerreading_properties.md new file mode 100644 index 0000000000..f3799959cf --- /dev/null +++ b/windows.devices.sensors/magnetometerreading_properties.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Sensors.MagnetometerReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.MagnetometerReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + + diff --git a/windows.devices.sensors/orientationsensor_fromidasync_1322863552.md b/windows.devices.sensors/orientationsensor_fromidasync_1322863552.md new file mode 100644 index 0000000000..830d8ffd07 --- /dev/null +++ b/windows.devices.sensors/orientationsensor_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.FromIdAsync + +## -description +Asynchronously obtains the sensor from its identifier. + +## -parameters +### -param deviceId +The [sensor identifier](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) + +## -returns +Returns the [OrientationSensor](OrientationSensor.md) object from its identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/orientationsensor_getdeviceselector_2021708380.md b/windows.devices.sensors/orientationsensor_getdeviceselector_2021708380.md new file mode 100644 index 0000000000..fe2cea31e3 --- /dev/null +++ b/windows.devices.sensors/orientationsensor_getdeviceselector_2021708380.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDeviceSelector(Windows.Devices.Sensors.SensorReadingType) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetDeviceSelector + +## -description +Gets the device selector. + +## -parameters +### -param readingType +The type of sensor to retrieve. + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.sensors/orientationsensor_getdeviceselector_332761380.md b/windows.devices.sensors/orientationsensor_getdeviceselector_332761380.md new file mode 100644 index 0000000000..2f19893965 --- /dev/null +++ b/windows.devices.sensors/orientationsensor_getdeviceselector_332761380.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Devices.Sensors.OrientationSensor.GetDeviceSelector(Windows.Devices.Sensors.SensorReadingType,Windows.Devices.Sensors.SensorOptimizationGoal) +-api-type: winrt method +--- + + + +# Windows.Devices.Sensors.OrientationSensor.GetDeviceSelector + +## -description +Gets the device selector. + +## -parameters +### -param readingType +The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated. + +### -param optimizationGoal +Indicates the preferences of optimization for the sensor. This field is only used if an Absolute SensorReadingType is specified. An optimizationGoal of Precision will return an OrientationSensor using an accelereometer, a gyrometer, and a magnetometer to determine orientation with respect to magnetic North. This has the potential to use a lot of power due to it’s use of a gyrometer. In contrast, specifying an optimizationGoal of PowerEfficiency will return an OrientationSensor using an accelerometer and magnetometer only (no gyrometer) to save power at the a cost of some accuracy (readings will still be relatively accurate in most circumstances). + +## -returns +Returns the device selector, if it exists; otherwise, null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.sensors/orientationsensor_maxbatchsize.md b/windows.devices.sensors/orientationsensor_maxbatchsize.md new file mode 100644 index 0000000000..7c75d86d22 --- /dev/null +++ b/windows.devices.sensors/orientationsensor_maxbatchsize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.MaxBatchSize +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.MaxBatchSize + +## -description +Gets the maximum number of events that can be batched by the sensor. + +## -property-value +The maximum number of batched events. + +## -remarks +A sensor may not support batched data collection. In that case, this property will be 0. Otherwise, this determines the maximum number of events the sensor can gather before submitting them. This in turn will determine the maximum supported [ReportLatency](OrientationSensor_reportlatency.md). The maximum latency equals the [ReportInterval](OrientationSensor_reportinterval.md) times the [MaxBatchSize](OrientationSensor_maxbatchsize.md). For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensor_reportlatency.md b/windows.devices.sensors/orientationsensor_reportlatency.md new file mode 100644 index 0000000000..f8854f291a --- /dev/null +++ b/windows.devices.sensors/orientationsensor_reportlatency.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensor.ReportLatency +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensor.ReportLatency + +## -description +Gets or sets the delay between batches of sensor information. + +## -property-value +The delay between batches of sensor information in milliseconds. + +## -remarks +This property is in reference to the frequency of [ReadingChanged](OrientationSensor_readingchanged.md) events. + +Not all sensors support [ReportLatency](OrientationSensor_reportlatency.md). If the sensor does not support this property, it will function the same as if you set this value to 0. Setting this value to 0 will use the default latency for the sensor. + +If you set [ReportLatency](OrientationSensor_reportlatency.md) to a value higher than the maximum supported latency, the sensor will use the maximum supported latency. However, this property will not change in value. The maximum possible [ReportLatency](OrientationSensor_reportlatency.md) equals the [MaxBatchSize](OrientationSensor_maxbatchsize.md) times the [ReportInterval](OrientationSensor_reportinterval.md). + +Be aware that multiple applications could be dependent on a single sensor. Each of those applications can set a different value for [ReportLatency](OrientationSensor_reportlatency.md). In this scenario, the sensor needs to try to accommodate the lowest value for [ReportLatency](OrientationSensor_reportlatency.md). Because of this, the actual latency may not match the latency defined by this property in your application. This property corresponds to your ideal latency, which may not be the same latency on the sensor. + +For more information about sensor batching, see [Sensors](http://msdn.microsoft.com/library/415f4107-0612-4235-9722-0f5e4e26f957). + +## -examples + +## -see-also diff --git a/windows.devices.sensors/orientationsensorreading_performancecount.md b/windows.devices.sensors/orientationsensorreading_performancecount.md new file mode 100644 index 0000000000..89aaed90ec --- /dev/null +++ b/windows.devices.sensors/orientationsensorreading_performancecount.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReading.PerformanceCount +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReading.PerformanceCount + +## -description +Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system. + +## -property-value +The performance count for the reading. Null if this property is not supported on the sensor. + +## -remarks + +## -see-also + +## -examples + + + diff --git a/windows.devices.sensors/orientationsensorreading_properties.md b/windows.devices.sensors/orientationsensorreading_properties.md new file mode 100644 index 0000000000..f07a6acd7c --- /dev/null +++ b/windows.devices.sensors/orientationsensorreading_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Sensors.OrientationSensorReading.Properties +-api-type: winrt property +--- + + + +# Windows.Devices.Sensors.OrientationSensorReading.Properties + +## -description +Gets the data properties reported by the sensor. + +## -property-value +Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_issupported_930300905.md b/windows.devices.smartcards/smartcardcryptogramgenerator_issupported_930300905.md new file mode 100644 index 0000000000..b81093565e --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_issupported_930300905.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.IsSupported +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.IsSupported + +## -description +Returns whether the SmartCardCryptogramGenerator is supported. + +## -returns +True if SmartCardCryptogramGenerator is supported. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md b/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md index 53fd1770ec..97d9f3fc9b 100644 --- a/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md +++ b/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md @@ -53,9 +53,13 @@ An unknown error occurred. ### -field ValidationFailed:12 +### -field NotSupported:13 + + ## -remarks ## -examples ## -see-also [Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) + diff --git a/windows.devices.smartcards/smartcardemulator_issupported_930300905.md b/windows.devices.smartcards/smartcardemulator_issupported_930300905.md new file mode 100644 index 0000000000..839fc66017 --- /dev/null +++ b/windows.devices.smartcards/smartcardemulator_issupported_930300905.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardEmulator.IsSupported +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardEmulator.IsSupported + +## -description +Returns whether the SmartCardEmulator is supported. + +## -returns +True if SmartCardEmulator is supported. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.wifi/wifiadapter_connectasync_711959520.md b/windows.devices.wifi/wifiadapter_connectasync_711959520.md new file mode 100644 index 0000000000..5000e8fe9c --- /dev/null +++ b/windows.devices.wifi/wifiadapter_connectasync_711959520.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.ConnectAsync(Windows.Devices.WiFi.WiFiAvailableNetwork,Windows.Devices.WiFi.WiFiReconnectionKind,Windows.Security.Credentials.PasswordCredential,System.String,Windows.Devices.WiFi.WiFiConnectionMethod) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.ConnectAsync + +## -description +Connect this Wi-Fi device to a hidden network, with the given passphrase, connection method, and reconnection policy. +## -parameters +### -param availableNetwork +Specifies the Wi-Fi network to connect to. +### -param reconnectionKind +Specifies how to reconnect if the connection is lost. +### -param passwordCredential +The passphrase to be used to connect to the access point. +### -param ssid +When the network SSID is hidden, use this parameter to provide the SSID. +### -param connectionMethod +A WiFiConnectionMethod enumeration member indicating the connection method. +## -returns +An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation. +## -remarks + +## -see-also +[ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential)](wifiadapter_connectasync_1490922496.md), [ConnectAsync(WiFiAvailableNetwork, WiFiReconnectionKind, PasswordCredential, String)](wifiadapter_connectasync_1798151424.md) +## -examples + diff --git a/windows.devices.wifi/wifiadapter_getwpsconfigurationasync_1613138554.md b/windows.devices.wifi/wifiadapter_getwpsconfigurationasync_1613138554.md new file mode 100644 index 0000000000..0f8f71bcd9 --- /dev/null +++ b/windows.devices.wifi/wifiadapter_getwpsconfigurationasync_1613138554.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.WiFi.WiFiAdapter.GetWpsConfigurationAsync(Windows.Devices.WiFi.WiFiAvailableNetwork) +-api-type: winrt method +--- + + + +# Windows.Devices.WiFi.WiFiAdapter.GetWpsConfigurationAsync + +## -description +Performs WPS discovery to query the WPS methods supported by the network. +## -parameters +### -param availableNetwork +An available Wi-Fi network. See WiFiAvailableNetwork class. +## -returns +On successful completion, returns a [WiFiWpsConfigurationResult](WiFiWpsConfigurationResult.md). +## -remarks + +## -see-also +[WiFiWpsConfigurationResult](WiFiWpsConfigurationResult.md), [WiFiAvailableNetwork](WiFiAvailableNetwork.md) +## -examples + diff --git a/windows.devices.wifi/wificonnectionmethod.md b/windows.devices.wifi/wificonnectionmethod.md new file mode 100644 index 0000000000..7100aae1f6 --- /dev/null +++ b/windows.devices.wifi/wificonnectionmethod.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Devices.WiFi.WiFiConnectionMethod +-api-type: winrt enum +--- + + + +# Windows.Devices.WiFi.WiFiConnectionMethod + +## -description +Describes the kinds of connection methods. +## -enum-fields +### -field WpsPushButton:2 +WPS protected setup. +### -field WpsPin:1 +WPS pin. +### -field Default:0 +Default. +## -remarks + +## -see-also +[WiFiAdapter.ConnectAsync](wifiadapter_connectasync.md) +## -examples + diff --git a/windows.devices.wifi/wificonnectionresult.md b/windows.devices.wifi/wificonnectionresult.md index 2efb90bfb0..9bef7465f8 100644 --- a/windows.devices.wifi/wificonnectionresult.md +++ b/windows.devices.wifi/wificonnectionresult.md @@ -19,3 +19,4 @@ An instance of this class is created and returned by the [WiFiAdapter.ConnectAsy ## -examples ## -see-also +[WiFiAdapter.ConnectAsync](wifiadapter_connectasync.md) \ No newline at end of file diff --git a/windows.devices.wifi/wifiwpsconfigurationresult.md b/windows.devices.wifi/wifiwpsconfigurationresult.md new file mode 100644 index 0000000000..5b5bb78049 --- /dev/null +++ b/windows.devices.wifi/wifiwpsconfigurationresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Devices.WiFi.WiFiWpsConfigurationResult +-api-type: winrt class +--- + + + +# Windows.Devices.WiFi.WiFiWpsConfigurationResult + +## -description +Wifi configuration result returned by a call to [GetWpsConfigurationAsync](wifiadapter_getwpsconfigurationasync_1613138554.md). +## -remarks + +## -see-also +[GetWpsConfigurationAsync](wifiadapter_getwpsconfigurationasync_1613138554.md) +## -examples + diff --git a/windows.devices.wifi/wifiwpsconfigurationresult_status.md b/windows.devices.wifi/wifiwpsconfigurationresult_status.md new file mode 100644 index 0000000000..07d8fe642d --- /dev/null +++ b/windows.devices.wifi/wifiwpsconfigurationresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.WiFi.WiFiWpsConfigurationResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiWpsConfigurationResult.Status + +## -description +The status of a [GetWpsConfigurationAsync](wifiadapter_getwpsconfigurationasync_1613138554.md) call. +## -property-value +A [WiFiWpsConfigurationStatus](wifiwpsconfigurationstatus.md) enumeration member indicating the status of the call. +## -remarks + +## -see-also +[GetWpsConfigurationAsync](wifiadapter_getwpsconfigurationasync_1613138554.md) +[WiFiWpsConfigurationStatus](wifiwpsconfigurationstatus.md) +## -examples + diff --git a/windows.devices.wifi/wifiwpsconfigurationresult_supportedwpskinds.md b/windows.devices.wifi/wifiwpsconfigurationresult_supportedwpskinds.md new file mode 100644 index 0000000000..e30b8e065f --- /dev/null +++ b/windows.devices.wifi/wifiwpsconfigurationresult_supportedwpskinds.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Devices.WiFi.WiFiWpsConfigurationResult.SupportedWpsKinds +-api-type: winrt property +--- + + + +# Windows.Devices.WiFi.WiFiWpsConfigurationResult.SupportedWpsKinds + +## -description +A list of supported WPS connection methods. +## -property-value +A list of supported WPS connection methods. +## -remarks + +## -see-also +[WiFiWpsKind](WiFiWpsKind.md) +## -examples + diff --git a/windows.devices.wifi/wifiwpsconfigurationstatus.md b/windows.devices.wifi/wifiwpsconfigurationstatus.md new file mode 100644 index 0000000000..bc6c41288d --- /dev/null +++ b/windows.devices.wifi/wifiwpsconfigurationstatus.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Devices.WiFi.WiFiWpsConfigurationStatus +-api-type: winrt enum +--- + + + +# Windows.Devices.WiFi.WiFiWpsConfigurationStatus + +## -description +Describes the status of the [GetWpsConfigurationAsync](wifiadapter_getwpsconfigurationasync_1613138554.md) call. +## -enum-fields +### -field UnspecifiedFailure:0 +Connection failed for a reason other than those in this list. +### -field Timeout:2 +Connection failed because the connection attempt timed out. +### -field Success:1 +Connection succeeded. +## -remarks + +## -see-also +[GetWpsConfigurationAsync](wifiadapter_getwpsconfigurationasync_1613138554.md) +## -examples + diff --git a/windows.devices.wifi/wifiwpskind.md b/windows.devices.wifi/wifiwpskind.md new file mode 100644 index 0000000000..4e109b48ac --- /dev/null +++ b/windows.devices.wifi/wifiwpskind.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.Devices.WiFi.WiFiWpsKind +-api-type: winrt enum +--- + + + +# Windows.Devices.WiFi.WiFiWpsKind + +## -description +Describes the kinds of WPS connection methods. +## -enum-fields +### -field Usb:5 +Not used. +### -field Unknown:0 +Unknown. +### -field PushButton:2 +WPS push button. +### -field Pin:1 +WPS pin. +### -field Nfc:3 +Near field communication. +### -field Ethernet:4 +Not used. +## -remarks + +## -see-also +[WiFiAdapter.ConnectAsync](wifiadapter_connectasync.md) +## -examples + diff --git a/windows.foundation/uri.md b/windows.foundation/uri.md index 70b57835f4..7b7b91d2df 100644 --- a/windows.foundation/uri.md +++ b/windows.foundation/uri.md @@ -1,4 +1,4 @@ -****--- +--- -api-id: T:Windows.Foundation.Uri -api-type: winrt class --- diff --git a/windows.gaming.input.preview/gamecontrollerproviderinfo_getparentproviderid_1741648735.md b/windows.gaming.input.preview/gamecontrollerproviderinfo_getparentproviderid_1741648735.md new file mode 100644 index 0000000000..f437304023 --- /dev/null +++ b/windows.gaming.input.preview/gamecontrollerproviderinfo_getparentproviderid_1741648735.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Gaming.Input.Preview.GameControllerProviderInfo.GetParentProviderId(Windows.Gaming.Input.Custom.IGameControllerProvider) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Preview.GameControllerProviderInfo.GetParentProviderId + +## -description + +## -parameters +### -param provider + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input/rawgamecontroller_displayname.md b/windows.gaming.input/rawgamecontroller_displayname.md new file mode 100644 index 0000000000..e983b41c00 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_displayname.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.DisplayName +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.DisplayName + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input/rawgamecontroller_nonroamableid.md b/windows.gaming.input/rawgamecontroller_nonroamableid.md new file mode 100644 index 0000000000..d12f05b835 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_nonroamableid.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.NonRoamableId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.NonRoamableId + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input/rawgamecontroller_simplehapticscontrollers.md b/windows.gaming.input/rawgamecontroller_simplehapticscontrollers.md new file mode 100644 index 0000000000..f18957f3b6 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_simplehapticscontrollers.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.SimpleHapticsControllers +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.SimpleHapticsControllers + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.printing.printticket/printticketcapabilities.md b/windows.graphics.printing.printticket/printticketcapabilities.md index 70851a0824..4888547622 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities.md +++ b/windows.graphics.printing.printticket/printticketcapabilities.md @@ -1,19 +1,21 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities + ## -description +This class presents the configuration options that are supported by the printer. It contains read-only print feature objects with certain options available for each. ## -remarks ## -see-also +[IPrintSchemaCapabilities interface](https://msdn.microsoft.com/library/windows/hardware/hh451256(v=vs.85).aspx) ## -examples diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentbindingfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentbindingfeature.md index a786a5e4b9..471620e3f1 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentbindingfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentbindingfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentBindingFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentBindingFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentBindingFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentBindingFeature + ## -description +Gets the available document binding feature for this print ticket. ## -property-value +The document binding feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentcollatefeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentcollatefeature.md index 6bef35bafa..de1e51364e 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentcollatefeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentcollatefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentCollateFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentCollateFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentCollateFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentCollateFeature + ## -description +Gets the available document collation feature for this print ticket. ## -property-value +The document collation feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentduplexfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentduplexfeature.md index 349461b6c0..f6b4566be8 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentduplexfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentduplexfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentDuplexFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentDuplexFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentDuplexFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentDuplexFeature + ## -description +Gets the available duplex printing feature for this print ticket. ## -property-value +The duplex printing feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentholepunchfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentholepunchfeature.md index 0314af6228..3045cd9ea2 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentholepunchfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentholepunchfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentHolePunchFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentHolePunchFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentHolePunchFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentHolePunchFeature + ## -description +Gets the available document hole-punch feature for this print ticket. ## -property-value +The document hole-punch feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentinputbinfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentinputbinfeature.md index 1ab1c03860..fc74393895 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentinputbinfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentinputbinfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentInputBinFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentInputBinFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentInputBinFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentInputBinFeature + ## -description +Gets the available printing input bin feature for this print ticket. ## -property-value +The printing input bin feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentnupfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentnupfeature.md index ceb447ed85..0acf58f7c2 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentnupfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentnupfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentNUpFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentNUpFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentNUpFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentNUpFeature + ## -description +Gets the available N-up printing feature for this print ticket. ## -property-value +The N-up printing feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_documentstaplefeature.md b/windows.graphics.printing.printticket/printticketcapabilities_documentstaplefeature.md index 16c4cb523b..8cfc40f0a2 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_documentstaplefeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_documentstaplefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentStapleFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentStapleFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentStapleFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.DocumentStapleFeature + ## -description +Gets the available document staple feature for this print ticket. ## -property-value +The document staple feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_getfeature_762742941.md b/windows.graphics.printing.printticket/printticketcapabilities_getfeature_762742941.md index 7948b5c2e4..6162c61839 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_getfeature_762742941.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_getfeature_762742941.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetFeature(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetFeature(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetFeature + ## -description +Gets the specified print feature object. ## -parameters ### -param name +The canonical name of the print feature. ### -param xmlNamespace +The XML namespace of the print feature. ## -returns +The specified print feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_getparameterdefinition_2112900584.md b/windows.graphics.printing.printticket/printticketcapabilities_getparameterdefinition_2112900584.md index 83986e9c6f..38e2e3ee16 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_getparameterdefinition_2112900584.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_getparameterdefinition_2112900584.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetParameterDefinition(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetParameterDefinition(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetParameterDefinition - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.GetParameterDefinition + ## -description +Gets the parameter definition object for the specified printing parameter. ## -parameters ### -param name +The canonical name of the printing parameter. ### -param xmlNamespace +The XML namespace of the printing parameter. ## -returns +The parameter definition object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_jobpasscodefeature.md b/windows.graphics.printing.printticket/printticketcapabilities_jobpasscodefeature.md index 8a82acbffc..7d255a58e5 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_jobpasscodefeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_jobpasscodefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.JobPasscodeFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.JobPasscodeFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.JobPasscodeFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.JobPasscodeFeature + ## -description +Gets the avilable job passcode feature for this print ticket. ## -property-value +The job passcode feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_name.md b/windows.graphics.printing.printticket/printticketcapabilities_name.md index 609adef320..13d3a6bf86 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_name.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_name.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.Name --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.Name +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.Name - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.Name + ## -description +Gets the canonical name of this object. ## -property-value +The canonical name. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pageborderlessfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pageborderlessfeature.md index af8f8179a9..04b29b748f 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pageborderlessfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pageborderlessfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageBorderlessFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageBorderlessFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageBorderlessFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageBorderlessFeature + ## -description +Gets the available document borderless feature for this print ticket. ## -property-value +The borderless feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pagemediasizefeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pagemediasizefeature.md index 72d9b022e3..2e462f9d42 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pagemediasizefeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pagemediasizefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaSizeFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaSizeFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaSizeFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaSizeFeature + ## -description +Gets the available page media size feature for this print ticket. ## -property-value +The page media size feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pagemediatypefeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pagemediatypefeature.md index 72f008d48f..49f658a272 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pagemediatypefeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pagemediatypefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaTypeFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaTypeFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaTypeFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageMediaTypeFeature + ## -description +Gets the available page media type feature for this print ticket. ## -property-value +The page media type feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pageorientationfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pageorientationfeature.md index 6b51909fc9..7783754f55 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pageorientationfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pageorientationfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOrientationFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOrientationFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOrientationFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOrientationFeature + ## -description +Gets the available page orientation feature for this print ticket. ## -property-value +The page orientation feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pageoutputcolorfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pageoutputcolorfeature.md index 81917eb535..5338a093fb 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pageoutputcolorfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pageoutputcolorfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputColorFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputColorFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputColorFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputColorFeature + ## -description +Gets the available page color feature for this print ticket. ## -property-value +The page color feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pageoutputqualityfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pageoutputqualityfeature.md index 27ef762134..0f11eb05d1 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pageoutputqualityfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pageoutputqualityfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputQualityFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputQualityFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputQualityFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageOutputQualityFeature + ## -description +Gets the available page quality feature for this print ticket. ## -property-value +The page quality feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_pageresolutionfeature.md b/windows.graphics.printing.printticket/printticketcapabilities_pageresolutionfeature.md index 7e71f54404..5be1f66b6a 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_pageresolutionfeature.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_pageresolutionfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageResolutionFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageResolutionFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageResolutionFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.PageResolutionFeature + ## -description +Gets the available page resolution feature for this print ticket. ## -property-value +The page resolution feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_xmlnamespace.md b/windows.graphics.printing.printticket/printticketcapabilities_xmlnamespace.md index 846b4b0737..16454d6848 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_xmlnamespace.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_xmlnamespace.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNamespace --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNamespace +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNamespace - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNamespace + ## -description +Gets the XML namespace for this capabilities object. ## -property-value +The XML namespace. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketcapabilities_xmlnode.md b/windows.graphics.printing.printticket/printticketcapabilities_xmlnode.md index 0221bdd9d8..63a69ee94e 100644 --- a/windows.graphics.printing.printticket/printticketcapabilities_xmlnode.md +++ b/windows.graphics.printing.printticket/printticketcapabilities_xmlnode.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNode --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNode +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketCapabilities.XmlNode + ## -description +Gets the XML node for this capabilities object. ## -property-value +The XML node. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature.md b/windows.graphics.printing.printticket/printticketfeature.md index bd24bf8351..29a48fcc8d 100644 --- a/windows.graphics.printing.printticket/printticketfeature.md +++ b/windows.graphics.printing.printticket/printticketfeature.md @@ -1,19 +1,22 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature + ## -description +Represents a modifiable feature of the print ticket. A feature is a device capability that has an enumerable list of settings, unlike a parameter which can be set to values within a range. ## -remarks ## -see-also +[PrintTicketOption](PrintTicketOption.md) +[IPrintSchemaFeature interface](https://msdn.microsoft.com/library/windows/hardware/hh451284(v=vs.85).aspx) ## -examples diff --git a/windows.graphics.printing.printticket/printticketfeature_displayname.md b/windows.graphics.printing.printticket/printticketfeature_displayname.md index 11a262a24e..ec28042862 100644 --- a/windows.graphics.printing.printticket/printticketfeature_displayname.md +++ b/windows.graphics.printing.printticket/printticketfeature_displayname.md @@ -1,19 +1,22 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.DisplayName --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.DisplayName +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.DisplayName - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.DisplayName + ## -description +Gets the friendly name of the print ticket feature. ## -property-value +The friendly name string. ## -remarks +This property should be used for UI display. ## -see-also diff --git a/windows.graphics.printing.printticket/printticketfeature_getoption_1485349949.md b/windows.graphics.printing.printticket/printticketfeature_getoption_1485349949.md index 11f1317f52..17fea05678 100644 --- a/windows.graphics.printing.printticket/printticketfeature_getoption_1485349949.md +++ b/windows.graphics.printing.printticket/printticketfeature_getoption_1485349949.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetOption(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetOption(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetOption - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetOption + ## -description +Gets the specified print feature option object. ## -parameters ### -param name +The canonical name of the print feature option. ### -param xmlNamespace +The XML namespace of the print feature option. ## -returns +The specified print feature option object. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature_getselectedoption_861881258.md b/windows.graphics.printing.printticket/printticketfeature_getselectedoption_861881258.md index 8ac7d54b9f..3b0d2b777b 100644 --- a/windows.graphics.printing.printticket/printticketfeature_getselectedoption_861881258.md +++ b/windows.graphics.printing.printticket/printticketfeature_getselectedoption_861881258.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetSelectedOption --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetSelectedOption +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetSelectedOption - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.GetSelectedOption + ## -description +Gets the option that is currently selected for this print feature. ## -returns +The selected option. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature_name.md b/windows.graphics.printing.printticket/printticketfeature_name.md index b8b3ede3d0..480108d8e5 100644 --- a/windows.graphics.printing.printticket/printticketfeature_name.md +++ b/windows.graphics.printing.printticket/printticketfeature_name.md @@ -1,19 +1,22 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Name --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Name +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Name - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Name + ## -description +Gets the canonical name of the print ticket feature. ## -property-value +The canonical name string. ## -remarks +This property should be used by the app to identify specific print features. ## -see-also diff --git a/windows.graphics.printing.printticket/printticketfeature_options.md b/windows.graphics.printing.printticket/printticketfeature_options.md index 4d1f1c933a..78bbc2a2a1 100644 --- a/windows.graphics.printing.printticket/printticketfeature_options.md +++ b/windows.graphics.printing.printticket/printticketfeature_options.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Options --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Options +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Options - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.Options + ## -description +Gets a list of print ticket options available for this feature. ## -property-value +A list of option objects. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature_selectiontype.md b/windows.graphics.printing.printticket/printticketfeature_selectiontype.md index 1285f0f2dd..cc4dcdd826 100644 --- a/windows.graphics.printing.printticket/printticketfeature_selectiontype.md +++ b/windows.graphics.printing.printticket/printticketfeature_selectiontype.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SelectionType --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SelectionType +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SelectionType - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SelectionType + ## -description +Gets the selection type for this print feature. ## -property-value +The selection type. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature_setselectedoption_543286749.md b/windows.graphics.printing.printticket/printticketfeature_setselectedoption_543286749.md index 22b4cecfa3..278b5b4372 100644 --- a/windows.graphics.printing.printticket/printticketfeature_setselectedoption_543286749.md +++ b/windows.graphics.printing.printticket/printticketfeature_setselectedoption_543286749.md @@ -1,18 +1,20 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SetSelectedOption(Windows.Graphics.Printing.PrintTicket.PrintTicketOption) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SetSelectedOption(Windows.Graphics.Printing.PrintTicket.PrintTicketOption) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SetSelectedOption - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.SetSelectedOption + ## -description +Sets the given option as the selected option for this print feature. ## -parameters ### -param value +The option to be set as selected. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature_xmlnamespace.md b/windows.graphics.printing.printticket/printticketfeature_xmlnamespace.md index 177fb67afe..de82602d0b 100644 --- a/windows.graphics.printing.printticket/printticketfeature_xmlnamespace.md +++ b/windows.graphics.printing.printticket/printticketfeature_xmlnamespace.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNamespace --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNamespace +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNamespace - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNamespace + ## -description +Gets the XML namespace that this print feature belongs to. ## -property-value +The XML namespace for this print feature. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeature_xmlnode.md b/windows.graphics.printing.printticket/printticketfeature_xmlnode.md index 0c878b3c3f..6966076523 100644 --- a/windows.graphics.printing.printticket/printticketfeature_xmlnode.md +++ b/windows.graphics.printing.printticket/printticketfeature_xmlnode.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNode --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNode +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeature.XmlNode + ## -description +Gets the XML node that this print feature belongs to. ## -property-value +The XML node for this print feature. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketfeatureselectiontype.md b/windows.graphics.printing.printticket/printticketfeatureselectiontype.md index a0679b5470..da170fa4db 100644 --- a/windows.graphics.printing.printticket/printticketfeatureselectiontype.md +++ b/windows.graphics.printing.printticket/printticketfeatureselectiontype.md @@ -1,20 +1,23 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketFeatureSelectionType --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketFeatureSelectionType +-api-type: winrt enum +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketFeatureSelectionType - +# Windows.Graphics.Printing.PrintTicket.PrintTicketFeatureSelectionType + ## -description +Contains values that describe the selection type of a print ticket feature. This indicates whether the user can select only one option or multiple for a feature. ## -enum-fields ### -field PickOne:0 +The user must select one option for the print feature. ### -field PickMany:1 +The user can select multiple options for the print feature. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption.md b/windows.graphics.printing.printticket/printticketoption.md index ad547a8532..dfd04512e3 100644 --- a/windows.graphics.printing.printticket/printticketoption.md +++ b/windows.graphics.printing.printticket/printticketoption.md @@ -1,19 +1,22 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketOption --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketOption +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption + ## -description +Represents a single possible setting for a print feature. ## -remarks ## -see-also +[PrintTicketFeature](PrintTicketFeature.md) +[IPrintSchemaOption interface](https://msdn.microsoft.com/library/windows/hardware/hh451335(v=vs.85).aspx) ## -examples diff --git a/windows.graphics.printing.printticket/printticketoption_displayname.md b/windows.graphics.printing.printticket/printticketoption_displayname.md index 300c301dbf..ea3e41a50c 100644 --- a/windows.graphics.printing.printticket/printticketoption_displayname.md +++ b/windows.graphics.printing.printticket/printticketoption_displayname.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.DisplayName --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.DisplayName +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.DisplayName - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.DisplayName + ## -description +Gets the UI-friendly display name of this option. ## -property-value +The display name. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_getpropertynode_192364980.md b/windows.graphics.printing.printticket/printticketoption_getpropertynode_192364980.md index a53d470f58..e7c292d167 100644 --- a/windows.graphics.printing.printticket/printticketoption_getpropertynode_192364980.md +++ b/windows.graphics.printing.printticket/printticketoption_getpropertynode_192364980.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyNode(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyNode(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyNode + ## -description +Gets the XML node of a property element of the current print option. ## -parameters ### -param name +The canonical name of the property. ### -param xmlNamespace +The XML namespace of the property. ## -returns +The XML node for the property element. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_getpropertyvalue_963578494.md b/windows.graphics.printing.printticket/printticketoption_getpropertyvalue_963578494.md index 73d2abe6df..18639d5dac 100644 --- a/windows.graphics.printing.printticket/printticketoption_getpropertyvalue_963578494.md +++ b/windows.graphics.printing.printticket/printticketoption_getpropertyvalue_963578494.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyValue(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyValue(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyValue - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetPropertyValue + ## -description +Gets the value associated with a property element of the current print option. ## -parameters ### -param name +The canonical name of the property. ### -param xmlNamespace +The XML namespace of the property. ## -returns +The value associated with the property. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_getscoredpropertynode_2058601752.md b/windows.graphics.printing.printticket/printticketoption_getscoredpropertynode_2058601752.md index 7dc276e5dc..acf922508e 100644 --- a/windows.graphics.printing.printticket/printticketoption_getscoredpropertynode_2058601752.md +++ b/windows.graphics.printing.printticket/printticketoption_getscoredpropertynode_2058601752.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyNode(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyNode(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyNode + ## -description +Gets the XML node of a scored property element of the current print option. ## -parameters ### -param name +The canonical name of the scored property. ### -param xmlNamespace +The XML namespace of the scored property. ## -returns +The XML node for the property element. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_getscoredpropertyvalue_2070956858.md b/windows.graphics.printing.printticket/printticketoption_getscoredpropertyvalue_2070956858.md index 4ad80c53d0..37486fd2a0 100644 --- a/windows.graphics.printing.printticket/printticketoption_getscoredpropertyvalue_2070956858.md +++ b/windows.graphics.printing.printticket/printticketoption_getscoredpropertyvalue_2070956858.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyValue(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyValue(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyValue - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.GetScoredPropertyValue + ## -description +Gets the value associated with a scored property element of the current print option. ## -parameters ### -param name +The canonical name of the scored property. ### -param xmlNamespace +The XML namespace of the scored property. ## -returns +The value associated with the scored property. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_name.md b/windows.graphics.printing.printticket/printticketoption_name.md index cb234c9c17..1fc33c1f4c 100644 --- a/windows.graphics.printing.printticket/printticketoption_name.md +++ b/windows.graphics.printing.printticket/printticketoption_name.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.Name --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.Name +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.Name - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.Name + ## -description +Gets the canonical name of this print option. ## -property-value +The canonical name. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_xmlnamespace.md b/windows.graphics.printing.printticket/printticketoption_xmlnamespace.md index 5bfc044fa8..9b7606b669 100644 --- a/windows.graphics.printing.printticket/printticketoption_xmlnamespace.md +++ b/windows.graphics.printing.printticket/printticketoption_xmlnamespace.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNamespace --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNamespace +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNamespace - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNamespace + ## -description +Gets the XML namespace of this print option. ## -property-value +The XML namespace. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketoption_xmlnode.md b/windows.graphics.printing.printticket/printticketoption_xmlnode.md index e340417238..7ad4693cd2 100644 --- a/windows.graphics.printing.printticket/printticketoption_xmlnode.md +++ b/windows.graphics.printing.printticket/printticketoption_xmlnode.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNode --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNode +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketOption.XmlNode + ## -description +Gets the XML node of this print option. ## -property-value +The XML node. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdatatype.md b/windows.graphics.printing.printticket/printticketparameterdatatype.md index 84fc192691..6defd5ec11 100644 --- a/windows.graphics.printing.printticket/printticketparameterdatatype.md +++ b/windows.graphics.printing.printticket/printticketparameterdatatype.md @@ -1,22 +1,26 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDataType --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDataType +-api-type: winrt enum +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDataType - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDataType + ## -description +Contains values that describe the data type of a print ticket parameter. ## -enum-fields ### -field String:2 +String data type. ### -field NumericString:1 +Numeric string data type. ### -field Integer:0 +Integer data type. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition.md b/windows.graphics.printing.printticket/printticketparameterdefinition.md index 7206d89fac..01af673343 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition + ## -description +Represents the definition and value characteristics of a print parameter. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_datatype.md b/windows.graphics.printing.printticket/printticketparameterdefinition_datatype.md index 27173f3d4e..bbf36f4356 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_datatype.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_datatype.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.DataType --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.DataType +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.DataType - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.DataType + ## -description +Gets the data type of this print parameter. ## -property-value +The parameter data type. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_name.md b/windows.graphics.printing.printticket/printticketparameterdefinition_name.md index 8d1e58994d..96bdb5954b 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_name.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_name.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.Name --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.Name +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.Name - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.Name + ## -description +Gets the canonical name of this print parameter ## -property-value +The canonical name. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_rangemax.md b/windows.graphics.printing.printticket/printticketparameterdefinition_rangemax.md index fb3012acab..32797f0dfd 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_rangemax.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_rangemax.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMax --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMax +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMax - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMax + ## -description +Gets the maximum value that can be assigned to this print parameter (assuming an integer datatype) or the maximum length of string that can be assigned (assuming a string datatype). ## -property-value +An `int` indicating the maximum value. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_rangemin.md b/windows.graphics.printing.printticket/printticketparameterdefinition_rangemin.md index 9d7f5c5987..f1d5e1fedf 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_rangemin.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_rangemin.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMin --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMin +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMin - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.RangeMin + ## -description +Gets the minimum value that can be assigned to this print parameter (assuming an integer datatype) or the minimum length of string that can be assigned (assuming a string datatype). ## -property-value +An `int` indicating the minimum value. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_unittype.md b/windows.graphics.printing.printticket/printticketparameterdefinition_unittype.md index b411bedb1e..dfacf0c9a4 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_unittype.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_unittype.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.UnitType --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.UnitType +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.UnitType - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.UnitType + ## -description +Gets the unit type associated with the value of this print parameter. ## -property-value +A string indicating the unit type. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnamespace.md b/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnamespace.md index a4d4e8527f..93165dcf91 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnamespace.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnamespace.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNamespace --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNamespace +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNamespace - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNamespace + ## -description +Gets the XML namespace of the print parameter. ## -property-value +The XML namespace. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnode.md b/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnode.md index be5bf2ea59..b51e129822 100644 --- a/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnode.md +++ b/windows.graphics.printing.printticket/printticketparameterdefinition_xmlnode.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNode --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNode +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterDefinition.XmlNode + ## -description +Get the XML node of the print parameter. ## -property-value +The XML node. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterinitializer.md b/windows.graphics.printing.printticket/printticketparameterinitializer.md index a8f57daccc..f1a705435a 100644 --- a/windows.graphics.printing.printticket/printticketparameterinitializer.md +++ b/windows.graphics.printing.printticket/printticketparameterinitializer.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer + ## -description +Represents a the selected setting for a printing parameter. A printing parameter is a device capability that can be set to values within a range, unlike a feature which has an enumerable list of settings. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterinitializer_name.md b/windows.graphics.printing.printticket/printticketparameterinitializer_name.md index 98a028f990..fc27205a3e 100644 --- a/windows.graphics.printing.printticket/printticketparameterinitializer_name.md +++ b/windows.graphics.printing.printticket/printticketparameterinitializer_name.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Name --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Name +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Name - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Name + ## -description +Gets the canonical name of the print parameter. ## -property-value +The canonical name. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterinitializer_value.md b/windows.graphics.printing.printticket/printticketparameterinitializer_value.md index 33f0494770..362120d7ea 100644 --- a/windows.graphics.printing.printticket/printticketparameterinitializer_value.md +++ b/windows.graphics.printing.printticket/printticketparameterinitializer_value.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Value --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Value +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Value - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.Value + ## -description +Gets the value of the print parameter. ## -property-value +The value. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnamespace.md b/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnamespace.md index a4748630b2..cc83d35460 100644 --- a/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnamespace.md +++ b/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnamespace.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNamespace --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNamespace +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNamespace - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNamespace + ## -description +Gets the XML namespace of the print parameter. ## -property-value +The XML namespace. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnode.md b/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnode.md index ec66113379..8f4d59fb02 100644 --- a/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnode.md +++ b/windows.graphics.printing.printticket/printticketparameterinitializer_xmlnode.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNode --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNode +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNode - +# Windows.Graphics.Printing.PrintTicket.PrintTicketParameterInitializer.XmlNode + ## -description +Gets the XML node of the print parameter. ## -property-value +The XML node. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketvalue.md b/windows.graphics.printing.printticket/printticketvalue.md index dc07f44707..a52a91271a 100644 --- a/windows.graphics.printing.printticket/printticketvalue.md +++ b/windows.graphics.printing.printticket/printticketvalue.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketValue --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketValue +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketValue - +# Windows.Graphics.Printing.PrintTicket.PrintTicketValue + ## -description +Represents a value of a printing parameter or print option property. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketvalue_getvalueasinteger_96219999.md b/windows.graphics.printing.printticket/printticketvalue_getvalueasinteger_96219999.md index 592a5e8447..88e2f85077 100644 --- a/windows.graphics.printing.printticket/printticketvalue_getvalueasinteger_96219999.md +++ b/windows.graphics.printing.printticket/printticketvalue_getvalueasinteger_96219999.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsInteger --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsInteger +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsInteger - +# Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsInteger + ## -description +Converts the print value to an `int`. ## -returns +An `int` indicating the value. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketvalue_getvalueasstring_1616750132.md b/windows.graphics.printing.printticket/printticketvalue_getvalueasstring_1616750132.md index 73dc9c0b6e..587c503b47 100644 --- a/windows.graphics.printing.printticket/printticketvalue_getvalueasstring_1616750132.md +++ b/windows.graphics.printing.printticket/printticketvalue_getvalueasstring_1616750132.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsString --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsString +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsString - +# Windows.Graphics.Printing.PrintTicket.PrintTicketValue.GetValueAsString + ## -description +Converts the print value to a string. ## -returns +A string indicating the value. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketvalue_type.md b/windows.graphics.printing.printticket/printticketvalue_type.md index c150215acb..3f26d36b95 100644 --- a/windows.graphics.printing.printticket/printticketvalue_type.md +++ b/windows.graphics.printing.printticket/printticketvalue_type.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketValue.Type --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.PrintTicketValue.Type +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketValue.Type - +# Windows.Graphics.Printing.PrintTicket.PrintTicketValue.Type + ## -description +Gets the type of value that this class object represents. ## -property-value +The value type. ## -remarks diff --git a/windows.graphics.printing.printticket/printticketvaluetype.md b/windows.graphics.printing.printticket/printticketvaluetype.md index de2f8d2ef9..07e5373cac 100644 --- a/windows.graphics.printing.printticket/printticketvaluetype.md +++ b/windows.graphics.printing.printticket/printticketvaluetype.md @@ -1,22 +1,26 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketValueType --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.PrintTicketValueType +-api-type: winrt enum +--- + -# Windows.Graphics.Printing.PrintTicket.PrintTicketValueType - +# Windows.Graphics.Printing.PrintTicket.PrintTicketValueType + ## -description +Contains values that describe the types of print values. ## -enum-fields ### -field Unknown:2 +The value type is unknown. ### -field String:1 +String value. ### -field Integer:0 +Integer value. ## -remarks diff --git a/windows.graphics.printing.printticket/windows_graphics_printing_printticket.md b/windows.graphics.printing.printticket/windows_graphics_printing_printticket.md index 21296d42c2..a052efc4c1 100644 --- a/windows.graphics.printing.printticket/windows_graphics_printing_printticket.md +++ b/windows.graphics.printing.printticket/windows_graphics_printing_printticket.md @@ -1,19 +1,23 @@ ---- --api-id: N:Windows.Graphics.Printing.PrintTicket --api-type: winrt namespace ---- - +--- +-api-id: N:Windows.Graphics.Printing.PrintTicket +-api-type: winrt namespace +--- + -# Windows.Graphics.Printing.PrintTicket - +# Windows.Graphics.Printing.PrintTicket + ## -description +This namespace provides Windows Runtime classes that serve as wrappers over the [Print Schema COM interfaces](https://msdn.microsoft.com/library/windows/hardware/hh464019(v=vs.85).aspx). This allows for the easy configuration of print job instructions from within a UWP print workflow app. ## -remarks ## -see-also +[WorkflowPrintTicket](WorkflowPrintTicket.md) +[Print Schema interfaces](https://msdn.microsoft.com/library/windows/hardware/hh464019(v=vs.85).aspx) +[Print Schema Specification](https://msdn.microsoft.com/library/windows/hardware/gg463385.aspx) ## -examples diff --git a/windows.graphics.printing.printticket/workflowprintticket.md b/windows.graphics.printing.printticket/workflowprintticket.md index eefbee329a..b27c0833ed 100644 --- a/windows.graphics.printing.printticket/workflowprintticket.md +++ b/windows.graphics.printing.printticket/workflowprintticket.md @@ -1,19 +1,21 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket + ## -description +This class represents an XML *PrintTicket document* and allows it to be modified easily. The *PrintTicket document* contains instructions on how the printer should set its various features for a printing task. ## -remarks ## -see-also +[IPrintSchemaTicket interface](https://msdn.microsoft.com/library/windows/hardware/hh451398(v=vs.85).aspx) ## -examples diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentbindingfeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentbindingfeature.md index f0cc8bc7de..b306b86c4c 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentbindingfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentbindingfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentBindingFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentBindingFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentBindingFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentBindingFeature + ## -description +Gets the document binding configuration for this print ticket. ## -property-value +The document binding feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentcollatefeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentcollatefeature.md index dfef45e7f9..5dd14e0bb7 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentcollatefeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentcollatefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentCollateFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentCollateFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentCollateFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentCollateFeature + ## -description +Gets the document collation configuration for this print ticket. ## -property-value +The document collation feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentduplexfeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentduplexfeature.md index 267ba018cb..1cd51d998c 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentduplexfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentduplexfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentDuplexFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentDuplexFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentDuplexFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentDuplexFeature + ## -description +Gets the duplex printing configuration for this print ticket. ## -property-value +The duplex printing feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentholepunchfeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentholepunchfeature.md index ec6f23a50c..1abc8ed74f 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentholepunchfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentholepunchfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentHolePunchFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentHolePunchFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentHolePunchFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentHolePunchFeature + ## -description +Gets the document hole-punch configuration for this print ticket. ## -property-value +The document hole-punch feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentinputbinfeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentinputbinfeature.md index 248e10fce5..221896da94 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentinputbinfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentinputbinfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentInputBinFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentInputBinFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentInputBinFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentInputBinFeature + ## -description +Gets the printing input bin configuration for this print ticket. ## -property-value +The printing input bin feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentnupfeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentnupfeature.md index 023801c47c..87a012fcfb 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentnupfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentnupfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentNUpFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentNUpFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentNUpFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentNUpFeature + ## -description +Gets the N-up printing configuration for this print ticket. ## -property-value +The N-up printing feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_documentstaplefeature.md b/windows.graphics.printing.printticket/workflowprintticket_documentstaplefeature.md index edab127183..0c583114d6 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_documentstaplefeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_documentstaplefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentStapleFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentStapleFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentStapleFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.DocumentStapleFeature + ## -description +Gets the document staple configuration for this print ticket. ## -property-value +The document staple feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_getcapabilities_1192111781.md b/windows.graphics.printing.printticket/workflowprintticket_getcapabilities_1192111781.md index 6e45c7dd03..7ea3130db5 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_getcapabilities_1192111781.md +++ b/windows.graphics.printing.printticket/workflowprintticket_getcapabilities_1192111781.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetCapabilities --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetCapabilities +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetCapabilities - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetCapabilities + ## -description +Gets the print capabilities object for this print ticket. ## -returns +The print ticket capabilities. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_getfeature_762742941.md b/windows.graphics.printing.printticket/workflowprintticket_getfeature_762742941.md index 5a936b53bf..0e31851831 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_getfeature_762742941.md +++ b/windows.graphics.printing.printticket/workflowprintticket_getfeature_762742941.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetFeature(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetFeature(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetFeature + ## -description +Gets the specified print feature object. ## -parameters ### -param name +The canonical name of the print feature. ### -param xmlNamespace +The XML namespace of the print feature. ## -returns +The specified print feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_getparameterinitializer_2038042704.md b/windows.graphics.printing.printticket/workflowprintticket_getparameterinitializer_2038042704.md index e3ee8a30b3..9db4b75628 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_getparameterinitializer_2038042704.md +++ b/windows.graphics.printing.printticket/workflowprintticket_getparameterinitializer_2038042704.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetParameterInitializer(System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetParameterInitializer(System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetParameterInitializer - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.GetParameterInitializer + ## -description +Gets the parameter initializer object for a specified printing parameter. ## -parameters ### -param name +The canonical name of the printing parameter ### -param xmlNamespace +The XML namespace of the printing parameter. ## -returns +The parameter initializer object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_jobpasscodefeature.md b/windows.graphics.printing.printticket/workflowprintticket_jobpasscodefeature.md index 04bdd8b1d3..bd1570888f 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_jobpasscodefeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_jobpasscodefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.JobPasscodeFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.JobPasscodeFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.JobPasscodeFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.JobPasscodeFeature + ## -description +Gets the job passcode configuration for this print ticket. ## -property-value +The job passcode feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_mergeandvalidateticket_2064496717.md b/windows.graphics.printing.printticket/workflowprintticket_mergeandvalidateticket_2064496717.md index b2af4cc689..25557350c5 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_mergeandvalidateticket_2064496717.md +++ b/windows.graphics.printing.printticket/workflowprintticket_mergeandvalidateticket_2064496717.md @@ -1,20 +1,23 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.MergeAndValidateTicket(Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.MergeAndValidateTicket(Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.MergeAndValidateTicket - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.MergeAndValidateTicket + ## -description +Merges a newly configured print ticket onto the current print ticket and validates the merged ticket, guaranteeing that it does not ask for any printing functionality that the printer does not support. ## -parameters ### -param deltaShemaTicket +The print ticket object that has been configured. ## -returns +The validated print ticket object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_name.md b/windows.graphics.printing.printticket/workflowprintticket_name.md index 10a0767215..8b1d504434 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_name.md +++ b/windows.graphics.printing.printticket/workflowprintticket_name.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.Name --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.Name +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.Name - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.Name + ## -description +Gets the canonical name of this print ticket. ## -property-value +The canonical name. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_notifyxmlchangedasync_225953047.md b/windows.graphics.printing.printticket/workflowprintticket_notifyxmlchangedasync_225953047.md index 00bcdc1996..1d859a60cf 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_notifyxmlchangedasync_225953047.md +++ b/windows.graphics.printing.printticket/workflowprintticket_notifyxmlchangedasync_225953047.md @@ -1,19 +1,22 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.NotifyXmlChangedAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.NotifyXmlChangedAsync +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.NotifyXmlChangedAsync - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.NotifyXmlChangedAsync + ## -description +Notifies the print system that the XML DOM object has changed. ## -returns +This method does not return a value. ## -remarks +This method should be called when the client has made direct modifications to the XML _PrintTicket document_. ## -see-also diff --git a/windows.graphics.printing.printticket/workflowprintticket_pageborderlessfeature.md b/windows.graphics.printing.printticket/workflowprintticket_pageborderlessfeature.md index 695adeb959..5903f823d1 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pageborderlessfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pageborderlessfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageBorderlessFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageBorderlessFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageBorderlessFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageBorderlessFeature + ## -description +Gets the document borderless configuration for this print ticket. ## -property-value +The borderless feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_pagemediasizefeature.md b/windows.graphics.printing.printticket/workflowprintticket_pagemediasizefeature.md index 16f57cb33d..27a8271970 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pagemediasizefeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pagemediasizefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaSizeFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaSizeFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaSizeFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaSizeFeature + ## -description +Gets the page media size configuration for this print ticket. ## -property-value +The page media size feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_pagemediatypefeature.md b/windows.graphics.printing.printticket/workflowprintticket_pagemediatypefeature.md index b94a876469..665bf5a041 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pagemediatypefeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pagemediatypefeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaTypeFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaTypeFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaTypeFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageMediaTypeFeature + ## -description +Gets the page media type configuration for this print ticket. ## -property-value +The page media type feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_pageorientationfeature.md b/windows.graphics.printing.printticket/workflowprintticket_pageorientationfeature.md index dc4519d5c5..995934c7bf 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pageorientationfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pageorientationfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOrientationFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOrientationFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOrientationFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOrientationFeature + ## -description +Gets the page orientation configuration for this print ticket. ## -property-value +The page orientation feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_pageoutputcolorfeature.md b/windows.graphics.printing.printticket/workflowprintticket_pageoutputcolorfeature.md index 569269d7be..2ac5dd9868 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pageoutputcolorfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pageoutputcolorfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputColorFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputColorFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputColorFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputColorFeature + ## -description +Gets the page color configuration for this print ticket. ## -property-value +The page color feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_pageoutputqualityfeature.md b/windows.graphics.printing.printticket/workflowprintticket_pageoutputqualityfeature.md index 3f38c273ed..8217158517 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pageoutputqualityfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pageoutputqualityfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputQualityFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputQualityFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputQualityFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageOutputQualityFeature + ## -description +Gets the page quality configuration for this print ticket. ## -property-value +The page quality feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_pageresolutionfeature.md b/windows.graphics.printing.printticket/workflowprintticket_pageresolutionfeature.md index bb932514bc..48ff9ce610 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_pageresolutionfeature.md +++ b/windows.graphics.printing.printticket/workflowprintticket_pageresolutionfeature.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageResolutionFeature --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageResolutionFeature +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageResolutionFeature - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.PageResolutionFeature + ## -description +Gets the page resolution configuration for this print ticket. ## -property-value +The page resolution feature object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasinteger_1469578484.md b/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasinteger_1469578484.md index 8b25d7fa9b..863bf36808 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasinteger_1469578484.md +++ b/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasinteger_1469578484.md @@ -1,22 +1,26 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsInteger(System.String,System.String,System.Int32) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsInteger(System.String,System.String,System.Int32) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsInteger - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsInteger + ## -description +Sets the parameter initializer object for a specified printing parameter. This can only be done if an initializer for the specified parameter doesn't yet exist. ## -parameters ### -param name +The canonical name of the printing parameter ### -param xmlNamespace +The XML namespace of the printing parameter. -### -param integerValue +## -returns +The parameter initializer object. ## -returns diff --git a/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasstring_2052601140.md b/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasstring_2052601140.md index 120a2d9ccf..1d0aa27f3c 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasstring_2052601140.md +++ b/windows.graphics.printing.printticket/workflowprintticket_setparameterinitializerasstring_2052601140.md @@ -1,24 +1,29 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsString(System.String,System.String,System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsString(System.String,System.String,System.String) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsString - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.SetParameterInitializerAsString + ## -description +Sets the given print parameter to the given string value. ## -parameters ### -param name +The canonical name of the printing parameter. ### -param xmlNamespace +The XML namespace of the printing parameter. ### -param stringValue +The value to set this parameter to. ## -returns +The parameter initializer object for the newly set parameter. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_validateasync_358314400.md b/windows.graphics.printing.printticket/workflowprintticket_validateasync_358314400.md index bafc89c2db..31038b0544 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_validateasync_358314400.md +++ b/windows.graphics.printing.printticket/workflowprintticket_validateasync_358314400.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.ValidateAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.ValidateAsync +-api-type: winrt method +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.ValidateAsync - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.ValidateAsync + ## -description +Checks that the given print ticket does not ask for any printing functionality that the printer does not support. ## -returns +An asynchronous operation with a validation result object. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_xmlnamespace.md b/windows.graphics.printing.printticket/workflowprintticket_xmlnamespace.md index fcb88740b0..bb9cc3c412 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_xmlnamespace.md +++ b/windows.graphics.printing.printticket/workflowprintticket_xmlnamespace.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNamespace --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNamespace +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNamespace - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNamespace + ## -description +Gets the XML namespace for the print ticket. ## -property-value +The XML namespace. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticket_xmlnode.md b/windows.graphics.printing.printticket/workflowprintticket_xmlnode.md index 50f53a401b..7082dccfde 100644 --- a/windows.graphics.printing.printticket/workflowprintticket_xmlnode.md +++ b/windows.graphics.printing.printticket/workflowprintticket_xmlnode.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNode --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNode +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNode - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket.XmlNode + ## -description +Gets the XML node for the print ticket. ## -property-value +The XML node. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticketvalidationresult.md b/windows.graphics.printing.printticket/workflowprintticketvalidationresult.md index d0ed8555b5..4d62f37e20 100644 --- a/windows.graphics.printing.printticket/workflowprintticketvalidationresult.md +++ b/windows.graphics.printing.printticket/workflowprintticketvalidationresult.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult +-api-type: winrt class +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult + ## -description +Represents the result of a print ticket validation. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticketvalidationresult_extendederror.md b/windows.graphics.printing.printticket/workflowprintticketvalidationresult_extendederror.md index 3fd0acbbf3..14db27a2db 100644 --- a/windows.graphics.printing.printticket/workflowprintticketvalidationresult_extendederror.md +++ b/windows.graphics.printing.printticket/workflowprintticketvalidationresult_extendederror.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.ExtendedError --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.ExtendedError +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.ExtendedError - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.ExtendedError + ## -description +Gets the error report (if an error occurred) relating to the ticket validation. ## -property-value +An HResult for the reported error. ## -remarks diff --git a/windows.graphics.printing.printticket/workflowprintticketvalidationresult_validated.md b/windows.graphics.printing.printticket/workflowprintticketvalidationresult_validated.md index 82a3e8d628..36dc9d607a 100644 --- a/windows.graphics.printing.printticket/workflowprintticketvalidationresult_validated.md +++ b/windows.graphics.printing.printticket/workflowprintticketvalidationresult_validated.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.Validated --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.Validated +-api-type: winrt property +--- + -# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.Validated - +# Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicketValidationResult.Validated + ## -description +Indicates whether the print ticket was found to be valid. ## -property-value +**true** if the ticket was valid, **false** if it was invalid. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsession.md b/windows.graphics.printing.workflow/printworkflowbackgroundsession.md index 03d3b62e24..4b2c1a3bc1 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsession.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsession.md @@ -1,17 +1,19 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession + ## -description +Represents a single print workflow session that runs in the background. ## -remarks +An instance of this class is acquired from the [PrintWorkflowTriggerDetails](PrintWorkflowTriggerDetails.md) instance that gets passed in with the background task instance. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsession_setuprequested.md b/windows.graphics.printing.workflow/printworkflowbackgroundsession_setuprequested.md index 6b4aba52fd..4923df836a 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsession_setuprequested.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsession_setuprequested.md @@ -1,15 +1,16 @@ ---- --api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.SetupRequested --api-type: winrt event ---- - +--- +-api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.SetupRequested +-api-type: winrt event +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.SetupRequested - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.SetupRequested + ## -description +Raised first in the print workflow background session. This event exposes information about the print job but not the print content itself. Register for this event to do work on a print job configuration before printing. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsession_start_1587696324.md b/windows.graphics.printing.workflow/printworkflowbackgroundsession_start_1587696324.md index 6c4e181647..4765642db2 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsession_start_1587696324.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsession_start_1587696324.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Start --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Start +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Start - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Start + ## -description +Starts the print workflow background process. The events of this class are raised in sequential order. ## -remarks +This method should be called once the events of this class have been registered for with the appropriate handlers. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsession_status.md b/windows.graphics.printing.workflow/printworkflowbackgroundsession_status.md index e1ad3718c2..e08ac111c3 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsession_status.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsession_status.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Status --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Status +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Status - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Status + ## -description +The status of the current print workflow session. ## -property-value +The session status. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsession_submitted.md b/windows.graphics.printing.workflow/printworkflowbackgroundsession_submitted.md index ef00882a87..48ca66a6fc 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsession_submitted.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsession_submitted.md @@ -1,15 +1,16 @@ ---- --api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Submitted --api-type: winrt event ---- - +--- +-api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Submitted +-api-type: winrt event +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Submitted - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSession.Submitted + ## -description +Raised when the final XPS print data has become available. This is done after the [SetupRequested](Printworkflowbackgroundsession_setuprequested.md) event and after the optional UI-dependent foreground task is completed. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs.md b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs.md index 48033ecec6..7c43f7ec52 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs + ## -description +Contains information about a [PrintWorkflowBackgroundSession.SetupRequested](PrintWorkflowbackgroundsession_setuprequested.md) event that was raised. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_configuration.md b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_configuration.md index 50d566d416..b8f3826df4 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_configuration.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_configuration.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.Configuration --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.Configuration +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.Configuration - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.Configuration + ## -description +Gets information about the source application, print job title, and session ID for this print workflow session. ## -property-value +The configuration data for this print job. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getdeferral_254836512.md b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getdeferral_254836512.md index cc499d6e2c..9c6c4ff0fb 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getdeferral_254836512.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getdeferral_254836512.md @@ -1,19 +1,22 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetDeferral --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetDeferral - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetDeferral + ## -description +Gets a deferral object for managing the work done on the corresponding [PrintWorkflowBackgroundSession.SetupRequested](PrintWorkflowbackgroundsession_setuprequested.md) event. ## -returns +A deferral object. ## -remarks +A deferral should be used if any asynchronous work is being done in this event handler, so that the next event in the sequence isn't raised until this work is completed. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getuserprintticketasync_786857081.md b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getuserprintticketasync_786857081.md index c11e20ecb8..2f8bc336ed 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getuserprintticketasync_786857081.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_getuserprintticketasync_786857081.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetUserPrintTicketAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetUserPrintTicketAsync +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetUserPrintTicketAsync - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.GetUserPrintTicketAsync + ## -description +Gets the print ticket for the current print task. ## -returns +An asynchronous operation with a print ticket. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_setrequiresui_998933127.md b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_setrequiresui_998933127.md index 3a416ea985..ede03e21ab 100644 --- a/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_setrequiresui_998933127.md +++ b/windows.graphics.printing.workflow/printworkflowbackgroundsetuprequestedeventargs_setrequiresui_998933127.md @@ -1,15 +1,16 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.SetRequiresUI --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.SetRequiresUI +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.SetRequiresUI - +# Windows.Graphics.Printing.Workflow.PrintWorkflowBackgroundSetupRequestedEventArgs.SetRequiresUI + ## -description +Registers this print workflow session as requiring a UI. This will cause the corresponding foreground task to be activated before the [PrintWorkflowBackgroundSession.Submitted](PrintWorkflowbackgroundsession_submitted.md) event is raised by the background task. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowconfiguration.md b/windows.graphics.printing.workflow/printworkflowconfiguration.md index cbfc7826fc..0f6d3846b7 100644 --- a/windows.graphics.printing.workflow/printworkflowconfiguration.md +++ b/windows.graphics.printing.workflow/printworkflowconfiguration.md @@ -1,17 +1,19 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration - +# Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration + ## -description +Contains information about the source application, print job title, and session ID for a print workflow session. ## -remarks +This class presents the same session-specific information to both the background and foreground components of a print workflow app. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowconfiguration_jobtitle.md b/windows.graphics.printing.workflow/printworkflowconfiguration_jobtitle.md index 1706c8ed2f..7fb7b42fa6 100644 --- a/windows.graphics.printing.workflow/printworkflowconfiguration_jobtitle.md +++ b/windows.graphics.printing.workflow/printworkflowconfiguration_jobtitle.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.JobTitle --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.JobTitle +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.JobTitle - +# Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.JobTitle + ## -description +Gets the job title for this print job. ## -property-value +The job title string. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowconfiguration_sessionid.md b/windows.graphics.printing.workflow/printworkflowconfiguration_sessionid.md new file mode 100644 index 0000000000..bf69e3b80d --- /dev/null +++ b/windows.graphics.printing.workflow/printworkflowconfiguration_sessionid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.SessionId +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.SessionId + +## -description +Gets the session ID for this print job. + +## -property-value +The unique session ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.printing.workflow/printworkflowconfiguration_sourceappdisplayname.md b/windows.graphics.printing.workflow/printworkflowconfiguration_sourceappdisplayname.md new file mode 100644 index 0000000000..1dea90c9a7 --- /dev/null +++ b/windows.graphics.printing.workflow/printworkflowconfiguration_sourceappdisplayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.SourceAppDisplayName +-api-type: winrt property +--- + + + +# Windows.Graphics.Printing.Workflow.PrintWorkflowConfiguration.SourceAppDisplayName + +## -description +Gets the display name of the external application that initiated the print job. + +## -property-value +The display name of the source application. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsession.md b/windows.graphics.printing.workflow/printworkflowforegroundsession.md index 9439ed4ad2..5c23e4b003 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsession.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsession.md @@ -1,17 +1,19 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession + ## -description +Represents a single print workflow session that runs in the foreground. ## -remarks +An instance of this class is acquired from the [PrintWorkflowUIActivatedEventArgs](PrintWorkflowUIActivatedEventArgs.md) instance that gets passed in with foreground task activation. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsession_setuprequested.md b/windows.graphics.printing.workflow/printworkflowforegroundsession_setuprequested.md index 6298d82052..e6c16e042e 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsession_setuprequested.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsession_setuprequested.md @@ -1,15 +1,16 @@ ---- --api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.SetupRequested --api-type: winrt event ---- - +--- +-api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.SetupRequested +-api-type: winrt event +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.SetupRequested - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.SetupRequested + ## -description +Raised first in the print workflow foreground session. This event exposes information about the print job but not the print content itself. Register for this event to do UI-dependent work on the print job before printing. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsession_start_1587696324.md b/windows.graphics.printing.workflow/printworkflowforegroundsession_start_1587696324.md index 8d66ce8b79..b22265a7dc 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsession_start_1587696324.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsession_start_1587696324.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Start --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Start +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Start - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Start + ## -description +Starts the print workflow foreground process. The events of this class are raised in sequential order. ## -remarks +This method should be called once the events of this class have been registered for by the appropriate handlers. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsession_status.md b/windows.graphics.printing.workflow/printworkflowforegroundsession_status.md index dc2c05d7a2..4ea5a8b6c4 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsession_status.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsession_status.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Status --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Status +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Status - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.Status + ## -description +The status of the current print workflow session. ## -property-value +The session status. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsession_xpsdataavailable.md b/windows.graphics.printing.workflow/printworkflowforegroundsession_xpsdataavailable.md index a4c8a9974c..326bfd3cab 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsession_xpsdataavailable.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsession_xpsdataavailable.md @@ -1,15 +1,16 @@ ---- --api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.XpsDataAvailable --api-type: winrt event ---- - +--- +-api-id: E:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.XpsDataAvailable +-api-type: winrt event +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.XpsDataAvailable - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSession.XpsDataAvailable + ## -description +Raised when the XPS print data is available to be read. This is done after the [SetupRequested](Printworkflowforegroundsession_setuprequested.md) event is raised. Register for this event to do UI-dependent work that requires displaying the print content. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs.md b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs.md index 37b460c864..73038c672c 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs + ## -description +Contains information about a [PrintWorkflowForegroundSession.SetupRequested](PrintWorkflowforegroundsession_setuprequested.md) event that was raised. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_configuration.md b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_configuration.md index fbf5e0db3b..21a4ad87b2 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_configuration.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_configuration.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.Configuration --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.Configuration +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.Configuration - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.Configuration + ## -description +Gets information about the source application, print job title, and session ID for this print workflow session. ## -property-value +The configuration data for this print job. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getdeferral_254836512.md b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getdeferral_254836512.md index 7a8925cd6f..9ecf0cfc1d 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getdeferral_254836512.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getdeferral_254836512.md @@ -1,19 +1,22 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetDeferral --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetDeferral - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetDeferral + ## -description +Gets a deferral object for managing the work done on the corresponding [PrintWorkflowForegroundSession.SetupRequested](PrintWorkflowforegroundsession_setuprequested.md) event. ## -returns +A deferral object. ## -remarks +A deferral should be used if any asynchronous work is being done in this event handler, so that the next event in the sequence isn't raised until this work is completed. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getuserprintticketasync_786857081.md b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getuserprintticketasync_786857081.md index 39be71142b..60be4a77f2 100644 --- a/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getuserprintticketasync_786857081.md +++ b/windows.graphics.printing.workflow/printworkflowforegroundsetuprequestedeventargs_getuserprintticketasync_786857081.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetUserPrintTicketAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetUserPrintTicketAsync +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetUserPrintTicketAsync - +# Windows.Graphics.Printing.Workflow.PrintWorkflowForegroundSetupRequestedEventArgs.GetUserPrintTicketAsync + ## -description +Gets the print ticket for the current print task. ## -returns +An asynchronous operation with a print ticket. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowobjectmodelsourcefilecontent.md b/windows.graphics.printing.workflow/printworkflowobjectmodelsourcefilecontent.md index e282edd1e3..606e042aee 100644 --- a/windows.graphics.printing.workflow/printworkflowobjectmodelsourcefilecontent.md +++ b/windows.graphics.printing.workflow/printworkflowobjectmodelsourcefilecontent.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelSourceFileContent --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelSourceFileContent +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelSourceFileContent - +# Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelSourceFileContent + ## -description +Represents print content in the form of the COM-based XPS object model. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowobjectmodeltargetpackage.md b/windows.graphics.printing.workflow/printworkflowobjectmodeltargetpackage.md index 6a5981be38..70f23ee926 100644 --- a/windows.graphics.printing.workflow/printworkflowobjectmodeltargetpackage.md +++ b/windows.graphics.printing.workflow/printworkflowobjectmodeltargetpackage.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelTargetPackage --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelTargetPackage +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelTargetPackage - +# Windows.Graphics.Printing.Workflow.PrintWorkflowObjectModelTargetPackage + ## -description +Represents the print output data in the form of the COM-based XPS object model. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsessionstatus.md b/windows.graphics.printing.workflow/printworkflowsessionstatus.md index 48d037ea22..702ddc2bec 100644 --- a/windows.graphics.printing.workflow/printworkflowsessionstatus.md +++ b/windows.graphics.printing.workflow/printworkflowsessionstatus.md @@ -1,24 +1,29 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSessionStatus --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSessionStatus +-api-type: winrt enum +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSessionStatus - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSessionStatus + ## -description +Contains values that describe the status of the current print workflow session. ## -enum-fields ### -field Started:0 +The current session has started. ### -field Completed:1 +The current session has completed. ### -field Closed:3 +The current session has been closed. ### -field Aborted:2 +Teh current session has been aborted. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsourcecontent.md b/windows.graphics.printing.workflow/printworkflowsourcecontent.md index 851c40b513..fa0a79845d 100644 --- a/windows.graphics.printing.workflow/printworkflowsourcecontent.md +++ b/windows.graphics.printing.workflow/printworkflowsourcecontent.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent + ## -description +Represents raw print data from the source application. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsourcecontent_getjobprintticketasync_743359123.md b/windows.graphics.printing.workflow/printworkflowsourcecontent_getjobprintticketasync_743359123.md index 25510bb803..cee97a0625 100644 --- a/windows.graphics.printing.workflow/printworkflowsourcecontent_getjobprintticketasync_743359123.md +++ b/windows.graphics.printing.workflow/printworkflowsourcecontent_getjobprintticketasync_743359123.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetJobPrintTicketAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetJobPrintTicketAsync +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetJobPrintTicketAsync - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetJobPrintTicketAsync + ## -description +Gets the print ticket for the printing task associated with this print data. ## -returns +A print ticket object with the current print task configuration. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasstreamcontent_755036489.md b/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasstreamcontent_755036489.md index 79664d83de..4f09ef9874 100644 --- a/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasstreamcontent_755036489.md +++ b/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasstreamcontent_755036489.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsStreamContent --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsStreamContent +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsStreamContent - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsStreamContent + ## -description +Gets the print data as an XPS data stream. ## -returns +An data stream of XPS data. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasxpsobjectmodel_2011119112.md b/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasxpsobjectmodel_2011119112.md index a2f29925a3..713f08e40c 100644 --- a/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasxpsobjectmodel_2011119112.md +++ b/windows.graphics.printing.workflow/printworkflowsourcecontent_getsourcespooldataasxpsobjectmodel_2011119112.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsXpsObjectModel --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsXpsObjectModel +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsXpsObjectModel - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSourceContent.GetSourceSpoolDataAsXpsObjectModel + ## -description +Gets the print data in the form of the COM-friendly XPS object model. ## -returns +The XPS object model content. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowspoolstreamcontent.md b/windows.graphics.printing.workflow/printworkflowspoolstreamcontent.md index 2e3224634b..87f2bd7158 100644 --- a/windows.graphics.printing.workflow/printworkflowspoolstreamcontent.md +++ b/windows.graphics.printing.workflow/printworkflowspoolstreamcontent.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent + ## -description +Represents print data in the form of an XPS data stream. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowspoolstreamcontent_getinputstream_467401164.md b/windows.graphics.printing.workflow/printworkflowspoolstreamcontent_getinputstream_467401164.md index cecb0aa8be..aa405c5aa7 100644 --- a/windows.graphics.printing.workflow/printworkflowspoolstreamcontent_getinputstream_467401164.md +++ b/windows.graphics.printing.workflow/printworkflowspoolstreamcontent_getinputstream_467401164.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent.GetInputStream --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent.GetInputStream +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent.GetInputStream - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSpoolStreamContent.GetInputStream + ## -description +Returns this print data as an input stream. ## -returns +An input stream of the print data. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowstreamtarget.md b/windows.graphics.printing.workflow/printworkflowstreamtarget.md index 7895401bd1..c5fc8c35af 100644 --- a/windows.graphics.printing.workflow/printworkflowstreamtarget.md +++ b/windows.graphics.printing.workflow/printworkflowstreamtarget.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget - +# Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget + ## -description +Represents an output data stream to be sent to the printer. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowstreamtarget_getoutputstream_977353332.md b/windows.graphics.printing.workflow/printworkflowstreamtarget_getoutputstream_977353332.md index 3f715cbfb7..5006d0855c 100644 --- a/windows.graphics.printing.workflow/printworkflowstreamtarget_getoutputstream_977353332.md +++ b/windows.graphics.printing.workflow/printworkflowstreamtarget_getoutputstream_977353332.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget.GetOutputStream --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget.GetOutputStream +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget.GetOutputStream - +# Windows.Graphics.Printing.Workflow.PrintWorkflowStreamTarget.GetOutputStream + ## -description +Returns the print data as an output stream. ## -returns +An output stream of the print data. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs.md b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs.md index a7b7f612c1..207ee40870 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs + ## -description +Contains information about a [PrintWorkflowBackgroundSession.Submitted](PrintWorkflowbackgroundsession_submitted.md) event that was raised. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_getdeferral_254836512.md b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_getdeferral_254836512.md index 2ec3003213..9aeac30b2c 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_getdeferral_254836512.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_getdeferral_254836512.md @@ -1,19 +1,22 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetDeferral --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetDeferral +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetDeferral - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetDeferral + ## -description +Gets a deferral object for managing the work done on the corresponding [PrintWorkflowBackgroundSession.Submitted](PrintWorkflowbackgroundsession_submitted.md) event. ## -returns +A deferral object. ## -remarks +A deferral should be used if any asynchronous work is being done in this event handler, so that the next event in the sequence isn't raised until this work is completed. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_gettarget_1567864598.md b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_gettarget_1567864598.md index 88f559f029..979c2f3f17 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_gettarget_1567864598.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_gettarget_1567864598.md @@ -1,20 +1,23 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetTarget(Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetTarget(Windows.Graphics.Printing.PrintTicket.WorkflowPrintTicket) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetTarget - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.GetTarget + ## -description +Gets a reference to the target document for outputting the edited print job. ## -parameters ### -param jobPrintTicket +The print ticket specifying printer configuration options. If no printer options were specified for this print job, use **null**. ## -returns +The target document for output. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_operation.md b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_operation.md index f96404e249..1c39408f79 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_operation.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedeventargs_operation.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.Operation --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.Operation +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.Operation - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedEventArgs.Operation + ## -description +Gets information about the current print task. ## -property-value +Information about the print task. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedoperation.md b/windows.graphics.printing.workflow/printworkflowsubmittedoperation.md index 710896c8bf..ba890526b5 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedoperation.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedoperation.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation + ## -description +Contains information about a print task that has potentially been modified by a print workflow session. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedoperation_complete_1811078150.md b/windows.graphics.printing.workflow/printworkflowsubmittedoperation_complete_1811078150.md index 995fee52c3..012a39e164 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedoperation_complete_1811078150.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedoperation_complete_1811078150.md @@ -1,18 +1,20 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Complete(Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedStatus) --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Complete(Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedStatus) +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Complete - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Complete + ## -description +Indicates the completion of the print workflow session. This method should be called in the handler for the [PrintWorkflowBackgroundSession.Submitted](PrintWorkflowBackgroundSession_Submitted.md) event when all work relating to the print task has been completed or when an error occurred that requires the process to be aborted. ## -parameters ### -param status +Indicates the status of the completed print workflow procedure. This will determine whether the printing pipeline should continue or abort. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedoperation_configuration.md b/windows.graphics.printing.workflow/printworkflowsubmittedoperation_configuration.md index 9387bc029f..9fdc745fc9 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedoperation_configuration.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedoperation_configuration.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Configuration --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Configuration +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Configuration - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.Configuration + ## -description +Gets information about the source application, print job title, and session ID for this print workflow session. ## -property-value +The configuration data for this print job. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedoperation_xpscontent.md b/windows.graphics.printing.workflow/printworkflowsubmittedoperation_xpscontent.md index cc92e4ae30..ed4afd22e2 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedoperation_xpscontent.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedoperation_xpscontent.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.XpsContent --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.XpsContent +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.XpsContent - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedOperation.XpsContent + ## -description +Gets the source application's original XPS data. This can be edited and then assigned to the print target in order to change the print content. ## -property-value +The XPS print data. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowsubmittedstatus.md b/windows.graphics.printing.workflow/printworkflowsubmittedstatus.md index eaf62245ce..e9fab7a275 100644 --- a/windows.graphics.printing.workflow/printworkflowsubmittedstatus.md +++ b/windows.graphics.printing.workflow/printworkflowsubmittedstatus.md @@ -1,22 +1,26 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedStatus --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedStatus +-api-type: winrt enum +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedStatus - +# Windows.Graphics.Printing.Workflow.PrintWorkflowSubmittedStatus + ## -description +Contains values that describe the status of a print workflow session. ## -enum-fields ### -field Succeeded:0 +The session was successful: continue to printing ### -field Failed:2 +The session failed: abort the printing process. ### -field Canceled:1 +The session was cancelled: abort the printing process. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowtarget.md b/windows.graphics.printing.workflow/printworkflowtarget.md index 901b16a8e5..69a5da2ddf 100644 --- a/windows.graphics.printing.workflow/printworkflowtarget.md +++ b/windows.graphics.printing.workflow/printworkflowtarget.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowTarget --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowTarget +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowTarget - +# Windows.Graphics.Printing.Workflow.PrintWorkflowTarget + ## -description +Represents the output document to be sent to the printer driver. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowtarget_targetasstream.md b/windows.graphics.printing.workflow/printworkflowtarget_targetasstream.md index da537c1bdd..35cfd95eb2 100644 --- a/windows.graphics.printing.workflow/printworkflowtarget_targetasstream.md +++ b/windows.graphics.printing.workflow/printworkflowtarget_targetasstream.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsStream --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsStream +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsStream - +# Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsStream + ## -description +Gets the output document in the form of a data stream. ## -property-value +The target document data stream. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowtarget_targetasxpsobjectmodelpackage.md b/windows.graphics.printing.workflow/printworkflowtarget_targetasxpsobjectmodelpackage.md index b89ad0f99a..5bd0f3079e 100644 --- a/windows.graphics.printing.workflow/printworkflowtarget_targetasxpsobjectmodelpackage.md +++ b/windows.graphics.printing.workflow/printworkflowtarget_targetasxpsobjectmodelpackage.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsXpsObjectModelPackage --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsXpsObjectModelPackage +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsXpsObjectModelPackage - +# Windows.Graphics.Printing.Workflow.PrintWorkflowTarget.TargetAsXpsObjectModelPackage + ## -description +Gets the output document in the form of the COM-based XPS object model. -## -property-value +## -returns +The output document object model content. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowtriggerdetails.md b/windows.graphics.printing.workflow/printworkflowtriggerdetails.md index 06637c73a2..d0eaa95617 100644 --- a/windows.graphics.printing.workflow/printworkflowtriggerdetails.md +++ b/windows.graphics.printing.workflow/printworkflowtriggerdetails.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails - +# Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails + ## -description +Represents contextual information about the triggering of a print workflow background task. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowtriggerdetails_printworkflowsession.md b/windows.graphics.printing.workflow/printworkflowtriggerdetails_printworkflowsession.md index 5a260998b0..a71d9de71c 100644 --- a/windows.graphics.printing.workflow/printworkflowtriggerdetails_printworkflowsession.md +++ b/windows.graphics.printing.workflow/printworkflowtriggerdetails_printworkflowsession.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails.PrintWorkflowSession --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails.PrintWorkflowSession +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails.PrintWorkflowSession - +# Windows.Graphics.Printing.Workflow.PrintWorkflowTriggerDetails.PrintWorkflowSession + ## -description +Gets the print workflow session object that should manage the behavior of the background task that was triggered. ## -property-value +The single print workflow background session. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs.md b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs.md index b8da8b9b62..90b8c7e792 100644 --- a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs.md +++ b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs - +# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs + ## -description +Contains contextual information about a print workflow foreground task that has been activated. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_kind.md b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_kind.md index f42b26e8ab..88f1708c27 100644 --- a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_kind.md +++ b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_kind.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.Kind --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.Kind +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.Kind - +# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.Kind + ## -description +Gets the reason that this app was activated. ## -property-value +A value indicating the type of task this app was activated to execute. In this case, it should be [ActivationKind.PrintWorkflowForegroundTask](https://docs.microsoft.com/uwp/api/windows.applicationmodel.activation.activationkind). ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_previousexecutionstate.md b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_previousexecutionstate.md index cd37ab5d5a..eadca46ddf 100644 --- a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_previousexecutionstate.md +++ b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_previousexecutionstate.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PreviousExecutionState --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PreviousExecutionState - +# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PreviousExecutionState + ## -description +Gets the execution state of the app before it was activated. ## -property-value +The execution state. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_printworkflowsession.md b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_printworkflowsession.md index cc4d045885..ae0a35a01b 100644 --- a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_printworkflowsession.md +++ b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_printworkflowsession.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PrintWorkflowSession --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PrintWorkflowSession +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PrintWorkflowSession - +# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.PrintWorkflowSession + ## -description +Gets the print workflow session object that should manage the behavior of the foreground task that was activated. ## -property-value +The single print workflow foreground session. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_splashscreen.md b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_splashscreen.md index 8b10810ee2..841b6077f5 100644 --- a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_splashscreen.md +++ b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_splashscreen.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.SplashScreen --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.SplashScreen - +# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.SplashScreen + ## -description +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. ## -property-value +The splash screen object. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_user.md b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_user.md index 62a0b21690..86e64df284 100644 --- a/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_user.md +++ b/windows.graphics.printing.workflow/printworkflowuiactivatedeventargs_user.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.User --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.User +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.User - +# Windows.Graphics.Printing.Workflow.PrintWorkflowUIActivatedEventArgs.User + ## -description +Gets the user that the foreground app was activated for. ## -property-value +The user that the app was activated for. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs.md b/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs.md index 33b9763b03..6b6611c4af 100644 --- a/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs.md +++ b/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs --api-type: winrt class ---- - +--- +-api-id: T:Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs +-api-type: winrt class +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs - +# Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs + ## -description +Contains information about a [PrintWorkflowForegroundSession.XpsDataAvailable](PrintWorkflowForegroundSession_XpsDataAvailable.md) event that was raised. ## -remarks diff --git a/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_getdeferral_254836512.md b/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_getdeferral_254836512.md index 5e7b5fb32c..f0a2f9cf57 100644 --- a/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_getdeferral_254836512.md +++ b/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_getdeferral_254836512.md @@ -1,19 +1,22 @@ ---- --api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.GetDeferral --api-type: winrt method ---- - +--- +-api-id: M:Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.GetDeferral +-api-type: winrt method +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.GetDeferral - +# Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.GetDeferral + ## -description +Gets a deferral object for managing the work done on the corresponding [PrintWorkflowForegroundSession.XpsDataAvailable](PrintWorkflowForegroundSession_XpsDataAvailable.md) event. ## -returns +A deferral object. ## -remarks +A deferral should be used if any asynchronous work is being done in this event handler, so that the next event in the sequence isn't raised until this work is completed. ## -see-also diff --git a/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_operation.md b/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_operation.md index f7e061d07d..9d989b1b2d 100644 --- a/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_operation.md +++ b/windows.graphics.printing.workflow/printworkflowxpsdataavailableeventargs_operation.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.Operation --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.Operation +-api-type: winrt property +--- + -# Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.Operation - +# Windows.Graphics.Printing.Workflow.PrintWorkflowXpsDataAvailableEventArgs.Operation + ## -description +Gets information about the current print task. ## -property-value +Information about the print task. ## -remarks diff --git a/windows.graphics.printing.workflow/windows_graphics_printing_workflow.md b/windows.graphics.printing.workflow/windows_graphics_printing_workflow.md index 7d4e0385d5..31af8a6fb8 100644 --- a/windows.graphics.printing.workflow/windows_graphics_printing_workflow.md +++ b/windows.graphics.printing.workflow/windows_graphics_printing_workflow.md @@ -1,19 +1,21 @@ ---- --api-id: N:Windows.Graphics.Printing.Workflow --api-type: winrt namespace ---- - +--- +-api-id: N:Windows.Graphics.Printing.Workflow +-api-type: winrt namespace +--- + -# Windows.Graphics.Printing.Workflow - +# Windows.Graphics.Printing.Workflow + ## -description +This namespace provides the functionality for writing a print workflow app. Print workflow apps are registered to print-capable source applications. They are launched in the background after the source application has elected to print something but before the print data is sent to the printer. Workflow apps are able to alter both the print ticket (printer device settings) and the actual content to be printed, and they can optionally expose this functionality to the user by launching a foreground app midway through the process. This allows for a greater degree of customization of the printing experience. ## -remarks ## -see-also +[Windows.Graphics.Printing.PrintTicket namespace](https://docs.microsoft.com/uwp/api/windows.graphics.printing.printticket) ## -examples diff --git a/windows.graphics.printing3d/print3dtaskcompletion.md b/windows.graphics.printing3d/print3dtaskcompletion.md index 700d11549d..12794e9606 100644 --- a/windows.graphics.printing3d/print3dtaskcompletion.md +++ b/windows.graphics.printing3d/print3dtaskcompletion.md @@ -18,7 +18,7 @@ Specifies the completion status of a 3D print request. The request has been abandoned. ### -field Canceled:1 -The request has been canceled. +The request has been cancelled. ### -field Failed:2 The request has failed. diff --git a/windows.graphics.printing3d/printing3d3mfpackage_compression.md b/windows.graphics.printing3d/printing3d3mfpackage_compression.md index c80c60c4da..51e348bd43 100644 --- a/windows.graphics.printing3d/printing3d3mfpackage_compression.md +++ b/windows.graphics.printing3d/printing3d3mfpackage_compression.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.Compression --api-type: winrt property ---- - +--- +-api-id: P:Windows.Graphics.Printing3D.Printing3D3MFPackage.Compression +-api-type: winrt property +--- + -# Windows.Graphics.Printing3D.Printing3D3MFPackage.Compression - +# Windows.Graphics.Printing3D.Printing3D3MFPackage.Compression + ## -description +Gets and sets the intended file compression level for this 3MF package. This is taken into account when the [Printing3D3MFPackage](Printing3D3MFPackage.md) instance is converted to a 3MF file. ## -property-value +A [Printing3DPackageCompression](Printing3DPackageCompression.md) value describing the level of compression intended. ## -remarks diff --git a/windows.graphics.printing3d/printing3dpackagecompression.md b/windows.graphics.printing3d/printing3dpackagecompression.md index b06526458e..a1261962dd 100644 --- a/windows.graphics.printing3d/printing3dpackagecompression.md +++ b/windows.graphics.printing3d/printing3dpackagecompression.md @@ -1,22 +1,26 @@ ---- --api-id: T:Windows.Graphics.Printing3D.Printing3DPackageCompression --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Graphics.Printing3D.Printing3DPackageCompression +-api-type: winrt enum +--- + -# Windows.Graphics.Printing3D.Printing3DPackageCompression - +# Windows.Graphics.Printing3D.Printing3DPackageCompression + ## -description +Contains values that describe the intended file compression level. ## -enum-fields ### -field Medium:1 +Medium file compression. This is the default value. ### -field Low:0 +Low file compression. This results in faster in-memory processing. ### -field High:2 +High file compression. This is recommended to reduce the size of the 3MF package before saving it to disk or sending it over the network. ## -remarks diff --git a/windows.management.deployment/addpackagebyappinstalleroptions.md b/windows.management.deployment/addpackagebyappinstalleroptions.md new file mode 100644 index 0000000000..8106289b85 --- /dev/null +++ b/windows.management.deployment/addpackagebyappinstalleroptions.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.Management.Deployment.AddPackageByAppInstallerOptions +-api-type: winrt enum +--- + + + +# Windows.Management.Deployment.AddPackageByAppInstallerOptions + +## -description +A subset of [DeploymentOptions](deploymentoptions.md) that are valid for App Installer. + +## -enum-fields +### -field None:0 +The default behavior is used. + +### -field InstallAllResources:32 +When you set this option, the app is instructed to skip resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered. + +### -field ForceTargetAppShutdown:64 +If this package is currently in use, the processes associated with the package are shut down forcibly so that registration can continue. + +### -field RequiredContentGroupOnly:256 +When you set this option, only the required content group will be staged. An app can be installed as a package with the required content group alone. + +## -remarks + +## -see-also +[AddPackageByAppInstallerFileAsync()](packagemanager_addpackagebyappinstallerfileasync_1097728195.md) +[RequestAddPackageByAppInstallerFileAsync](packagemanager_requestaddpackagebyappinstallerfileasync_1360655875.md) + +## -examples + diff --git a/windows.management.deployment/packagemanager_addpackageasync_1360552771.md b/windows.management.deployment/packagemanager_addpackageasync_1360552771.md index 027c9c8bad..12fee06f59 100644 --- a/windows.management.deployment/packagemanager_addpackageasync_1360552771.md +++ b/windows.management.deployment/packagemanager_addpackageasync_1360552771.md @@ -33,6 +33,7 @@ The package family names from the main bundle to be registered. The URIs of the other packages in the main bundle to be registered. ## -returns +The DeploymentProgress percentage of completion over the entire course of the deployment operation. ## -remarks diff --git a/windows.management.deployment/packagemanager_addpackageasync_791807299.md b/windows.management.deployment/packagemanager_addpackageasync_791807299.md new file mode 100644 index 0000000000..5d11f77e05 --- /dev/null +++ b/windows.management.deployment/packagemanager_addpackageasync_791807299.md @@ -0,0 +1,45 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.AddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume,Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.AddPackageAsync + +## -description +Adds a package (the main package) and its dependency packages for the current user, using the specified deployment options. + +## -parameters +### -param packageUri +The URI of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. + +### -param dependencyPackageUris +The URIs of framework dependencies to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. + +### -param options +The deployment options for the package. + +### -param targetVolume +The volume to which the package is added. + +### -param optionalPackageFamilyNames +The package family names from the main bundle to be registered. + +### -param packageUrisToInstall +The URIs of optional packages to be installed with the main app package. + +### -param relatedPackageUris +URIs of related optional packages to be updated to the same version as the new optional packages. + +## -returns +The DeploymentProgress percentage of completion over the entire course of the deployment operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanager_addpackagebyappinstallerfileasync_1097728195.md b/windows.management.deployment/packagemanager_addpackagebyappinstallerfileasync_1097728195.md new file mode 100644 index 0000000000..8ceeb3e41e --- /dev/null +++ b/windows.management.deployment/packagemanager_addpackagebyappinstallerfileasync_1097728195.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.AddPackageByAppInstallerFileAsync(Windows.Foundation.Uri,Windows.Management.Deployment.AddPackageByAppInstallerOptions,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.AddPackageByAppInstallerFileAsync + +## -description +Allows single or multiple app packages to be installed with an .appinstaller file. + +## -parameters +### -param appInstallerFileUri +A Uri to the .appinstaller file. + +### -param options +The options as specified in [AddPackageByAppInstallerOptions](addpackagebyappinstalleroptions.md). + +### -param targetVolume +The volume that the package is installed to. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanager_provisionpackageforallusersasync_653384863.md b/windows.management.deployment/packagemanager_provisionpackageforallusersasync_653384863.md new file mode 100644 index 0000000000..e243047179 --- /dev/null +++ b/windows.management.deployment/packagemanager_provisionpackageforallusersasync_653384863.md @@ -0,0 +1,51 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.ProvisionPackageForAllUsersAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.ProvisionPackageForAllUsersAsync + +## -description +Enables an app package to be installed for all users on a device. + +## -parameters + +### -param packageFamilyName +The FamilyName of the app package to be installed. + +## -returns +The progress and the result of the app package deployment. + +## -remarks +To provision a package you must be an administrator. The app package to be provisioned must be staged, and it must be on the system volume. + +If the package is already provisioned, this perform a "clean" reprovision. A "clean" reprovision will remove all previous installs of this package so the package will behave as if this were its first installation. + +> [!NOTE] +> If you are provisioning optional packages, you must specify each optional package individually with its own method call. + +## -see-also + +## -examples +This example demonstrates adding a staged or existing registered package for all users on a device. + +```csharp +using Windows.Foundation; +using Windows.Management.Deployment; + +public void provisionForAllUsers(string inputPackageFamilyName) +{ + var packageManager = new PackageManager(); + var result = packageManager.ProvisionPackageForAllUsersAsync(inputPackageFamilyName).AsTask().Result; + if (result.ExtendedErrorCode != null) + { + System.Console.WriteLine("Error {0} provisioning {1}", result, inputPackageFamilyName); + throw result.ExtendedErrorCode.HResult; + } +} +``` + diff --git a/windows.management.deployment/packagemanager_requestaddpackageasync_1143838868.md b/windows.management.deployment/packagemanager_requestaddpackageasync_1143838868.md new file mode 100644 index 0000000000..c1756482ce --- /dev/null +++ b/windows.management.deployment/packagemanager_requestaddpackageasync_1143838868.md @@ -0,0 +1,69 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RequestAddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume,Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RequestAddPackageAsync + +## -description +Requests a SmartScreen check and user verification before installing the app package(s). + +## -parameters +### -param packageUri +The URI of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. + +### -param dependencyPackageUris +The URIs of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. + +### -param deploymentOptions +A valid enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. + +### -param targetVolume +The volume that the package is installed to. + +### -param optionalPackageFamilyNames +Strings that specify the optional package family names from the main bundle to be staged and registered. + +### -param relatedPackageUris +The URIs of additional packages in the main bundle that should be staged and registered. + +## -returns +The progress and the result of the app package deployment. + +## -remarks + +## -see-also + +## -examples +The example demonstrates how to use RequestAddPackageAsync in a UWP app by hooking it up to a button click handler. This will invoke the SmartScreen request UI window. + +```csharp +public async void OnInstallNowClicked(object sender, RoutedEventArgs args) +{ + var packageManager = new PackageManager(); + DeploymentOperation result = await packageManager.RequestAddPackageAsync( + this.currentPackageUri, + null /*no dependencies*/, + DeploymentOptions.None, + null /*stage to default package volume*/, + null /*no optional packages*/, + null /*no external packages*/); + + if (result.ExtendedErrorCode != null) + { + if (result.ExtendedErrorCode.HResult == 0x80073d01) + { + // SmartScreen blocked the app installation. + } + else + { + // The app installation failed for another reason. + } + } +} +``` + diff --git a/windows.management.deployment/packagemanager_requestaddpackagebyappinstallerfileasync_1360655875.md b/windows.management.deployment/packagemanager_requestaddpackagebyappinstallerfileasync_1360655875.md new file mode 100644 index 0000000000..db70e591e0 --- /dev/null +++ b/windows.management.deployment/packagemanager_requestaddpackagebyappinstallerfileasync_1360655875.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RequestAddPackageByAppInstallerFileAsync(Windows.Foundation.Uri,Windows.Management.Deployment.AddPackageByAppInstallerOptions,Windows.Management.Deployment.PackageVolume) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RequestAddPackageByAppInstallerFileAsync + +## -description +Allows single or multiple app packages to be installed with an .appinstaller file. This will perform a SmartScreen filter and user verification before installing the app package(s). + +## -parameters +### -param appInstallerFileUri +A Uri to the .appinstaller file. + +### -param options +The options as specified in [AddPackageByAppInstallerOptions](addpackagebyappinstalleroptions.md). + +### -param targetVolume +The volume that the package is installed to. + +## -returns + +## -remarks +This method is identical to [AddPackageByAppInstallerAsync](packagemanager_addpackagebyappinstallerfileasync_1097728195.md) except this uses the SmartScreen filter. + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanager_stagepackageasync_1226004594.md b/windows.management.deployment/packagemanager_stagepackageasync_1226004594.md new file mode 100644 index 0000000000..a468fe6e68 --- /dev/null +++ b/windows.management.deployment/packagemanager_stagepackageasync_1226004594.md @@ -0,0 +1,44 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume,Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StagePackageAsync + +## -description +Stages a package to the system without registering it. + +## -parameters +### -param packageUri +The source URI of the main package. + +### -param dependencyPackageUris +The URIs of framework dependencies to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. + +### -param options +The deployment options for the package. + +### -param targetVolume +The volume to which the package is added. + +### -param optionalPackageFamilyNames +The package family names from the main bundle to be staged. + +### -param packageUrisToInstall + +### -param relatedPackageUris +The URIs of additional packages in the main bundle that should be staged. + +## -returns +The status of the deployment request. The [DeploymentResult](deploymentresult.md) contains the final returned value of the deployment operation, once it is completed. The [DeploymentProgress](deploymentprogress.md) can be used to obtain the percentage of completion over the entire course of the deployment operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingmonitor.md b/windows.media.appbroadcasting/appbroadcastingmonitor.md new file mode 100644 index 0000000000..608a1065c4 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingmonitor.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.AppBroadcasting.AppBroadcastingMonitor +-api-type: winrt class +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingMonitor + +## -description +Allows an app to determine if it is currently being broadcast and to receive an event when the app starts or stops broadcasting. + +## -remarks +An app can use this class to show or hide UI elements that indicate that the app is currently broadcasting. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingmonitor_appbroadcastingmonitor_1221375020.md b/windows.media.appbroadcasting/appbroadcastingmonitor_appbroadcastingmonitor_1221375020.md new file mode 100644 index 0000000000..beb9b04ba9 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingmonitor_appbroadcastingmonitor_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Media.AppBroadcasting.AppBroadcastingMonitor.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingMonitor.AppBroadcastingMonitor + +## -description +Initializes a new instance of the **AppBroadcastingMonitor** class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingmonitor_iscurrentappbroadcasting.md b/windows.media.appbroadcasting/appbroadcastingmonitor_iscurrentappbroadcasting.md new file mode 100644 index 0000000000..9709413813 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingmonitor_iscurrentappbroadcasting.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingMonitor.IsCurrentAppBroadcasting +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingMonitor.IsCurrentAppBroadcasting + +## -description +Gets a value indicating whether the current app is currently broadcasting. + +## -property-value +True if the current app is broadcasting; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingmonitor_iscurrentappbroadcastingchanged.md b/windows.media.appbroadcasting/appbroadcastingmonitor_iscurrentappbroadcastingchanged.md new file mode 100644 index 0000000000..4f6b3eeba4 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingmonitor_iscurrentappbroadcastingchanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.AppBroadcasting.AppBroadcastingMonitor.IsCurrentAppBroadcastingChanged +-api-type: winrt event +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingMonitor.IsCurrentAppBroadcastingChanged + +## -description +Occurs when the current broadcasting state of the current app changes. + +## -remarks +In the handler for this event, check the **IsCurrentAppBroadcasting** property of the **AppBroadcastingMonitor** object passed as the event sender to determine if the current app is currently broadcasting. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatus.md b/windows.media.appbroadcasting/appbroadcastingstatus.md new file mode 100644 index 0000000000..e6a2850ee9 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatus.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.AppBroadcasting.AppBroadcastingStatus +-api-type: winrt class +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatus + +## -description +Allows an app to determine if it can currently begin broadcasting and, if not, obtain details about the reason that broadcasting can't be initiated. + +## -remarks +Can an instance of this class by calling the [**GetStatus**](appbroadcastingui_getstatus_169641651.md) method of the [AppBroadcastingUI](appbroadcastingui.md) class. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatus_canstartbroadcast.md b/windows.media.appbroadcasting/appbroadcastingstatus_canstartbroadcast.md new file mode 100644 index 0000000000..0d70881f0d --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatus_canstartbroadcast.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatus.CanStartBroadcast +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatus.CanStartBroadcast + +## -description +Gets a value indicating whether the current app can begin broadcasting. + +## -property-value +True if the app can begin broadcasting; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatus_details.md b/windows.media.appbroadcasting/appbroadcastingstatus_details.md new file mode 100644 index 0000000000..ed568d9105 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatus_details.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatus.Details +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatus.Details + +## -description +Gets an [**AppBroadcastingStatusDetails**](appbroadcastingstatusdetails.md) object that provides detailed information indicating why the current app can't currently begin broadcasting. + +## -property-value +An object that provides detailed information indicating why the current app can't currently begin broadcasting. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails.md new file mode 100644 index 0000000000..db601e1c60 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails +-api-type: winrt class +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails + +## -description +Provides detailed information indicating why the current app can't currently begin broadcasting. + +## -remarks +Get an instance of this class by accessing the [**AppBroadcastingStatus.Details**](appbroadcastingstatus_details.md) property. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isanyappbroadcasting.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isanyappbroadcasting.md new file mode 100644 index 0000000000..ca2ce3ed05 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isanyappbroadcasting.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsAnyAppBroadcasting +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsAnyAppBroadcasting + +## -description +Gets a value that indicates whether another app is currently broadcasting. + +## -property-value +True if another app is currently broadcasting; otherwise, false. + +## -remarks +The current app can't begin broadcasting while another app is broadcasting. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isappinactive.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isappinactive.md new file mode 100644 index 0000000000..4f66c435b7 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isappinactive.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsAppInactive +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsAppInactive + +## -description +Gets a value specifying if the current app's window is inactive. + +## -property-value +True is the current app's window is inactive; otherwise, false. + +## -remarks +An app can only begin broadcasting when it's window is the currently active window. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isblockedforapp.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isblockedforapp.md new file mode 100644 index 0000000000..f9c1cdf86c --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isblockedforapp.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsBlockedForApp +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsBlockedForApp + +## -description +Gets a value indicating whether broadcasting is blocked for the current app. + +## -property-value +True if broadcasting is blocked for the current app; otherwise, false. + +## -remarks +Use the [**AppBroadcastingUi**](appbroadcastingui.md) to show the broadcasting system setup UI. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_iscaptureresourceunavailable.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_iscaptureresourceunavailable.md new file mode 100644 index 0000000000..06397f13dd --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_iscaptureresourceunavailable.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsCaptureResourceUnavailable +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsCaptureResourceUnavailable + +## -description +Gets a value indicating whether the capture resource is currently unavailable. + +## -property-value +True if the capture resource is currently unavailable; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isdisabledbysystem.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isdisabledbysystem.md new file mode 100644 index 0000000000..e7b1ff44ea --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isdisabledbysystem.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsDisabledBySystem +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsDisabledBySystem + +## -description +Gets a value indicating whether app broadcasting is disabled by the system. + +## -property-value +True if app broadcasting is disabled by the system; otherwise, false. + +## -remarks +Use the [**AppBroadcastingUI**](appbroadcastingui.md) to show the broadcasting system setup UI. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isdisabledbyuser.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isdisabledbyuser.md new file mode 100644 index 0000000000..2364ff8ccb --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isdisabledbyuser.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsDisabledByUser +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsDisabledByUser + +## -description +Gets a value indicating if app broadcasting has been disabled by the user. + +## -property-value +True if app broadcasting has been disabled by the user; otherwise, false. + +## -remarks +Use the [**AppBroadcastingUI**](appbroadcastingui.md) to show the broadcasting system setup UI. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isgamestreaminprogress.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isgamestreaminprogress.md new file mode 100644 index 0000000000..e4803965f6 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isgamestreaminprogress.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsGameStreamInProgress +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsGameStreamInProgress + +## -description +Gets a value that indicates if a game stream is currently in progress. + +## -property-value +True if a game stream is currently in progress; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingstatusdetails_isgpuconstrained.md b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isgpuconstrained.md new file mode 100644 index 0000000000..a5915c5bf8 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingstatusdetails_isgpuconstrained.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsGpuConstrained +-api-type: winrt property +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingStatusDetails.IsGpuConstrained + +## -description +Gets a value that indicates whether app broadcasting is unavailable because the GPU is constrained. + +## -property-value +True if app broadcasting is unavailable because the GPU is constrained; otherwise, false. + +## -remarks +Typically, if this value is true, it means that the GPU software does not include an H264 encoder. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingui.md b/windows.media.appbroadcasting/appbroadcastingui.md new file mode 100644 index 0000000000..9c6fcef49c --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingui.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.AppBroadcasting.AppBroadcastingUI +-api-type: winrt class +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingUI + +## -description +Enables an app to launch the app broadcasting system setup UI. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingui_getdefault_846721868.md b/windows.media.appbroadcasting/appbroadcastingui_getdefault_846721868.md new file mode 100644 index 0000000000..2e429a3ba5 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingui_getdefault_846721868.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Media.AppBroadcasting.AppBroadcastingUI.GetDefault +-api-type: winrt method +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingUI.GetDefault + +## -description +Gets an instance of the **AppBroadcastingUI** class that is associated with the user currently signed in to the device. + +## -returns +An instance of the **AppBroadcastingUI** class. + +## -remarks +Use this method platforms where there is a single user associated with a single session, such as a Windows PC. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingui_getforuser_2058550280.md b/windows.media.appbroadcasting/appbroadcastingui_getforuser_2058550280.md new file mode 100644 index 0000000000..c6e6711ee0 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingui_getforuser_2058550280.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.AppBroadcasting.AppBroadcastingUI.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingUI.GetForUser + +## -description +Gets an instance of the **AppBroadcastingUI** class that is associated with the specified user. + +## -parameters +### -param user +The user for which the **AppBroadcastingUI** instance is created. + +## -returns +An instance of the **AppBroadcastingUI** class. + +## -remarks +Use this method platforms where there a multiple users associated with a single session, such as XBox. + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingui_getstatus_169641651.md b/windows.media.appbroadcasting/appbroadcastingui_getstatus_169641651.md new file mode 100644 index 0000000000..719ef8654f --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingui_getstatus_169641651.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.AppBroadcasting.AppBroadcastingUI.GetStatus +-api-type: winrt method +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingUI.GetStatus + +## -description +Gets an object that allows an app to determine if it can currently begin broadcasting and, if not, obtain details about the reason that broadcasting can't be initiated. + +## -returns +An object that allows an app to determine if it can currently begin broadcasting. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/appbroadcastingui_showbroadcastui_1219891603.md b/windows.media.appbroadcasting/appbroadcastingui_showbroadcastui_1219891603.md new file mode 100644 index 0000000000..9e54242ec7 --- /dev/null +++ b/windows.media.appbroadcasting/appbroadcastingui_showbroadcastui_1219891603.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Media.AppBroadcasting.AppBroadcastingUI.ShowBroadcastUI +-api-type: winrt method +--- + + + +# Windows.Media.AppBroadcasting.AppBroadcastingUI.ShowBroadcastUI + +## -description +Shows the app broadcasting system setup UI. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.appbroadcasting/windows_media_appbroadcasting.md b/windows.media.appbroadcasting/windows_media_appbroadcasting.md new file mode 100644 index 0000000000..19547e05ce --- /dev/null +++ b/windows.media.appbroadcasting/windows_media_appbroadcasting.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.Media.AppBroadcasting +-api-type: winrt namespace +--- + + + +# Windows.Media.AppBroadcasting + +## -description +Provides APIs for getting the broadcasting status for the current app. This includes determining whether the app can currently begin broadcasting and, if not, details about why broadcasting can't be started as well as the ability to launch the app broadcasting system setup UI. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager.md b/windows.media.apprecording/apprecordingmanager.md new file mode 100644 index 0000000000..c10d5f4462 --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingManager +-api-type: winrt class +--- + + + +# Windows.Media.AppRecording.AppRecordingManager + +## -description +Enables a UWP app to save recordings and screenshots of its content. + +## -remarks +Get an instance of this class by calling [**GetDefault**](apprecordingmanager_getdefault_846721868.md). + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager_getdefault_846721868.md b/windows.media.apprecording/apprecordingmanager_getdefault_846721868.md new file mode 100644 index 0000000000..f57f5a2481 --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager_getdefault_846721868.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.AppRecording.AppRecordingManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.Media.AppRecording.AppRecordingManager.GetDefault + +## -description +Gets an instance of the **AppRecordingManager** class. + +## -returns +An instance of the **AppRecordingManager** class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager_getstatus_169641651.md b/windows.media.apprecording/apprecordingmanager_getstatus_169641651.md new file mode 100644 index 0000000000..32edca6b27 --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager_getstatus_169641651.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.AppRecording.AppRecordingManager.GetStatus +-api-type: winrt method +--- + + + +# Windows.Media.AppRecording.AppRecordingManager.GetStatus + +## -description +Gets an object that provides information about whether the current app is currently able to initiate an app recording, and if not, provides details about the reasons that app recording is unavailable. + +## -returns +An [**AppRecordingStatusDetails**](apprecordingstatusdetails.md) object that provides status information about app recording. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager_recordtimespantofileasync_583577299.md b/windows.media.apprecording/apprecordingmanager_recordtimespantofileasync_583577299.md new file mode 100644 index 0000000000..c68da895c2 --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager_recordtimespantofileasync_583577299.md @@ -0,0 +1,38 @@ +--- +-api-id: M:Windows.Media.AppRecording.AppRecordingManager.RecordTimeSpanToFileAsync(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.AppRecording.AppRecordingManager.RecordTimeSpanToFileAsync + +## -description +Writes audio and video content of the current app from the historical buffer, with a time range defined by the specified start time and duration, to the specified destination file. + +## -parameters +### -param startTime +The time at which the content to be recorded started. This value must be within the duration of the historical buffer, which can be determined by calling [**AppRecordingManager.GetStatus**](apprecordingmanager_getstatus_169641651.md) and then checking the value of the [**AppRecordingStatus.HistoricalBufferDuration**](apprecordingstatus_historicalbufferduration.md) property. + +### -param duration +The requested duration of the app recording. An app recording can succeed, but record a shorter duration than specified with this parameter if the allocated storage for recordings is reached. To determine the duration of the file that was actually recorded, check the value [**AppRecordingResult.Duration**](apprecordingresult_duration.md) property of the object returned from this operation. + +### -param file +The file to which the recorded media is written. + +## -returns +An asynchronous operation that returns an [**AppRecordingResult**](C:\Users\drewbat\Source\Repos\winrt-api\windows.media.apprecording\apprecordingresult.md) object upon completion, which contains information about the status of the recording operation. + +## -remarks +The stored file containing the app recording is created as an MP4 with h.264 video and AAC audio. Video files recorded using **AppRecordingManager** are not ingested into first-party experiences like GameDVR or the XBox app. + +Before calling this method, call [**GetStatus**](apprecordingmanager_recordtimespantofileasync_583577299.md) and check the value of the [**CanRecordTimeSpan**](apprecordingstatus_canrecordtimespan.md) to determine if the current app is currently able to make a time span recording. + +Use [**StartRecordingToFileAsync**](apprecordingmanager_startrecordingtofileasync_706691331.md) to begin an app recording at the current time. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager_savescreenshottofilesasync_1063354614.md b/windows.media.apprecording/apprecordingmanager_savescreenshottofilesasync_1063354614.md new file mode 100644 index 0000000000..7e90292568 --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager_savescreenshottofilesasync_1063354614.md @@ -0,0 +1,37 @@ +--- +-api-id: M:Windows.Media.AppRecording.AppRecordingManager.SaveScreenshotToFilesAsync(Windows.Storage.StorageFolder,System.String,Windows.Media.AppRecording.AppRecordingSaveScreenshotOption,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Media.AppRecording.AppRecordingManager.SaveScreenshotToFilesAsync + +## -description +Asynchronously saves an image file containing the current contents of the calling app. + +## -parameters +### -param folder +The path to which the recorded media file is written. + +### -param filenamePrefix +The prefix of the filename used for saved images. The system appends the appropriate extension to the filename for each format specified in the *requestedFormats* parameter. + +### -param option +A value that specifies options for saving the screenshot. To help the system perform the proper colorspace conversions, apps should specify [**HdrContentVisible**](apprecordingsavescreenshotoption.md) if the content to be saved includes HDR content. Otherwise, apps should specify **None**. + +### -param requestedFormats +A list of strings specifying the formats in which screenshot images should be saved. Get a list of the supported values for this parameter with the [**SupportedScreenshotMediaEncodingSubtypes**](apprecordingmanager_supportedscreenshotmediaencodingsubtypes.md) property. + +## -returns +An asynchronous operation that returns an [**AppRecordingSaveScreenshotResult**](apprecordingsavescreenshotresult.md) upon completion that can be used to get information about the results of the save operation. + +## -remarks +Images files saved using **AppRecordingManager** are not ingested into first-party experiences like GameDVR or the XBox app. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager_startrecordingtofileasync_706691331.md b/windows.media.apprecording/apprecordingmanager_startrecordingtofileasync_706691331.md new file mode 100644 index 0000000000..fec30d168d --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager_startrecordingtofileasync_706691331.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.AppRecording.AppRecordingManager.StartRecordingToFileAsync(Windows.Storage.StorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.AppRecording.AppRecordingManager.StartRecordingToFileAsync + +## -description +Writes audio and video content of the current app to the specified destination file, beginning at the current time and ending when the operation is cancelled or storage space has been exceeded. + +## -parameters +### -param file +The file to which the recorded media is written. + +## -returns +An asynchronous operation that returns an [**AppRecordingResult**](C:\Users\drewbat\Source\Repos\winrt-api\windows.media.apprecording\apprecordingresult.md) object upon completion, which contains information about the status of the recording operation. + +Before calling this method, call [**GetStatus**](apprecordingmanager_recordtimespantofileasync_583577299.md) and check the value of the [**CanRecord**](apprecordingstatus_canrecord.md) to determine if the current app is currently able to make an app recording. + +To end an app recording that was initiated with this method, cancel the operation by calling [**Cancel**](https://docs.microsoft.com/uwp/api/windows.foundation.iasyncinfo#Windows_Foundation_IAsyncInfo_Cancel) on the [**IAsyncOperation**](https://docs.microsoft.com/en-us/uwp/api/windows.foundation.iasyncoperation_tresult_) returned by this method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingmanager_supportedscreenshotmediaencodingsubtypes.md b/windows.media.apprecording/apprecordingmanager_supportedscreenshotmediaencodingsubtypes.md new file mode 100644 index 0000000000..d88798325e --- /dev/null +++ b/windows.media.apprecording/apprecordingmanager_supportedscreenshotmediaencodingsubtypes.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingManager.SupportedScreenshotMediaEncodingSubtypes +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingManager.SupportedScreenshotMediaEncodingSubtypes + +## -description +Gets a list of strings representing the media encoding subtypes supported for the [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) method. + +## -property-value +A list of strings representing the media encoding subtypes supported for the [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingresult.md b/windows.media.apprecording/apprecordingresult.md new file mode 100644 index 0000000000..bbca11a85f --- /dev/null +++ b/windows.media.apprecording/apprecordingresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingResult +-api-type: winrt class +--- + + + +# Windows.Media.AppRecording.AppRecordingResult + +## -description +Represents the results of an app recording operation started with a call to [**RecordTimeSpanToFileAsync**](apprecordingmanager_recordtimespantofileasync_583577299.md) or [**StartRecordingToFileAsync**](apprecordingmanager_startrecordingtofileasync_706691331.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingresult_duration.md b/windows.media.apprecording/apprecordingresult_duration.md new file mode 100644 index 0000000000..5f733b2980 --- /dev/null +++ b/windows.media.apprecording/apprecordingresult_duration.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingResult.Duration +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingResult.Duration + +## -description +Gets the duration of the recorded file. + +## -property-value +The duration of the recorded file. + +## -remarks +[**RecordTimeSpanToFileAsync**](apprecordingmanager_recordtimespantofileasync_583577299.md) allows you to specify a requested duration for the app recording, but it is possible a recording to complete successfully, but for a shorter duration than requested, such as if the allocated storage space for recordings is filled. Check the value of the [**IsFileTruncated**](apprecordingresult_isfiletruncated.md) property to determine if the file was truncated. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingresult_extendederror.md b/windows.media.apprecording/apprecordingresult_extendederror.md new file mode 100644 index 0000000000..c6f9fe5d46 --- /dev/null +++ b/windows.media.apprecording/apprecordingresult_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingResult.ExtendedError + +## -description +Gets the extended error code associated returned by the app recording operation. + +## -property-value +The extended error code associated returned by the app recording operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingresult_isfiletruncated.md b/windows.media.apprecording/apprecordingresult_isfiletruncated.md new file mode 100644 index 0000000000..fe8d5040fd --- /dev/null +++ b/windows.media.apprecording/apprecordingresult_isfiletruncated.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingResult.IsFileTruncated +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingResult.IsFileTruncated + +## -description +Gets a value that indicates if the saved app recording was truncated. + +## -property-value +True if the file was truncated; otherwise, false. + +## -remarks +[**RecordTimeSpanToFileAsync**](apprecordingmanager_recordtimespantofileasync_583577299.md) allows you to specify a requested duration for the app recording, but it is possible a recording to complete successfully, but for a shorter duration than requested, such as if the allocated storage space for recordings is filled. Check the value of the [**Duration**](apprecordingresult_duration.md) property to determine the actual duration of the recorded file. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingresult_succeeded.md b/windows.media.apprecording/apprecordingresult_succeeded.md new file mode 100644 index 0000000000..f50be32695 --- /dev/null +++ b/windows.media.apprecording/apprecordingresult_succeeded.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingResult.Succeeded +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingResult.Succeeded + +## -description +Gets a value that indicates if the app recording operations succeeded. + +## -property-value +True if the recording operation succeeded; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavedscreenshotinfo.md b/windows.media.apprecording/apprecordingsavedscreenshotinfo.md new file mode 100644 index 0000000000..876d65d3b9 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavedscreenshotinfo.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingSavedScreenshotInfo +-api-type: winrt class +--- + + + +# Windows.Media.AppRecording.AppRecordingSavedScreenshotInfo + +## -description +Represents information about an image file saved from the screenshot operation, including the **StorageFile** associated with the file and the media encoding subtype indicating the format of the file. + +## -remarks +Get an instance of this class by accessing the [**SavedScreenshotInfos**](apprecordingsavescreenshotresult_savedscreenshotinfos.md) property of the [**AppRecordingSaveScreenshotResult**](apprecordingsavescreenshotresult.md) returned from a call to [**SaveScreenshotToFileAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md). + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavedscreenshotinfo_file.md b/windows.media.apprecording/apprecordingsavedscreenshotinfo_file.md new file mode 100644 index 0000000000..f58d12ef91 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavedscreenshotinfo_file.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingSavedScreenshotInfo.File +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingSavedScreenshotInfo.File + +## -description +Gets the file to which a screenshot saved with [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) was saved. + +## -property-value +The file to which a screenshot saved with [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) was saved. + +## -remarks +Get the list of the **AppRecordingSavedScreenShotInfo** objects representing the results of an app screenshot operation by accessing the [**SavedSCreenshotInfos**](apprecordingsavescreenshotresult_savedscreenshotinfos.md) property of the [**AppRecordingSavedScreenshotResult**]((apprecordingsavescreenshotresult.md)) object returned by the asynchronous **SaveScreenshotToFilesAsync** operation. + +## -see-also +[**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavedscreenshotinfo_mediaencodingsubtype.md b/windows.media.apprecording/apprecordingsavedscreenshotinfo_mediaencodingsubtype.md new file mode 100644 index 0000000000..2420108f00 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavedscreenshotinfo_mediaencodingsubtype.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingSavedScreenshotInfo.MediaEncodingSubtype +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingSavedScreenshotInfo.MediaEncodingSubtype + +## -description +Gets a string representing the media encoding subtype of the image format with which a screenshot saved with [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) was encoded. + +## -property-value +A string representing the media encoding subtype of a saved screenshot. + +## -remarks +Get the list of the **AppRecordingSavedScreenShotInfo** objects representing the results of an app screenshot operation by accessing the [**SavedSCreenshotInfos**](apprecordingsavescreenshotresult_savedscreenshotinfos.md) property of the [**AppRecordingSavedScreenshotResult**]((apprecordingsavescreenshotresult.md)) object returned by the asynchronous **SaveScreenshotToFilesAsync** operation. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavescreenshotoption.md b/windows.media.apprecording/apprecordingsavescreenshotoption.md new file mode 100644 index 0000000000..bc003e2b91 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavescreenshotoption.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingSaveScreenshotOption +-api-type: winrt enum +--- + + + +# Windows.Media.AppRecording.AppRecordingSaveScreenshotOption + +## -description +Specifies the options used for saving a screenshot with [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md). + +## -enum-fields +### -field None:0 +No option is specified. + +### -field HdrContentVisible:1 +The contents of the app window includes High Dynamic Range (HDR) content. + +## -remarks +Specifying this value provides the system with a hint to help it perform the proper colorspace conversions when saving a screenshot. If the content of the app window contains HDR content, the app should specify **HdrContentVisible**, otherwise the app should specify **None**. + +## -see-also +[**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavescreenshotresult.md b/windows.media.apprecording/apprecordingsavescreenshotresult.md new file mode 100644 index 0000000000..c369a0aa5a --- /dev/null +++ b/windows.media.apprecording/apprecordingsavescreenshotresult.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingSaveScreenshotResult +-api-type: winrt class +--- + + + +# Windows.Media.AppRecording.AppRecordingSaveScreenshotResult + +## -description +Represents the results of a screenshot operation initiated with a call to [**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md). + +## -remarks + +## -see-also +[**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavescreenshotresult_extendederror.md b/windows.media.apprecording/apprecordingsavescreenshotresult_extendederror.md new file mode 100644 index 0000000000..86e88a2199 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavescreenshotresult_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingSaveScreenshotResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingSaveScreenshotResult.ExtendedError + +## -description +Gets the extended error code associated returned by the screenshot operation. + +## -property-value +The extended error code associated returned by the screenshot operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavescreenshotresult_savedscreenshotinfos.md b/windows.media.apprecording/apprecordingsavescreenshotresult_savedscreenshotinfos.md new file mode 100644 index 0000000000..190765ec27 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavescreenshotresult_savedscreenshotinfos.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingSaveScreenshotResult.SavedScreenshotInfos +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingSaveScreenshotResult.SavedScreenshotInfos + +## -description +Gets a list of [**AppRecordingSavedScreenshotInfo**](C:\Users\drewbat\Source\Repos\winrt-api\windows.media.apprecording\apprecordingsavedscreenshotinfo_file.md) objects representing the image files saved from the screenshot operation. + +## -property-value +A list of [**AppRecordingSavedScreenshotInfo**](C:\Users\drewbat\Source\Repos\winrt-api\windows.media.apprecording\apprecordingsavedscreenshotinfo_file.md) objects representing the image files saved from the screenshot operation. + +## -remarks +[**SaveScreenshotToFilesAsync**](apprecordingmanager_savescreenshottofilesasync_1063354614.md) allows you to save multiple image files, each with different image encoding, with a single call. The **AppRecordingSavedScreenshotInfo** objects returned by this property allow you to access the **StorageFile** and encoding subtype for each saved image. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingsavescreenshotresult_succeeded.md b/windows.media.apprecording/apprecordingsavescreenshotresult_succeeded.md new file mode 100644 index 0000000000..fe6b2660f7 --- /dev/null +++ b/windows.media.apprecording/apprecordingsavescreenshotresult_succeeded.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingSaveScreenshotResult.Succeeded +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingSaveScreenshotResult.Succeeded + +## -description +Gets a value that indicates if the screenshot operation succeeded. + +## -property-value +True if the screenshot operation succeeded; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatus.md b/windows.media.apprecording/apprecordingstatus.md new file mode 100644 index 0000000000..afa4ffc65c --- /dev/null +++ b/windows.media.apprecording/apprecordingstatus.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingStatus +-api-type: winrt class +--- + + + +# Windows.Media.AppRecording.AppRecordingStatus + +## -description +Provides information about whether the current app is currently able to initiate an app recording by calling [**StartRecordingToFileAsymc**](apprecordingmanager_startrecordingtofileasync_706691331.md) or [**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md), and if not, provides details about the reasons that app recording is unavailable. + +## -remarks +Get an instance of this class by calling [**AppRecordingManager.GetStatus**](apprecordingmanager_getstatus_169641651.md). + +## -see-also +[**AppRecordingManager.GetStatus**](apprecordingmanager_getstatus_169641651.md) +[**StartRecordingToFileAsymc**](apprecordingmanager_startrecordingtofileasync_706691331.md) +[**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md) + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatus_canrecord.md b/windows.media.apprecording/apprecordingstatus_canrecord.md new file mode 100644 index 0000000000..8bf1467550 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatus_canrecord.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatus.CanRecord +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatus.CanRecord + +## -description +Gets a value that indicates whether the current app can currently record the audio and video content of the app by calling [**StartRecordingToFileAsymc**](apprecordingmanager_startrecordingtofileasync_706691331.md). + +## -property-value +True if the app can can currently record; otherwise, false. + +## -remarks +If this value is false, check the [**Details**](apprecordingstatus_details.md) to get detailed information on why the app can't currently record. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatus_canrecordtimespan.md b/windows.media.apprecording/apprecordingstatus_canrecordtimespan.md new file mode 100644 index 0000000000..a73db0f79c --- /dev/null +++ b/windows.media.apprecording/apprecordingstatus_canrecordtimespan.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatus.CanRecordTimeSpan +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatus.CanRecordTimeSpan + +## -description +Gets a value that indicates whether the current app can currently record a timespan of the audio and video content of the app by calling [**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md). + +## -property-value + +## -remarks +If this value is false, check the [**Details**](apprecordingstatus_details.md) to get detailed information on why the app can't currently record a timspan. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatus_details.md b/windows.media.apprecording/apprecordingstatus_details.md new file mode 100644 index 0000000000..4260b81c94 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatus_details.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatus.Details +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatus.Details + +## -description +Gets an [**AppRecordingStatusDetails**](apprecordingstatusdetails.md) object that provides detailed information indicating why the current app can't currently begin recording. + +## -property-value +An object that provides detailed information indicating why the current app can't currently begin recording. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatus_historicalbufferduration.md b/windows.media.apprecording/apprecordingstatus_historicalbufferduration.md new file mode 100644 index 0000000000..2f20420204 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatus_historicalbufferduration.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatus.HistoricalBufferDuration +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatus.HistoricalBufferDuration + +## -description +Gets a value that indicates the duration of the historical app recording buffer. + +## -property-value +The duration of the historical app recording buffer. + +## -remarks +The timespan returned by this property specifies the allowed range of the *startTime* parameter to the [**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md) method. + +## -see-also +[**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md) method. + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails.md b/windows.media.apprecording/apprecordingstatusdetails.md new file mode 100644 index 0000000000..e8ba28142e --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.AppRecording.AppRecordingStatusDetails +-api-type: winrt class +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails + +## -description +Provides detailed information indicating why the current app can't currently begin recording app content by calling [**StartRecordingToFileAsymc**](apprecordingmanager_startrecordingtofileasync_706691331.md) or [**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md). + +## -remarks +Get an instance of this class by accessing the [**AppRecordingStatus.Details**](apprecordingstatus_details.md) property. + +## -see-also +[**AppRecordingStatus.Details**](apprecordingstatus_details.md) +[**StartRecordingToFileAsymc**](apprecordingmanager_startrecordingtofileasync_706691331.md) +[**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md) + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isanyappbroadcasting.md b/windows.media.apprecording/apprecordingstatusdetails_isanyappbroadcasting.md new file mode 100644 index 0000000000..4fd452f0a1 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isanyappbroadcasting.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsAnyAppBroadcasting +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsAnyAppBroadcasting + +## -description +Gets a value that indicates whether another app is currently broadcasting. + +## -property-value +True if another app is currently broadcasting; otherwise, false. + +## -remarks +The current app can't begin recording while another app is broadcasting. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isappinactive.md b/windows.media.apprecording/apprecordingstatusdetails_isappinactive.md new file mode 100644 index 0000000000..aca487e878 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isappinactive.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsAppInactive +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsAppInactive + +## -description +Gets a value specifying if the current app's window is inactive. + +## -property-value +True is the current app's window is inactive; otherwise, false. + +## -remarks +An app can only begin recording when it's window is the currently active window. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isblockedforapp.md b/windows.media.apprecording/apprecordingstatusdetails_isblockedforapp.md new file mode 100644 index 0000000000..682dbb6764 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isblockedforapp.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsBlockedForApp +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsBlockedForApp + +## -description +Gets a value indicating whether app recording is blocked for the current app. + +## -property-value +True if app recording is blocked for the current app; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_iscaptureresourceunavailable.md b/windows.media.apprecording/apprecordingstatusdetails_iscaptureresourceunavailable.md new file mode 100644 index 0000000000..a8507cf4a8 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_iscaptureresourceunavailable.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsCaptureResourceUnavailable +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsCaptureResourceUnavailable + +## -description +Gets a value indicating whether the capture resource is currently unavailable. + +## -property-value +True if the capture resource is currently unavailable; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isdisabledbysystem.md b/windows.media.apprecording/apprecordingstatusdetails_isdisabledbysystem.md new file mode 100644 index 0000000000..0f37d78359 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isdisabledbysystem.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsDisabledBySystem +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsDisabledBySystem + +## -description +Gets a value indicating whether app recording is disabled by the system. + +## -property-value +True if app recording is disabled by the system; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isdisabledbyuser.md b/windows.media.apprecording/apprecordingstatusdetails_isdisabledbyuser.md new file mode 100644 index 0000000000..ee5ea42d8b --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isdisabledbyuser.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsDisabledByUser +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsDisabledByUser + +## -description +Gets a value indicating if app recording has been disabled by the user. + +## -property-value +True if app recording has been disabled by the user; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isgamestreaminprogress.md b/windows.media.apprecording/apprecordingstatusdetails_isgamestreaminprogress.md new file mode 100644 index 0000000000..4ed88ba5bd --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isgamestreaminprogress.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsGameStreamInProgress +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsGameStreamInProgress + +## -description +Gets a value that indicates if a game stream is currently in progress. + +## -property-value +True if a game stream is currently in progress; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_isgpuconstrained.md b/windows.media.apprecording/apprecordingstatusdetails_isgpuconstrained.md new file mode 100644 index 0000000000..2c05bcc0fc --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_isgpuconstrained.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsGpuConstrained +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsGpuConstrained + +## -description +Gets a value that indicates whether app recording is unavailable because the GPU is constrained. + +## -property-value +True if app recording is unavailable because the GPU is constrained; otherwise, false. + +## -remarks +Typically, if this value is true, it means that the GPU software does not include an H264 encoder. + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/apprecordingstatusdetails_istimespanrecordingdisabled.md b/windows.media.apprecording/apprecordingstatusdetails_istimespanrecordingdisabled.md new file mode 100644 index 0000000000..514c7bee87 --- /dev/null +++ b/windows.media.apprecording/apprecordingstatusdetails_istimespanrecordingdisabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.AppRecording.AppRecordingStatusDetails.IsTimeSpanRecordingDisabled +-api-type: winrt property +--- + + + +# Windows.Media.AppRecording.AppRecordingStatusDetails.IsTimeSpanRecordingDisabled + +## -description +Gets a value specifying wether recording a specified timespan of app content with [**RecordTimespanToFileAsymc**](apprecordingmanager_recordtimespantofileasync_583577299.md) is disabled. + +## -property-value +True if recording a timespan of app content is disabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.apprecording/windows_media_apprecording.md b/windows.media.apprecording/windows_media_apprecording.md new file mode 100644 index 0000000000..63e3ffd2eb --- /dev/null +++ b/windows.media.apprecording/windows_media_apprecording.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.Media.AppRecording +-api-type: winrt namespace +--- + + + +# Windows.Media.AppRecording + +## -description +Provides APIs for recording the audio and video content of an app to a file, saving screenshots of app content to image files, and querying the current availability of app recording and screenshot functionality. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/mediaframereader_acquisitionmode.md b/windows.media.capture.frames/mediaframereader_acquisitionmode.md new file mode 100644 index 0000000000..2d7e99a097 --- /dev/null +++ b/windows.media.capture.frames/mediaframereader_acquisitionmode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.Frames.MediaFrameReader.AcquisitionMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.AcquisitionMode + +## -description +Gets or sets a value that specifies the way that the system should manage frames acquired from a **MediaFrameReader** when a new frame arrives before the app has finished processing the previous frame. + +## -property-value +A value that specifies the frame reader's acquisition mode. + +## -remarks +If this property is set to [**Realtime**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereaderacquisitionmode), frames that arrive while the app's [**FrameArrived**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereader#Windows_Media_Capture_Frames_MediaFrameReader_FrameArrived) event handler is executing are dropped. This mode works well for scenarios where processing the most current frame is prioritized, such as real-time computer vision applications. + +If this property is set to [**Buffered**]((https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereaderacquisitionmode), frames that arrive while the app's **FrameArrived** event handler is executing are buffered in memory by the system. The **FrameArrived** event is raised for each buffered frame when the event handler for the previous frame has completed. This mode is intended for apps for which the sequence of frames is critical and for which dropped frames will break the scenario. Note that once the system's memory limit for buffered frames has been reached, no more frames will be acquired until the app processes buffered frames, freeing memory for the acquisition of additional frames. + +## -see-also +[**MediaFrameReaderAcquisitionMode**]((https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereaderacquisitionmode) + +## -examples + diff --git a/windows.media.capture.frames/mediaframereaderacquisitionmode.md b/windows.media.capture.frames/mediaframereaderacquisitionmode.md new file mode 100644 index 0000000000..ad438ae291 --- /dev/null +++ b/windows.media.capture.frames/mediaframereaderacquisitionmode.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameReaderAcquisitionMode +-api-type: winrt enum +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReaderAcquisitionMode + +## -description +Specifies the way that the system should manage frames acquired from a [**MediaFrameReader**](https://docs.microsoft.com/en-us/uwp/api/windows.media.capture.frames.mediaframereader) or a [**MultiSourceMediaFrameReader**](https://docs.microsoft.com/en-us/uwp/api/windows.media.capture.frames.multisourcemediaframereader) when a new frame arrives before the app has finished processing the previous frame. + +## -enum-fields +### -field Realtime:0 +Frames that arrive while the app's [**FrameArrived**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereader#Windows_Media_Capture_Frames_MediaFrameReader_FrameArrived) event handler is executing are dropped. This mode works well for scenarios where processing the most current frame is prioritized, such as real-time computer vision applications. + +### -field Buffered:1 +Frames that arrive while the app's [**FrameArrived**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereader#Windows_Media_Capture_Frames_MediaFrameReader_FrameArrived) event handler is executing are buffered in memory by the system. The **FrameArrived** event is raised for each buffered frame when the event handler for the previous frame has completed. This mode is intended for apps for which the sequence of frames is critical and for which dropped frames will break the scenario. Note that once the system's memory limit for buffered frames has been reached, no more frames will be acquired until the app processes buffered frames, freeing memory for the acquisition of additional frames. + +## -remarks +Use a value from this enumeration when setting the [**MediaFrameReader.AcquisitionMode**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereader#Windows_Media_Capture_Frames_MediaFrameReader_AcquisitionMode) property or the [**MultiSourceMediaFrameReader.AcquisitionMode**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.multisourcemediaframereader#Windows_Media_Capture_Frames_MultiSourceMediaFrameReader_AcquisitionMode) property. + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereader_acquisitionmode.md b/windows.media.capture.frames/multisourcemediaframereader_acquisitionmode.md new file mode 100644 index 0000000000..3c820b8bf1 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader_acquisitionmode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.AcquisitionMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.AcquisitionMode + +## -description +Specifies the way that the system should manage frames acquired from a **MultiSourceMediaFrameReader** when a new frame arrives before the app has finished processing the previous frame. + +## -property-value +A value that specifies the frame reader's acquisition mode. + +## -remarks +If this property is set to [**Realtime**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereaderacquisitionmode), frames that arrive while the app's [**FrameArrived**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.multisourcemediaframereader#Windows_Media_Capture_Frames_MultiSourceMediaFrameReader_FrameArrived) event handler is executing are dropped. This mode works well for scenarios where processing the most current frame is prioritized, such as real-time computer vision applications. + +If this property is set to [**Buffered**]((https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereaderacquisitionmode), frames that arrive while the app's **FrameArrived** event handler is executing are buffered in memory by the system. The **FrameArrived** event is raised for each buffered frame when the event handler for the previous frame has completed. This mode is intended for apps for which the sequence of frames is critical and for which dropped frames will break the scenario. Note that once the system's memory limit for buffered frames has been reached, no more frames will be acquired until the app processes buffered frames, freeing memory for the acquisition of additional frames. + +## -see-also +[**MediaFrameReaderAcquisitionMode**]((https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframereaderacquisitionmode) + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservice_broadcastchannel.md b/windows.media.capture/appbroadcastbackgroundservice_broadcastchannel.md new file mode 100644 index 0000000000..f3a3221903 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_broadcastchannel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastChannel +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastChannel + +## -description +Gets a string containing the name of the current broadcast channel. + +## -property-value +A string containing the name of the current broadcast channel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservice_broadcastchannelchanged.md b/windows.media.capture/appbroadcastbackgroundservice_broadcastchannelchanged.md new file mode 100644 index 0000000000..9589a39daa --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_broadcastchannelchanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastChannelChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastChannelChanged + +## -description +Occurs when the value of the [**BroadcastChannel**](appbroadcastbackgroundservice_broadcastchannel.md) property changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservice_broadcastlanguage.md b/windows.media.capture/appbroadcastbackgroundservice_broadcastlanguage.md new file mode 100644 index 0000000000..1677babaf4 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_broadcastlanguage.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastLanguage +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastLanguage + +## -description +Gets a string representing the language of the current broadcast channel. + +## -property-value +A string representing the language of the current broadcast channel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservice_broadcastlanguagechanged.md b/windows.media.capture/appbroadcastbackgroundservice_broadcastlanguagechanged.md new file mode 100644 index 0000000000..99454c2bb9 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_broadcastlanguagechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastLanguageChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastLanguageChanged + +## -description +Occurs when the value of the [**BroadcastLanguage**](appbroadcastbackgroundservice_broadcastlanguage.md) property changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservice_broadcasttitlechanged.md b/windows.media.capture/appbroadcastbackgroundservice_broadcasttitlechanged.md new file mode 100644 index 0000000000..34cb782190 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_broadcasttitlechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastTitleChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastTitleChanged + +## -description +Occurs when the value of the [**BroadcastTitle**](appbroadcastbackgroundservice_broadcasttitle.md) property changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_usernamechanged.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_usernamechanged.md new file mode 100644 index 0000000000..9c318c3e89 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_usernamechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.UserNameChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.UserNameChanged + +## -description +Occurs when the [**UserName**](appbroadcastbackgroundservicesignininfo_username.md) property changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_reportproblemwithstream_1401973732.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_reportproblemwithstream_1401973732.md new file mode 100644 index 0000000000..81c82cc1d3 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_reportproblemwithstream_1401973732.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.ReportProblemWithStream +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.ReportProblemWithStream + +## -description +Notifies the system that a problem with the broadcast stream has been detected. + +## -remarks +The may be a problem with the broadcast stream if the [**FrameId**](https://docs.microsoft.com/en-us/uwp/api/windows.media.capture.appbroadcaststreamvideoheader#Windows_Media_Capture_AppBroadcastStreamVideoHeader_FrameId) of an audio or video frame is not an increment of 1 from the previous frame. + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapture_setallowedasync_1887451993.md b/windows.media.capture/appcapture_setallowedasync_1887451993.md new file mode 100644 index 0000000000..1c8f38a4bb --- /dev/null +++ b/windows.media.capture/appcapture_setallowedasync_1887451993.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Capture.AppCapture.SetAllowedAsync(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCapture.SetAllowedAsync + +## -description +Sets a value that specifies whether the app capture is currently allowed for the calling app. + +## -parameters +### -param allowed +True if app capture is allowed; otherwise, false. + +## -returns +An asynchronous action. + +## -remarks +The default value for this property is true, meaning that app capture is allowed. When an app sets this value, the set value does not persist across instances of the app. + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatapriority.md b/windows.media.capture/appcapturemetadatapriority.md new file mode 100644 index 0000000000..9df1c146f2 --- /dev/null +++ b/windows.media.capture/appcapturemetadatapriority.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureMetadataPriority +-api-type: winrt enum +--- + + + +# Windows.Media.Capture.AppCaptureMetadataPriority + +## -description +Specifies the relative importance of an app capture metadata item stored using [**AppCaptureMetadataWriter**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter). When the storage space allotted for accumulated metadata is low, the system will use the priority and age of metadata items to determine the order in which metadata is purged to free storage space. + +## -enum-fields +### -field Informational:0 +The metadata item is of lower importance than **Important** metadata items. + +### -field Important:1 +The metadata item is of higher importance than **Informational** metadata items. + +## -remarks + +## -see-also +[**AppCaptureMetadataWriter**](https://review.docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter) + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter.md b/windows.media.capture/appcapturemetadatawriter.md new file mode 100644 index 0000000000..2bf35ed57b --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureMetadataWriter +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter + +## -description +Enables an app to store metadata that the system will insert into captured video files or broadcast streams of app content. + +## -remarks +When you create an instance of **AppCaptureMetadataWriter**, the system initializes a unique instance for your app and is then ready for you to write metadata items. Although only one app can be capturing or broadcasting at a time, the system can accumulate metadata for multiple apps simultaneously. **AppCaptureMetadataWriter** does not initiate or modify the current capture or broadcast state. + +When you write a metadata item, the system associates a timestamp with the item so that it is automatically included with the captured or broadcast time range to which it applies. + +Currently, two different types of metadata items are supported **AppCaptureMetadataWriter**: events and state. A metadata event is associated with a single point in time and usually is associated with a instantaneous action, such as a player in a game scoring a point. A state is a metadata item that applies across a window of time. An example of this is a state that contains the name of the game map that a player is currently in. Once a state value has been set, the system maintains that value for the state until it is set to a different value, until it is stopped with a call [**StopState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopState_System_String_), or until all states are ended with a call to [**StopAllStates**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopAllStates). Both events and states are represented as a key/value pair where the key is the state or event name and the value is either an integer, a double, or a string value. + +Because historical app capture is supported, the system accumulates metadata written with **AppCaptureMetadataWriter** even when not actively capturing or broadcasting. When, for example, a capture of the previous 30 seconds is written to a video file on disk, the metadata associated with the recorded time window is included in the file. The system imposes a limit on the storage space that is allocated per app for storing accumulated metadata. You can get the currently available storage space by checking the [**RemainingStorageBytesAvailable**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_RemainingStorageBytesAvailable) property. + +When the all of the allotted space has been filled, the system will begin purging metadata using the [**AppCaptureMetadataPriority**](https://review.docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) value, specified when the metadata items were written, and the age of each item in order to delete the oldest, least important data first. When this occurs, the [**MetadataPurged**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_MetadataPurged) event is raised. In response to this event, you may choose to reduce the amount of metadata your app is writing, but this is not required. + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_adddoubleevent_480978549.md b/windows.media.capture/appcapturemetadatawriter_adddoubleevent_480978549.md new file mode 100644 index 0000000000..f19edc7617 --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_adddoubleevent_480978549.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.AddDoubleEvent(System.String,System.Double,Windows.Media.Capture.AppCaptureMetadataPriority) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.AddDoubleEvent + +## -description +Adds a new double metadata event. + +## -parameters +### -param name +The name of the metadata event. + +### -param value +The value of the metadata event. + +### -param priority +A member of the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached. + +## -remarks +The system associates a metadata event with a timestamp when this method is called. To store a double value that applies to a window of time, use [**StartDoubleState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartDoubleState_System_String_System_Double_Windows_Media_Capture_AppCaptureMetadataPriority_). + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_addint32event_1199156294.md b/windows.media.capture/appcapturemetadatawriter_addint32event_1199156294.md new file mode 100644 index 0000000000..115abe3e2c --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_addint32event_1199156294.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.AddInt32Event(System.String,System.Int32,Windows.Media.Capture.AppCaptureMetadataPriority) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.AddInt32Event + +## -description +Adds a new integer metadata event. + +## -parameters +### -param name +The name of the metadata event. + +### -param value +The value of the metadata event. + +### -param priority +A member of the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached. + +## -remarks +The system associates a metadata event with a timestamp when this method is called. To store an integer value that applies to a window of time, use [**StartInt32State**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartInt32State_System_String_System_Int32_Windows_Media_Capture_AppCaptureMetadataPriority_). + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_addstringevent_166366606.md b/windows.media.capture/appcapturemetadatawriter_addstringevent_166366606.md new file mode 100644 index 0000000000..3893c8e07b --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_addstringevent_166366606.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.AddStringEvent(System.String,System.String,Windows.Media.Capture.AppCaptureMetadataPriority) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.AddStringEvent + +## -description +Adds a new string metadata event. + +## -parameters +### -param name +The name of the metadata event. + +### -param value +The value of the metadata event. + +### -param priority +A member of the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached. + +## -remarks +The system associates a metadata event with a timestamp when this method is called. To store a string value that applies to a window of time, use [**StartStringState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartStringState_System_String_System_String_Windows_Media_Capture_AppCaptureMetadataPriority_). + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_appcapturemetadatawriter_1221375020.md b/windows.media.capture/appcapturemetadatawriter_appcapturemetadatawriter_1221375020.md new file mode 100644 index 0000000000..795e09f95d --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_appcapturemetadatawriter_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.AppCaptureMetadataWriter + +## -description +Initializes a new instance of the **AppCaptureMetadataWriter** class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_close_811482585.md b/windows.media.capture/appcapturemetadatawriter_close_811482585.md new file mode 100644 index 0000000000..0e39fefd3d --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_close_811482585.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.Close + +## -description +Disposes of the object and associated resources. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_metadatapurged.md b/windows.media.capture/appcapturemetadatawriter_metadatapurged.md new file mode 100644 index 0000000000..3c00a84755 --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_metadatapurged.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Media.Capture.AppCaptureMetadataWriter.MetadataPurged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.MetadataPurged + +## -description +Occurs when the system purges previously stored metadata items. + +## -remarks +Because historical app capture is supported, the system accumulates metadata written with **AppCaptureMetadataWriter** even when not actively capturing or broadcasting. When, for example, a capture of the previous 30 seconds is written to a video file on disk, the metadata associated with the recorded time window is included in the file. The system imposes a limit on the storage space that is allocated per app for storing accumulated metadata. You can get the currently available storage space by checking the [**RemainingStorageBytesAvailable**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_RemainingStorageBytesAvailable) property. + +When the all of the allotted space has been filled, the system will begin purging metadata using the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) value, specified when the metadata items were written, and the age of each item in order to delete the oldest, least important data first. When this occurs, the [**MetadataPurged**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_MetadataPurged) event is raised. In response to this event, you may choose to reduce the amount of metadata your app is writing, but this is not required. + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_remainingstoragebytesavailable.md b/windows.media.capture/appcapturemetadatawriter_remainingstoragebytesavailable.md new file mode 100644 index 0000000000..50168cb7c0 --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_remainingstoragebytesavailable.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureMetadataWriter.RemainingStorageBytesAvailable +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.RemainingStorageBytesAvailable + +## -description +Gets the number of bytes remaining in the storage space allocated by the system for app capture metadata items. + +## -property-value +The number of bytes remaining for metadata storage. + +## -remarks +Because historical app capture is supported, the system accumulates metadata written with **AppCaptureMetadataWriter** even when not actively capturing or broadcasting. When, for example, a capture of the previous 30 seconds is written to a video file on disk, the metadata associated with the recorded time window is included in the file. The system imposes a limit on the storage space that is allocated per app for storing accumulated metadata. You can get the currently available storage space by checking the [**RemainingStorageBytesAvailable**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_RemainingStorageBytesAvailable) property. + +When the all of the allotted space has been filled, the system will begin purging metadata using the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) value, specified when the metadata items were written, and the age of each item in order to delete the oldest, least important data first. When this occurs, the [**MetadataPurged**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_MetadataPurged) event is raised. In response to this event, you may choose to reduce the amount of metadata your app is writing, but this is not required. + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_startdoublestate_1395425894.md b/windows.media.capture/appcapturemetadatawriter_startdoublestate_1395425894.md new file mode 100644 index 0000000000..cd5970e98c --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_startdoublestate_1395425894.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.StartDoubleState(System.String,System.Double,Windows.Media.Capture.AppCaptureMetadataPriority) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.StartDoubleState + +## -description +Adds a new double metadata state. + +## -parameters +### -param name +The name of the metadata state. + +### -param value +The value of the metadata state. + +### -param priority +A member of the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached. + +## -remarks +The system associates a metadata state with the window of time between when the state is started and when it's value is changed or the state is stopped with a call to [**StopAllStates**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopAllStates). To store a double value that applies to an instantaneous moment in time, use [**AddDoubleEvent**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_AddDoubleEvent_System_String_System_Double_Windows_Media_Capture_AppCaptureMetadataPriority_). + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_startint32state_1155433360.md b/windows.media.capture/appcapturemetadatawriter_startint32state_1155433360.md new file mode 100644 index 0000000000..4781a2159b --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_startint32state_1155433360.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.StartInt32State(System.String,System.Int32,Windows.Media.Capture.AppCaptureMetadataPriority) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.StartInt32State + +## -description +Adds a new double metadata state. + +## -parameters +### -param name +The name of the metadata state. + +### -param value +The value of the metadata state. + +### -param priority +A member of the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached. + +## -remarks +The system associates a metadata state with the window of time between when the state is started and when it's value is changed or the state is stopped with a call to [**StopAllStates**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopAllStates). To store a integer value that applies to an instantaneous moment in time, use [**AddInt32Event**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_AddInt32Event_System_String_System_Int32_Windows_Media_Capture_AppCaptureMetadataPriority_). + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_startstringstate_130051350.md b/windows.media.capture/appcapturemetadatawriter_startstringstate_130051350.md new file mode 100644 index 0000000000..b2b36b715c --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_startstringstate_130051350.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.StartStringState(System.String,System.String,Windows.Media.Capture.AppCaptureMetadataPriority) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.StartStringState + +## -description +Adds a new double metadata state. + +## -parameters +### -param name +The name of the metadata state. + +### -param value +The value of the metadata state. + +### -param priority +A member of the [**AppCaptureMetadataPriority**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatapriority) enumeration specifying the relative importance of the metadata item. This value and the age of a metadata item are used by the system to determine which metadata items should be purged first when the limit of the allocated storage space for accumulated metadata is reached. + +## -remarks +The system associates a metadata state with the window of time between when the state is started and when it's value is changed or the state is stopped with a call to [**StopAllStates**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopAllStates). To store a string value that applies to an instantaneous moment in time, use [**AddStringEvent**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_AddStringEvent_System_String_System_String_Windows_Media_Capture_AppCaptureMetadataPriority_). + +## -see-also + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_stopallstates_138985996.md b/windows.media.capture/appcapturemetadatawriter_stopallstates_138985996.md new file mode 100644 index 0000000000..f6cf3b5bf1 --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_stopallstates_138985996.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.StopAllStates +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.StopAllStates + +## -description +Stops all metadata states. + +## -remarks +Start a metadata state by calling [**StartDoubleState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartDoubleState_System_String_System_Double_Windows_Media_Capture_AppCaptureMetadataPriority_), [**StartInt32State**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartInt32State_System_String_System_Int32_Windows_Media_Capture_AppCaptureMetadataPriority_), or [**StartStringState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartStringState_System_String_System_String_Windows_Media_Capture_AppCaptureMetadataPriority_). Stop a single state by calling [**StopState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopState_System_String_). + +## -see-also +[**StopState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopState_System_String_) +[**StartDoubleState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartDoubleState_System_String_System_Double_Windows_Media_Capture_AppCaptureMetadataPriority_) +[**StartInt32State**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartInt32State_System_String_System_Int32_Windows_Media_Capture_AppCaptureMetadataPriority_) +[**StartStringState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartStringState_System_String_System_String_Windows_Media_Capture_AppCaptureMetadataPriority_) + +## -examples + diff --git a/windows.media.capture/appcapturemetadatawriter_stopstate_317994205.md b/windows.media.capture/appcapturemetadatawriter_stopstate_317994205.md new file mode 100644 index 0000000000..014b4f1b72 --- /dev/null +++ b/windows.media.capture/appcapturemetadatawriter_stopstate_317994205.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureMetadataWriter.StopState(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureMetadataWriter.StopState + +## -description +Stops the metadata state with the specified identifier. + +## -parameters +### -param name +The identifier of the state to be stopped. + +## -remarks +Start a metadata state by calling [**StartDoubleState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartDoubleState_System_String_System_Double_Windows_Media_Capture_AppCaptureMetadataPriority_), [**StartInt32State**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartInt32State_System_String_System_Int32_Windows_Media_Capture_AppCaptureMetadataPriority_), or [**StartStringState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartStringState_System_String_System_String_Windows_Media_Capture_AppCaptureMetadataPriority_), specifying the state identifier that you can later pass into [**StopState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopState_System_String_). Stop all states with a single call to [**StopAllStates**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopAllStates). + +## -see-also +[**StopAllStates**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StopAllStates) +[**StartDoubleState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartDoubleState_System_String_System_Double_Windows_Media_Capture_AppCaptureMetadataPriority_) +[**StartInt32State**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartInt32State_System_String_System_Int32_Windows_Media_Capture_AppCaptureMetadataPriority_) +[**StartStringState**](https://docs.microsoft.com/uwp/api/windows.media.capture.appcapturemetadatawriter#Windows_Media_Capture_AppCaptureMetadataWriter_StartStringState_System_String_System_String_Windows_Media_Capture_AppCaptureMetadataPriority_) + +## -examples + diff --git a/windows.media.capture/gamebartargetcapturepolicy.md b/windows.media.capture/gamebartargetcapturepolicy.md index 5ee3824fe1..0eef8da8d5 100644 --- a/windows.media.capture/gamebartargetcapturepolicy.md +++ b/windows.media.capture/gamebartargetcapturepolicy.md @@ -16,18 +16,24 @@ public enum GameBarTargetCapturePolicy : int { # Windows.Media.Capture.GameBarTargetCapturePolicy ## -description +Provides information around the allowable actions for this application. ## -enum-fields ## -field ProhibitedBySystem:3 +The OS determined that the target is prohibited from being captured. ## -field ProhibitedByPublisher:4 +The publisher of the target has indicated that capture is not allowed. ## -field NotEnabled:2 +The OS doesn’t know the policy for the app and hasn’t been identified by the user as capturable. ## -field EnabledByUser:1 +The OS does not know the policy for the app, but the user did identify the target as capturable. ## -field EnabledBySystem:0 +The OS determined that the target allows capture ## -remarks diff --git a/windows.media.core/audiostreamdescriptor_label.md b/windows.media.core/audiostreamdescriptor_label.md new file mode 100644 index 0000000000..7eeb796dae --- /dev/null +++ b/windows.media.core/audiostreamdescriptor_label.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.AudioStreamDescriptor.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.AudioStreamDescriptor.Label + +## -description +Gets or sets an app-defined label that identifies an audio stream in a [**MediaEncodingProfile**](https://docs.microsoft.com/uwp/api/Windows.Media.MediaProperties.MediaEncodingProfile) that contains multiple streams. + +## -property-value +An app-defined label that identifies an audio stream + +## -remarks +The label for each stream in a single **MediaEncodingProfile** must be unique. Calling [**SetAudioTracks**](https://docs.microsoft.com/uwp/api/windows.media.mediaproperties.mediaencodingprofile#Windows_Media_MediaProperties_MediaEncodingProfile_SetAudioTracks_Windows_Foundation_Collections_IIterable_Windows_Media_Core_AudioStreamDescriptor__) to add a stream descriptor containing a duplicate label will result in an invalid argument error. + +## -see-also + +## -examples + diff --git a/windows.media.core/imediastreamdescriptor.md b/windows.media.core/imediastreamdescriptor.md index d4e07ccf5d..984d014680 100644 --- a/windows.media.core/imediastreamdescriptor.md +++ b/windows.media.core/imediastreamdescriptor.md @@ -10,7 +10,7 @@ public interface IMediaStreamDescriptor : # Windows.Media.Core.IMediaStreamDescriptor ## -description -Defines a media stream. +Defines an interface implemented by a audio or video stream descriptor. ## -remarks diff --git a/windows.media.core/imediastreamdescriptor2.md b/windows.media.core/imediastreamdescriptor2.md new file mode 100644 index 0000000000..c8d0a73f18 --- /dev/null +++ b/windows.media.core/imediastreamdescriptor2.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Core.IMediaStreamDescriptor2 +-api-type: winrt interface +--- + + + +# Windows.Media.Core.IMediaStreamDescriptor2 + +## -description +Defines an interface implemented by a audio or video stream descriptor. + +## -remarks +[AudioStreamDescriptor](audiostreamdescriptor.md), [VideoStreamDescriptor](videostreamdescriptor.md) + +## -see-also + +## -examples + diff --git a/windows.media.core/imediastreamdescriptor2_label.md b/windows.media.core/imediastreamdescriptor2_label.md new file mode 100644 index 0000000000..7d81359615 --- /dev/null +++ b/windows.media.core/imediastreamdescriptor2_label.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.IMediaStreamDescriptor2.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.IMediaStreamDescriptor2.Label + +## -description +Gets or sets an app-defined label that identifies a stream in a [**MediaEncodingProfile**](https://docs.microsoft.com/uwp/api/Windows.Media.MediaProperties.MediaEncodingProfile) that contains multiple streams. + +## -property-value +An app-defined label that identifies a stream. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/initializemediastreamsourcerequestedeventargs.md b/windows.media.core/initializemediastreamsourcerequestedeventargs.md new file mode 100644 index 0000000000..801cd4d019 --- /dev/null +++ b/windows.media.core/initializemediastreamsourcerequestedeventargs.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs + +## -description +Provides data for the [**InitializeMediaStreamSourceRequested**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_InitializeMediaStreamSourceRequested) event. + +## -remarks +Get an instance of this class by registering a handler for the [**InitializeMediaStreamSourceRequested**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_InitializeMediaStreamSourceRequested) event. + +## -see-also +[**InitializeMediaStreamSourceRequested**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_InitializeMediaStreamSourceRequested) + +## -examples + diff --git a/windows.media.core/initializemediastreamsourcerequestedeventargs_getdeferral_254836512.md b/windows.media.core/initializemediastreamsourcerequestedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..d37d8b60f8 --- /dev/null +++ b/windows.media.core/initializemediastreamsourcerequestedeventargs_getdeferral_254836512.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs.GetDeferral + +## -description +Gets a [**Deferral**](https://docs.microsoft.com/en-us/uwp/api/windows.foundation.deferral) object that instructs the system to wait for the app service to complete media source stream initialization before continuing processing the request. + +## -returns +A **Deferral** object. + +## -remarks +You must request a deferral if your stream source initialization perfoms any asynchronous actions. Call [**Complete**](https://docs.microsoft.com/uwp/api/windows.foundation.deferral#Windows_Foundation_Deferral_Complete) when intitialization is complete to notify the system to continue processing the request. + +## -see-also + +## -examples + diff --git a/windows.media.core/initializemediastreamsourcerequestedeventargs_randomaccessstream.md b/windows.media.core/initializemediastreamsourcerequestedeventargs_randomaccessstream.md new file mode 100644 index 0000000000..285363beea --- /dev/null +++ b/windows.media.core/initializemediastreamsourcerequestedeventargs_randomaccessstream.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs.RandomAccessStream +-api-type: winrt property +--- + + + +# Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs.RandomAccessStream + +## -description +Gets the [**IRandomAccessStream**](https://docs.microsoft.com/uwp/api/windows.storage.streams.irandomaccessstream) associated with the media stream source request. + +## -property-value +The **IRandomAccessStream** associated with the media stream source request. + +## -remarks +The app service should parse the **IRandomAccessStream** to create an [**IMediaStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.imediastreamdescriptor). If the requested stream format is supported, then the app service can initialize the [**MediaStreamSource**](https://docs.microsoft.com/en-us/uwp/api/windows.media.core.mediastreamsource) provided in the event args and begin providing samples. + +## -see-also + +## -examples + diff --git a/windows.media.core/initializemediastreamsourcerequestedeventargs_source.md b/windows.media.core/initializemediastreamsourcerequestedeventargs_source.md new file mode 100644 index 0000000000..52afc76017 --- /dev/null +++ b/windows.media.core/initializemediastreamsourcerequestedeventargs_source.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs.Source +-api-type: winrt property +--- + + + +# Windows.Media.Core.InitializeMediaStreamSourceRequestedEventArgs.Source + +## -description +Gets the uninitialized [**MediaStreamSource**](https://docs.microsoft.com/uwp/api/windows.media.core.mediastreamsource) object that the app service should initialize and use to provide samples to the requesting app. + +## -property-value +The uninitialized **MediaStreamSource** object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/lowlightfusion.md b/windows.media.core/lowlightfusion.md new file mode 100644 index 0000000000..2c6567ce7c --- /dev/null +++ b/windows.media.core/lowlightfusion.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Core.LowLightFusion +-api-type: winrt class +--- + + + +# Windows.Media.Core.LowLightFusion + +## -description +This class allows you to submit a set of image frames, captured in low-light settings and in close temporal proximity, and receieve a single image that has been processed to improve image lighting and fidelity. + +## -remarks +This class implements the same computational photography algorithms as the [**AdvancedPhotoCapture**](https://docs.microsoft.com/uwp/api/windows.media.capture.advancedphotocapture) class when used in low-light mode. The difference between this feature and **AdvancedPhotoCapture** is that because this feature is decoupled from the capture pipeline, you can use it on images that were captured at any time and in any manner, as long as the image format is supported. Supported formats can be determined by checking the [**SupportedBitmapPixelFormats**](https://docs.microsoft.com/uwp/api/windows.media.core.lowlightfusion#Windows_Media_Core_LowLightFusion_SupportedBitmapPixelFormats) property. + + +## -see-also +[**AdvancedPhotoCapture**](https://docs.microsoft.com/uwp/api/windows.media.capture.advancedphotocapture) +[**High dynamic range (HDR) and low-light photo capture**](https://docs.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture#low-light-photo-capture) + +## -examples + diff --git a/windows.media.core/lowlightfusion_fuseasync_1416746629.md b/windows.media.core/lowlightfusion_fuseasync_1416746629.md new file mode 100644 index 0000000000..a41bd9cfcf --- /dev/null +++ b/windows.media.core/lowlightfusion_fuseasync_1416746629.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Media.Core.LowLightFusion.FuseAsync(Windows.Foundation.Collections.IIterable{Windows.Graphics.Imaging.SoftwareBitmap}) +-api-type: winrt method +--- + + + +# Windows.Media.Core.LowLightFusion.FuseAsync + +## -description +Asynchronously fuses a set of images into a single image that has been computed to improve image lighting and fidelity. + +## -parameters +### -param frameSet +The collection of image frames to be processed. + +## -returns +An asynchronous operation that returns a **LowLightFusionResult** upon successful completion. The app should call **Close** on the returned object to free up the allocated resources. + +## -remarks +This method will return in an error in the following cases: + +* The number of images in the provided collection exceeds the specified by **MaxSupportedFrameCount** property. +* The images in the provided collection have different pixel formats. +* The images in the provided collection have different resolutions. +* The images in the provided collection are in an unsupported pixel format. Supported formats can be determined by checking the **SupportedBitmapPixelFormats** property. + +## -see-also + +## -examples + diff --git a/windows.media.core/lowlightfusion_maxsupportedframecount.md b/windows.media.core/lowlightfusion_maxsupportedframecount.md new file mode 100644 index 0000000000..e8cef496fd --- /dev/null +++ b/windows.media.core/lowlightfusion_maxsupportedframecount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.LowLightFusion.MaxSupportedFrameCount +-api-type: winrt property +--- + + + +# Windows.Media.Core.LowLightFusion.MaxSupportedFrameCount + +## -description +Gets the maximum number of frames that can be submitted to the **FuseAsync** method. + +## -property-value +The maximum number of frames that can be submitted to the **FuseAsync** method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/lowlightfusion_supportedbitmappixelformats.md b/windows.media.core/lowlightfusion_supportedbitmappixelformats.md new file mode 100644 index 0000000000..6d282d995f --- /dev/null +++ b/windows.media.core/lowlightfusion_supportedbitmappixelformats.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.LowLightFusion.SupportedBitmapPixelFormats +-api-type: winrt property +--- + + + +# Windows.Media.Core.LowLightFusion.SupportedBitmapPixelFormats + +## -description +Gets a list of [**BitmapPixelFormat**](https://docs.microsoft.com/uwp/api/windows.graphics.imaging.bitmappixelformat) values that define the supported pixel formats for the **FuseAsync** method. + +## -property-value +A list of supported pixel formats. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/lowlightfusionresult.md b/windows.media.core/lowlightfusionresult.md new file mode 100644 index 0000000000..e01715db8f --- /dev/null +++ b/windows.media.core/lowlightfusionresult.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Core.LowLightFusionResult +-api-type: winrt class +--- + + + +# Windows.Media.Core.LowLightFusionResult + +## -description +Represents the result of a low-light fusion operation initiated with a call to **FuseAsync**. + +## -remarks +Apps should call the **Close** method to clean up the resources allocated for this object. + +## -see-also + +## -examples + diff --git a/windows.media.core/lowlightfusionresult_close_811482585.md b/windows.media.core/lowlightfusionresult_close_811482585.md new file mode 100644 index 0000000000..7965eec7df --- /dev/null +++ b/windows.media.core/lowlightfusionresult_close_811482585.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Media.Core.LowLightFusionResult.Close +-api-type: winrt method +--- + + + +# Windows.Media.Core.LowLightFusionResult.Close + +## -description +Disposes of the object and associated resources. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/lowlightfusionresult_frame.md b/windows.media.core/lowlightfusionresult_frame.md new file mode 100644 index 0000000000..deee4c378f --- /dev/null +++ b/windows.media.core/lowlightfusionresult_frame.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.LowLightFusionResult.Frame +-api-type: winrt property +--- + + + +# Windows.Media.Core.LowLightFusionResult.Frame + +## -description +Gets the image containing the processed result of the low-light fusion operation. + +## -property-value +The image containing the processed result of the low-light fusion operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md b/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md index e8f695030e..9b214ec491 100644 --- a/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md +++ b/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md @@ -10,9 +10,9 @@ public void MediaBindingEventArgs.SetStorageFile(IStorageFile file) # Windows.Media.Core.MediaBindingEventArgs.SetStorageFile ## -description +Binds a storage file to the [MediaSource](mediasource.md) associated with the event. ## -params -Binds a storage file to the [MediaSource](mediasource.md) associated with the event. ## -param file The [StorageFile](../windows.storage/storagefile.md) containing media content. diff --git a/windows.media.core/mediasource_createfrommediaframesource_133163902.md b/windows.media.core/mediasource_createfrommediaframesource_133163902.md new file mode 100644 index 0000000000..40caaa5395 --- /dev/null +++ b/windows.media.core/mediasource_createfrommediaframesource_133163902.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Media.Core.MediaSource.CreateFromMediaFrameSource(Windows.Media.Capture.Frames.MediaFrameSource) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.CreateFromMediaFrameSource + +## -description +Creates an instance of [MediaSource](mediasource.md) from the provided [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md). + + +## -parameters +### -param frameSource +The [AdaptiveMediaSource](../windows.media.streaming.adaptive/adaptivemediasource.md) from which the [MediaSource](mediasource.md) is created. + +## -returns +The new media source. + +## -remarks +For more information on using media frame sources, see [Process media frames with MediaFrameReader](https://docs.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasourceappserviceconnection.md b/windows.media.core/mediasourceappserviceconnection.md new file mode 100644 index 0000000000..16a28ef452 --- /dev/null +++ b/windows.media.core/mediasourceappserviceconnection.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Media.Core.MediaSourceAppServiceConnection +-api-type: winrt class +--- + + + +# Windows.Media.Core.MediaSourceAppServiceConnection + +## -description +Enables the implementation of an app service that provides a custom media source that can be consumed by UWP apps. + +## -remarks +This feature must be implemented in a background task. When the background task is launched and the [**Run**](https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Background.IBackgroundTask#Windows_ApplicationModel_Background_IBackgroundTask_Run_Windows_ApplicationModel_Background_IBackgroundTaskInstance_), the app should create a new instance of this class, register a handler for the [**InitializeMediaStreamSourceRequested**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_InitializeMediaStreamSourceRequested) event, and call [**Start**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_Start) to notify the system that the app service is ready to handle stream source requests. + +The system passes an [**IRandomAccessStream**](https://docs.microsoft.com/uwp/api/windows.storage.streams.irandomaccessstream) and an a uninitialized [**MediaStreamSource**](https://docs.microsoft.com/uwp/api/windows.media.core.mediastreamsource) object into the **InitializeMediaStreamSourceRequested** event handler. The app service should parse the **IRandomAccessStream** to create an [**IMediaStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.imediastreamdescriptor). If the requested stream format is supported, then the app service can initialize the **MediaStreamSource** and begin providing samples. + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasourceappserviceconnection_initializemediastreamsourcerequested.md b/windows.media.core/mediasourceappserviceconnection_initializemediastreamsourcerequested.md new file mode 100644 index 0000000000..27d92e33cc --- /dev/null +++ b/windows.media.core/mediasourceappserviceconnection_initializemediastreamsourcerequested.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Core.MediaSourceAppServiceConnection.InitializeMediaStreamSourceRequested +-api-type: winrt event +--- + + + +# Windows.Media.Core.MediaSourceAppServiceConnection.InitializeMediaStreamSourceRequested + +## -description +Raised by the system to request the initialization of a new [**MediaStreamSource**](https://docs.microsoft.com/uwp/api/windows.media.core.mediastreamsource). + +## -remarks +After registering a handler for the **InitializeMediaStreamSourceRequestedEventArgs**, call [**Start**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_Start) to notify the system that the the app service is ready to handle requests. + +With the [**InitializeMediaStreamSourceRequestedEventArgs**](https://docs.microsoft.com/en-us/uwp/api/windows.media.core.initializemediastreamsourcerequestedeventargs) object, the system passes an [**IRandomAccessStream**](https://docs.microsoft.com/uwp/api/windows.storage.streams.irandomaccessstream) and an a uninitialized [**MediaStreamSource**](https://docs.microsoft.com/uwp/api/windows.media.core.mediastreamsource) object into the **InitializeMediaStreamSourceRequested** event handler. The app service should parse the **IRandomAccessStream** to create an [**IMediaStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.imediastreamdescriptor). If the requested stream format is supported, then the app service can initialize the **MediaStreamSource** and begin providing samples. + + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasourceappserviceconnection_mediasourceappserviceconnection_340106167.md b/windows.media.core/mediasourceappserviceconnection_mediasourceappserviceconnection_340106167.md new file mode 100644 index 0000000000..92b7a5054e --- /dev/null +++ b/windows.media.core/mediasourceappserviceconnection_mediasourceappserviceconnection_340106167.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Core.MediaSourceAppServiceConnection.#ctor(Windows.ApplicationModel.AppService.AppServiceConnection) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSourceAppServiceConnection.MediaSourceAppServiceConnection + +## -description +Initializes a new instance of the **MediaSourceAppServiceConnection** class. + +## -parameters +### -param appServiceConnection +An [**AppServiceConnection**](https://docs.microsoft.com/uwp/api/windows.applicationmodel.appservice.appserviceconnection) object representing the connection to the endpoint for an app service. + +## -remarks +Get an instance of the **AppServiceConnection** class by casting the [**TriggerDetails**](https://docs.microsoft.com/uwp/api/windows.applicationmodel.background.ibackgroundtaskinstance#Windows_ApplicationModel_Background_IBackgroundTaskInstance_TriggerDetails) property of the [**IBackgroundTaskInstance**](https://docs.microsoft.com/uwp/api/windows.applicationmodel.background.ibackgroundtaskinstance) object passed into the background task's [**Run**](https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Background.IBackgroundTask#Windows_ApplicationModel_Background_IBackgroundTask_Run_Windows_ApplicationModel_Background_IBackgroundTaskInstance_) method to an [**AppServiceTriggerDetails**](https://docs.microsoft.com/uwp/api/windows.applicationmodel.appservice.appservicetriggerdetails) object and then accessing the [**AppServiceConnection**](https://docs.microsoft.com/uwp/api/windows.applicationmodel.appservice.appservicetriggerdetails#Windows_ApplicationModel_AppService_AppServiceTriggerDetails_AppServiceConnection) property. + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasourceappserviceconnection_start_1587696324.md b/windows.media.core/mediasourceappserviceconnection_start_1587696324.md new file mode 100644 index 0000000000..1a45578720 --- /dev/null +++ b/windows.media.core/mediasourceappserviceconnection_start_1587696324.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Media.Core.MediaSourceAppServiceConnection.Start +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSourceAppServiceConnection.Start + +## -description +Notifies the system that the app service is ready to receive media stream source requests. + +## -remarks +Register for the [**InitializeMediaStreamSourceRequested**](https://docs.microsoft.com/uwp/api/windows.media.core.mediasourceappserviceconnection#Windows_Media_Core_MediaSourceAppServiceConnection_InitializeMediaStreamSourceRequested) event handler before calling **Start**. + +## -see-also + +## -examples + diff --git a/windows.media.core/sceneanalysiseffectframe_analysisrecommendation.md b/windows.media.core/sceneanalysiseffectframe_analysisrecommendation.md new file mode 100644 index 0000000000..3c815b4c80 --- /dev/null +++ b/windows.media.core/sceneanalysiseffectframe_analysisrecommendation.md @@ -0,0 +1,34 @@ +--- +-api-id: P:Windows.Media.Core.SceneAnalysisEffectFrame.AnalysisRecommendation +-api-type: winrt property +--- + + + +# Windows.Media.Core.SceneAnalysisEffectFrame.AnalysisRecommendation + +## -description +Gets a value that specifies the recommended image processing to improve image quality and fidelity of captured images based on the current capture conditions. + +## -property-value +A value from that specifies the recommended image processing. + +## -remarks +If the effect recommends using HDR, you can do this in the following ways: + +* Use the [**AdvancedPhotoCapture**](https://docs.microsoft.com/uwp/api/Windows.Media.Capture.AdvancedPhotoCapture) class to capture photos using the Windows built-in HDR processing algorithm. For more information, see [High Dynamic Range (HDR) and low-light photo capture](https://docs.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). +* Use the [**HdrVideoControl**](https://docs.microsoft.com/uwp/api/Windows.Media.Devices.HdrVideoControl) to capture video using the Windows built-in HDR processing algorithm. For more information, see [**Capture device controls for video capture**](https://docs.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture). +* Use [**VariablePhotoSequenceCapture**](https://docs.microsoft.com/uwp/api/Windows.Media.Capture.Core.VariablePhotoSequenceCapture) to capture a sequence of frames that you can then composite using a custom HDR implementation. For more information, see [**Variable photo sequence**](https://docs.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence). + +If the effect recomends low-light processing, you can implement this in the following ways: + +* Use the [**AdvancedPhotoCapture**](https://docs.microsoft.com/uwp/api/Windows.Media.Capture.AdvancedPhotoCapture) class to capture photos using the Windows built-in low-light processing algorithm. For more information, see [High Dynamic Range (HDR) and low-light photo capture](https://docs.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +* Use the [**LowLightFusion**](https://docs.microsoft.com/uwp/api/windows.media.core.lowlightfusion) class to use the Windows built-in low-light processing algorithm on images that you capture without using **AdvancedPhotoCapture**. + +## -see-also + +## -examples + diff --git a/windows.media.core/sceneanalysisrecommendation.md b/windows.media.core/sceneanalysisrecommendation.md new file mode 100644 index 0000000000..c74ae3f505 --- /dev/null +++ b/windows.media.core/sceneanalysisrecommendation.md @@ -0,0 +1,43 @@ +--- +-api-id: T:Windows.Media.Core.SceneAnalysisRecommendation +-api-type: winrt enum +--- + + + +# Windows.Media.Core.SceneAnalysisRecommendation + +## -description +Specifies the recommended image processing to improve image quality and fidelity of captured images based on the current capture conditions, as determined by the [**SceneAnalysisEffect**](https://docs.microsoft.com/en-us/uwp/api/windows.media.core.sceneanalysiseffect). + +## -enum-fields +### -field Standard:0 +No image processing is recommended. + +### -field LowLight:2 +Low-light processing is recommended. + +### -field Hdr:1 +High Dynamic Range (HDR) processing is recommended. + +## -remarks +Get a value from this enumeration by implementing the **SceneAnalysisEffect**, registering a handler for the [**SceneAnalyzed**](https://docs.microsoft.com/uwp/api/windows.media.core.sceneanalysiseffect#Windows_Media_Core_SceneAnalysisEffect_SceneAnalyzed) event, and then checking the [**AnalysisRecommendation**](https://docs.microsoft.com/uwp/api/windows.media.core.sceneanalysiseffectframe#Windows_Media_Core_SceneAnalysisEffectFrame_AnalysisRecommendation) property of the [**SceneAnalysisEffectFrame**](https://docs.microsoft.com/uwp/api/windows.media.core.sceneanalysiseffectframe) passed in the event args. For more information on using the **SceneAnalysisEffect**, see [Scene anlysis for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/scene-analysis-for-media-capture). + +If the effect recommends using HDR, you can do this in the following ways: + +* Use the [**AdvancedPhotoCapture**](https://docs.microsoft.com/uwp/api/Windows.Media.Capture.AdvancedPhotoCapture) class to capture photos using the Windows built-in HDR processing algorithm. For more information, see [High Dynamic Range (HDR) and low-light photo capture](https://docs.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). +* Use the [**HdrVideoControl**](https://docs.microsoft.com/uwp/api/Windows.Media.Devices.HdrVideoControl) to capture video using the Windows built-in HDR processing algorithm. For more information, see [**Capture device controls for video capture**](https://docs.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-video-capture). +* Use [**VariablePhotoSequenceCapture**](https://docs.microsoft.com/uwp/api/Windows.Media.Capture.Core.VariablePhotoSequenceCapture) to capture a sequence of frames that you can then composite using a custom HDR implementation. For more information, see [**Variable photo sequence**](https://docs.microsoft.com/en-us/windows/uwp/audio-video-camera/variable-photo-sequence). + +If the effect recomends low-light processing, you can implement this in the following ways: + +* Use the [**AdvancedPhotoCapture**](https://docs.microsoft.com/uwp/api/Windows.Media.Capture.AdvancedPhotoCapture) class to capture photos using the Windows built-in low-light processing algorithm. For more information, see [High Dynamic Range (HDR) and low-light photo capture](https://docs.microsoft.com/windows/uwp/audio-video-camera/high-dynamic-range-hdr-photo-capture). + +* Use the [**LowLightFusion**](https://docs.microsoft.com/uwp/api/windows.media.core.lowlightfusion) class to use the Windows built-in low-light processing algorithm on images that you capture without using **AdvancedPhotoCapture**. + +## -see-also + +## -examples + diff --git a/windows.media.core/videostreamdescriptor_label.md b/windows.media.core/videostreamdescriptor_label.md new file mode 100644 index 0000000000..895f0ae6e2 --- /dev/null +++ b/windows.media.core/videostreamdescriptor_label.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Core.VideoStreamDescriptor.Label +-api-type: winrt property +--- + + + +# Windows.Media.Core.VideoStreamDescriptor.Label + +## -description +Gets or sets an app-defined label that identifies a video stream in a [**MediaEncodingProfile**](https://docs.microsoft.com/uwp/api/Windows.Media.MediaProperties.MediaEncodingProfile) that contains multiple streams. + +## -property-value +An app-defined label that identifies a video stream. + +## -remarks +The label for each stream in a single **MediaEncodingProfile** must be unique. Calling [**SetVideoTracks**](https://docs.microsoft.com/uwp/api/windows.media.mediaproperties.mediaencodingprofile#Windows_Media_MediaProperties_MediaEncodingProfile_SetVideoTracks_Windows_Foundation_Collections_IIterable_Windows_Media_Core_VideoStreamDescriptor__) to add a stream descriptor containing a duplicate label will result in an invalid argument error. + +If you use a [**MediaFrameSourceGroup**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframesourcegroup) to capture multiple video streams at once, the system will attempt to match the **Label** property of each **VideoStreamDescriptor** with the [**Id**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframesourceinfo#Windows_Media_Capture_Frames_MediaFrameSourceInfo_Id) property of each [**Media​Frame​Source​Info**](https://docs.microsoft.com/uwp/api/windows.media.capture.frames.mediaframesourceinfo) in the group in order to match the capture device with the approproate stream descriptor. + +## -see-also + +## -examples + diff --git a/windows.media.dialprotocol/dialapp_appname.md b/windows.media.dialprotocol/dialapp_appname.md index 12b7cceeda..53a93c0d64 100644 --- a/windows.media.dialprotocol/dialapp_appname.md +++ b/windows.media.dialprotocol/dialapp_appname.md @@ -11,7 +11,7 @@ public string AppName { get; } # Windows.Media.DialProtocol.DialApp.AppName ## -description -Gets the applications registered DIAL name. +Gets the application's registered DIAL name. ## -property-value The DIAL name. diff --git a/windows.media.dialprotocol/dialreceiverapp.md b/windows.media.dialprotocol/dialreceiverapp.md new file mode 100644 index 0000000000..3ee1c4c43c --- /dev/null +++ b/windows.media.dialprotocol/dialreceiverapp.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.DialProtocol.DialReceiverApp +-api-type: winrt class +--- + + + +# Windows.Media.DialProtocol.DialReceiverApp + +## -description +Provides a mechanism for server apps to supply requested data to the DIAL REST service, which can be queried by client apps. + +## -remarks +Get an instance of this class by accessing the **Current** property. + +## -see-also + +## -examples + diff --git a/windows.media.dialprotocol/dialreceiverapp_current.md b/windows.media.dialprotocol/dialreceiverapp_current.md new file mode 100644 index 0000000000..b851ccc4ff --- /dev/null +++ b/windows.media.dialprotocol/dialreceiverapp_current.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.DialProtocol.DialReceiverApp.Current +-api-type: winrt property +--- + + + +# Windows.Media.DialProtocol.DialReceiverApp.Current + +## -description +Gets an instance of the **DialReceiverApp** class. + +## -property-value +An instance of the **DialReceiverApp** class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.dialprotocol/dialreceiverapp_getadditionaldataasync_932526591.md b/windows.media.dialprotocol/dialreceiverapp_getadditionaldataasync_932526591.md new file mode 100644 index 0000000000..1108c0f08c --- /dev/null +++ b/windows.media.dialprotocol/dialreceiverapp_getadditionaldataasync_932526591.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.DialProtocol.DialReceiverApp.GetAdditionalDataAsync +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialReceiverApp.GetAdditionalDataAsync + +## -description +Retrives the a map of key/value pairs representing the data previously set with [**SetAdditionalDataAsync**](https://docs.microsoft.com/uwp/api/windows.media.dialprotocol.dialreceiverapp#Windows_Media_DialProtocol_DialReceiverApp_SetAdditionalDataAsync_Windows_Foundation_Collections_IIterable_Windows_Foundation_Collections_IKeyValuePair_System_String_System_String___). + +## -returns +A map of key/value pairs representing the data previously set with **SetAdditionalDataAsync**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.dialprotocol/dialreceiverapp_setadditionaldataasync_1432279464.md b/windows.media.dialprotocol/dialreceiverapp_setadditionaldataasync_1432279464.md new file mode 100644 index 0000000000..282647014b --- /dev/null +++ b/windows.media.dialprotocol/dialreceiverapp_setadditionaldataasync_1432279464.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.DialProtocol.DialReceiverApp.SetAdditionalDataAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) +-api-type: winrt method +--- + + + +# Windows.Media.DialProtocol.DialReceiverApp.SetAdditionalDataAsync + +## -description +Used by the server app to send a set of data in key/value pairs to the DIAL REST service so that it can be queried from a client app. + +## -parameters +### -param additionalData +The set of key/value pairs to send to the DIAL REST service. + +## -returns +Clients retrieve the additional data by making an HTTP GET request to the DIAL REST service application URL.  UWP client apps can perform this task by calling [**DialDevice.GetDialApp**](https://docs.microsoft.com/uwp/api/windows.media.dialprotocol.dialdevice#Windows_Media_DialProtocol_DialDevice_GetDialApp_System_String_) followed by [**DialApp.GetAppStateAsync**](https://docs.microsoft.com/uwp/api/windows.media.dialprotocol.dialapp#Windows_Media_DialProtocol_DialApp_GetAppStateAsync), and then accessing the [**DialAppStateDetails.FullXml**](https://docs.microsoft.com/uwp/api/windows.media.dialprotocol.dialappstatedetails#Windows_Media_DialProtocol_DialAppStateDetails_FullXml) property to retrieve the additional data.  The additional data is added to the DIAL app XML in accordance with the DIAL specification. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/audioencodingproperties_isspatial.md b/windows.media.mediaproperties/audioencodingproperties_isspatial.md index 8acc855347..aa5627b16f 100644 --- a/windows.media.mediaproperties/audioencodingproperties_isspatial.md +++ b/windows.media.mediaproperties/audioencodingproperties_isspatial.md @@ -8,8 +8,9 @@ public bool IsSpatial { get; } --> # Windows.Media.MediaProperties.AudioEncodingProperties.IsSpatial -Gets a value indicating whether the audio is encoded with spatial audio information. + ## -description +Gets a value indicating whether the audio is encoded with spatial audio information. ## -property-value True if the audio is encoded with spatial audio information; otherwise, false. diff --git a/windows.media.mediaproperties/mediaencodingprofile_getaudiotracks_184901163.md b/windows.media.mediaproperties/mediaencodingprofile_getaudiotracks_184901163.md new file mode 100644 index 0000000000..c05b5a63ee --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_getaudiotracks_184901163.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.GetAudioTracks +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.GetAudioTracks + +## -description +Retrieves the list of [**AudioStreamDescriptor**](https://docs.microsoft.com/uwp/api/Windows.Media.Core.AudioStreamDescriptor) objects describing the audio streams included in the **MediaEncodingProfile**. + +## -returns +A list of [**AudioStreamDescriptor**](https://docs.microsoft.com/uwp/api/Windows.Media.Core.AudioStreamDescriptor) objects. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingprofile_getvideotracks_1199802277.md b/windows.media.mediaproperties/mediaencodingprofile_getvideotracks_1199802277.md new file mode 100644 index 0000000000..c21f6c5b74 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_getvideotracks_1199802277.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.GetVideoTracks +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.GetVideoTracks + +## -description +Retrieves the list of [**VideoStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.videostreamdescriptor) objects describing the video streams included in the **MediaEncodingProfile**. + +## -returns +A list of [**VideoStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.videostreamdescriptor) objects. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingprofile_setaudiotracks_1151007226.md b/windows.media.mediaproperties/mediaencodingprofile_setaudiotracks_1151007226.md new file mode 100644 index 0000000000..bbc17df895 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_setaudiotracks_1151007226.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.SetAudioTracks(Windows.Foundation.Collections.IIterable{Windows.Media.Core.AudioStreamDescriptor}) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.SetAudioTracks + +## -description +Sets the list of [**AudioStreamDescriptor**](https://docs.microsoft.com/uwp/api/Windows.Media.Core.AudioStreamDescriptor) objects describing the audio streams included in the **MediaEncodingProfile**. + +## -parameters +### -param value +A list of [**VideoStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.videostreamdescriptor) objects. + +## -remarks +The [**Label**](https://docs.microsoft.com/uwp/api/windows.media.core.audiostreamdescriptor#Windows_Media_Core_AudioStreamDescriptor_Label) field for each [**AudioStreamDescriptor**](https://docs.microsoft.com/en-us/uwp/api/windows.media.core.audiostreamdescriptor) in the collection must be unique. If you attempt to add more than one stream descriptor with the same label, an invalid argument error will occur. + +If you set the [**Audio**](https://docs.microsoft.com/uwp/api/windows.media.mediaproperties.mediaencodingprofile#Windows_Media_MediaProperties_MediaEncodingProfile_Audio) property, the list of video tracks is reset to a list with a single **AudioStreamDescriptor** entry. If you retrieve the **Audio** property after calling **SetVideoTracks**, the property will return the first entry in the provided list. + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingprofile_setvideotracks_1424215491.md b/windows.media.mediaproperties/mediaencodingprofile_setvideotracks_1424215491.md new file mode 100644 index 0000000000..3a146f1762 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_setvideotracks_1424215491.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.SetVideoTracks(Windows.Foundation.Collections.IIterable{Windows.Media.Core.VideoStreamDescriptor}) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.SetVideoTracks + +## -description +Sets the list of [**VideoStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.videostreamdescriptor) objects describing the video streams included in the **MediaEncodingProfile**. + +## -parameters +### -param value +A collection of [**VideoStreamDescriptor**](https://docs.microsoft.com/uwp/api/windows.media.core.videostreamdescriptor) objects. + +## -remarks +The [**Label**](https://docs.microsoft.com/uwp/api/windows.media.core.videostreamdescriptor#Windows_Media_Core_VideoStreamDescriptor_Label) field for each [**VideoStreamDescriptor**](https://docs.microsoft.com/en-us/uwp/api/windows.media.core.videostreamdescriptor) in the collection must be unique. If you attempt to add more than one stream descriptor with the same label, an invalid argument error will occur. + +If you set the [**Video**](https://docs.microsoft.com/uwp/api/windows.media.mediaproperties.mediaencodingprofile#Windows_Media_MediaProperties_MediaEncodingProfile_Video) property, the list of video tracks is reset to a list with a single **VideoStreamDescriptor** entry. If you retrieve the **Video** property after calling **SetVideoTracks**, the property will return the first entry in the provided list. + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadyencryptionalgorithm.md b/windows.media.protection.playready/playreadyencryptionalgorithm.md index 33f2c89ff4..252cd1d112 100644 --- a/windows.media.protection.playready/playreadyencryptionalgorithm.md +++ b/windows.media.protection.playready/playreadyencryptionalgorithm.md @@ -27,10 +27,10 @@ The encryption method has not been set. ### -field Aes128Cbc:5 - +AES128CBC encryption. ### -field Unspecified:65535 - +The encryption method is unspecified. ## -remarks diff --git a/windows.media.protection.playready/playreadyhardwaredrmfeatures.md b/windows.media.protection.playready/playreadyhardwaredrmfeatures.md index a20290eb47..3f0ca1d5af 100644 --- a/windows.media.protection.playready/playreadyhardwaredrmfeatures.md +++ b/windows.media.protection.playready/playreadyhardwaredrmfeatures.md @@ -21,7 +21,7 @@ Indicates the hardware supports High Efficiency Video Coding (HEVC)/H.265 codec. ### -field Aes128Cbc:3 - +Indicates the hardware supports AES128CBC encryption. ## -remarks diff --git a/windows.media.speechrecognition/speechrecognizer_trysetsystemspeechlanguageasync_178144904.md b/windows.media.speechrecognition/speechrecognizer_trysetsystemspeechlanguageasync_178144904.md new file mode 100644 index 0000000000..4216326eb7 --- /dev/null +++ b/windows.media.speechrecognition/speechrecognizer_trysetsystemspeechlanguageasync_178144904.md @@ -0,0 +1,54 @@ +--- +-api-id: M:Windows.Media.SpeechRecognition.SpeechRecognizer.TrySetSystemSpeechLanguageAsync(Windows.Globalization.Language) +-api-type: winrt method +--- + + + +# Windows.Media.SpeechRecognition.SpeechRecognizer.TrySetSystemSpeechLanguageAsync + +## -description +Asynchronously attempts to set the system language used for speech recognition. + +> [!NOTE] +> This method is available only in [Embedded mode](https://developer.microsoft.com/windows/iot/docs/embeddedmode). + +## -parameters +### -param speechLanguage +The [BCP-47](https://aka.ms/bcp47)-based system language used for speech recognition. + +## -returns +An asynchronous operation that returns true if the set operation was a success. Otherwise, returns false. + +## -remarks + Your app must declare the **systemManagement** capability, which lets apps have basic system administration privileges such as shutting down or rebooting, locale, and timezone. + +The systemManagement capability must include the iot namespace when you declare it in your app's package manifest. + +```xml + +``` + +Use [**SystemSpeechLanguage**](speechrecognizer_systemspeechlanguage.md) to get the current system speech recognition language. + +Use [**Windows.Globalization.Language.IsWellFormed**](https://docs.microsoft.com/en-us/uwp/api/windows.globalization.language#Windows_Globalization_Language_IsWellFormed_System_String_) to validate *speechLanguage*. + +## -see-also +- [**SystemSpeechLanguage**](speechrecognizer_systemspeechlanguage.md) +- [**Windows.Globalization.Language.IsWellFormed**](https://docs.microsoft.com/en-us/uwp/api/windows.globalization.language#Windows_Globalization_Language_IsWellFormed_System_String_) + +### How-to's +- [Embedded mode](https://developer.microsoft.com/windows/iot/docs/embeddedmode) +- [App capability declarations](https://docs.microsoft.com/windows/uwp/packaging/app-capability-declarations) +- [Set speech recognition timeouts](http://msdn.microsoft.com/library/58f446ac-4a56-454d-8125-62a2c4dbfcc8) +- [Speech interactions](http://msdn.microsoft.com/library/646db3ce-fa81-4727-8c21-936c81079439) +- [Speech design guidelines](http://msdn.microsoft.com/library/4a63a8c4-4182-4e36-ba12-4c343a56fca9) + + +### Samples +- [Speech recognition and speech synthesis sample](http://go.microsoft.com/fwlink/p/?LinkID=619897) + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizer_synthesizessmltostreamasync_1873155127.md b/windows.media.speechsynthesis/speechsynthesizer_synthesizessmltostreamasync_1873155127.md index d04d274fda..6ebec97d65 100644 --- a/windows.media.speechsynthesis/speechsynthesizer_synthesizessmltostreamasync_1873155127.md +++ b/windows.media.speechsynthesis/speechsynthesizer_synthesizessmltostreamasync_1873155127.md @@ -10,7 +10,7 @@ public Windows.Foundation.IAsyncOperation SpeechSynthesizer.TrySetDefaultVoiceAsync(VoiceInformation voice) +--> + +# Windows.Media.SpeechSynthesis.SpeechSynthesizer.TrySetDefaultVoiceAsync + +## -description +Asynchronously attempts to set the voice used for speech synthesis. + +> [!NOTE] +> This method is available only in [Embedded mode](https://developer.microsoft.com/windows/iot/docs/embeddedmode). + +## -parameters +### -param voice +One of the installed speech synthesis engines (voices). + +## -returns +An asynchronous operation that returns true if the set operation was a success. Otherwise, returns false. + +## -remarks + Your app must declare the **systemManagement** capability, which lets apps have basic system administration privileges such as shutting down or rebooting, locale, and timezone. + +The systemManagement capability must include the iot namespace when you declare it in your app's package manifest. + +```xml + +``` + +Use [**Windows.Globalization.ApplicationLanguages.Languages**](https://docs.microsoft.com/uwp/api/windows.globalization.applicationlanguages#Windows_Globalization_ApplicationLanguages_Languages) to get the ranked list of current runtime language values preferred by the user. +## -examples + +## -see-also +[Embedded mode](https://developer.microsoft.com/windows/iot/docs/embeddedmode) +[App capability declarations](https://docs.microsoft.com/windows/uwp/packaging/app-capability-declarations) diff --git a/windows.media.speechsynthesis/speechsynthesizeroptions_audiopitch.md b/windows.media.speechsynthesis/speechsynthesizeroptions_audiopitch.md new file mode 100644 index 0000000000..3f80626262 --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizeroptions_audiopitch.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.AudioPitch +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.AudioPitch + +## -description +Gets or sets the tone (relative highness or lowness) of the speech synthesis utterance. + +## -property-value +The tone of the selected speech synthesis engine (voice). + +This value can range from 0.0 (lowest pitch) to 2.0 (highest pitch), inclusive. The default value is 1.0. + +Some voices have a minimum speaking pitch higher than 0.0 and a maximum speaking pitch lower than 2.0. + +## -remarks +If Speech Synthesis Markup Language (SSML) is used, [**AudioPitch**](speechsynthesizeroptions_audiopitch.md) is combined with any prosody tags in the markup. + +> [!NOTE] +> Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants). + + +## -see-also + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizeroptions_audiovolume.md b/windows.media.speechsynthesis/speechsynthesizeroptions_audiovolume.md new file mode 100644 index 0000000000..3069ef4405 --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizeroptions_audiovolume.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.AudioVolume +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.AudioVolume + +## -description +Gets or sets the loudness of the speech synthesis utterance. + +## -property-value +The loudness of the selected speech synthesis engine (voice). + +This value can range from 0.0 (lowest volume) to 1.0 (highest volume), inclusive. The default value is 1.0. + +## -remarks +If Speech Synthesis Markup Language (SSML) is used, [**AudioVolume**](peechsynthesizeroptions_audiovolume.md) is combined with any prosody tags in the markup. + +> [!NOTE] +> Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants). + +## -see-also + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizeroptions_speakingrate.md b/windows.media.speechsynthesis/speechsynthesizeroptions_speakingrate.md new file mode 100644 index 0000000000..0abc43c91b --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizeroptions_speakingrate.md @@ -0,0 +1,35 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.SpeakingRate +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.SpeakingRate + +## -description +Gets or sets the tempo (including pauses and hesitations) of the speech synthesis utterance. + +## -property-value +The tempo, relative to the default rate of the selected speech synthesis engine (voice). + +This value can range from 0.5 (half the default rate) to 6.0 (6x the default rate), inclusive. The default value is 1.0 (the "normal" speaking rate for the current voice). + +Some voices have minimum speaking rates faster than 0.5 and maximum speaking rates slower than 6.0. + +> [!NOTE] +> Speaking rate cannot be directly translated to words-per-minute because each voice and language can have a different default speaking rate. + +## -remarks +If Speech Synthesis Markup Language (SSML) is used, [**SpeakingRate**](speechsynthesizeroptions_speakingrate.md) is combined with any prosody tags in the markup. + +> [!NOTE] +> Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants). + + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_extendederror.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_extendederror.md index a65678de26..efd0638283 100644 --- a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_extendederror.md +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_extendederror.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ExtendedError --api-type: winrt property ---- - +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ExtendedError +-api-type: winrt property +--- + -# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ExtendedError - +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ExtendedError + ## -description +Gets the extended error code associated with the event. ## -property-value +The extended error code associated with the event. ## -remarks diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md index 59be5932c2..310e353339 100644 --- a/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md @@ -50,7 +50,7 @@ The [AdaptiveMediaSource](adaptivemediasource.md) will not attempt to download a This can occur if the web server returns a 410 – Gone response when downloading a manifest update for a particular bitrate if the server implements server side congestion control. It can also occur if the AdaptiveMediaSource is unable to download either the initialization segment or decryption key for a particular bitrate. ### -field FatalMediaSourceError:8 - +The **[AdaptiveMediaSource](https://docs.microsoft.com/uwp/api/Windows.Media.Streaming.Adaptive.AdaptiveMediaSource)** passed an error to the media pipeline that caused playback to stop. This diagnostic is not intended to replace media failure events provided by the [MediaPlayer](https://msdn.microsoft.com/library/windows/apps/windows.media.playback.mediaplayer.aspx), such as the **[MediaFailed](https://docs.microsoft.com/uwp/api/windows.media.playback.mediaplayer#Windows_Media_Playback_MediaPlayer_MediaFailed)** event. Instead, this diagnostic can be useful for correlating errors originating from the media source with potential corruption of error conditions with the content delivery network. ## -remarks diff --git a/windows.networking.backgroundtransfer/backgroundtransferfilerange.md b/windows.networking.backgroundtransfer/backgroundtransferfilerange.md new file mode 100644 index 0000000000..a16aec52f1 --- /dev/null +++ b/windows.networking.backgroundtransfer/backgroundtransferfilerange.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Networking.BackgroundTransfer.BackgroundTransferFileRange +-api-type: winrt struct +--- + + + +# Windows.Networking.BackgroundTransfer.BackgroundTransferFileRange + +## -description +Contains status information about the file transfer operation. +## -struct-fields + +### -field Length +The length. +### -field Offset +The offset. +## -remarks + +## -see-also +[GetDownLoadedRanges](downloadoperation_getdownloadedranges_1956750312.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs.md b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs.md new file mode 100644 index 0000000000..9c8cc84eeb --- /dev/null +++ b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs +-api-type: winrt class +--- + + + +# Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs + +## -description +Provides access to information about the incremental download progress event. +## -remarks + +## -see-also +[RangesDownloaded Event](downloadoperation_rangesdownloaded.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_addedranges.md b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_addedranges.md new file mode 100644 index 0000000000..9d7ea30cdd --- /dev/null +++ b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_addedranges.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs.AddedRanges +-api-type: winrt property +--- + + + +# Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs.AddedRanges + +## -description +List of ranges that were downloaded since the previous [RangesDownloaded event](downloadoperation_rangesdownloaded.md). + +## -property-value +List of ranges that were downloaded since the previous [RangesDownloaded event](downloadoperation_rangesdownloaded.md). + +## -remarks + +## -see-also +[RangesDownloaded Event](downloadoperation_rangesdownloaded.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_getdeferral_254836512.md b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..f432f0a3b1 --- /dev/null +++ b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_getdeferral_254836512.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs.GetDeferral + +## -description +Deferral allows apps to carry out asynchronous work within their RangesDownloaded handler without receiving a new [RangesDownloaded event](downloadoperation_rangesdownloaded.md) in the meantime. + +## -returns +**HRESULT** +## -remarks +Serialized RangesDownloaded events make the app’s code more straightforward and let WinRT BackgroundTransfer coalesce RangesDownloaded events instead of flooding an app with multiple concurrent ones. +## -see-also +[RangesDownloaded Event](downloadoperation_rangesdownloaded.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_wasdownloadrestarted.md b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_wasdownloadrestarted.md new file mode 100644 index 0000000000..512c5f6c4a --- /dev/null +++ b/windows.networking.backgroundtransfer/backgroundtransferrangesdownloadedeventargs_wasdownloadrestarted.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs.WasDownloadRestarted +-api-type: winrt property +--- + + + +# Windows.Networking.BackgroundTransfer.BackgroundTransferRangesDownloadedEventArgs.WasDownloadRestarted + +## -description +TRUE if the download was restarted from scratch since the previous RangesDownloaded event. + +## -property-value +TRUE if the download was restarted from scratch since the previous RangesDownloaded event, otherwise FALSE. +## -remarks +This is important, as the app will need to reset any state related to previously-processed DownloadedRanges data in that case. Download restarts can occur if the remote file’s timestamp or ETag changes. +## -see-also +[RangesDownloaded Event](downloadoperation_rangesdownloaded.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/backgroundtransferstatus.md b/windows.networking.backgroundtransfer/backgroundtransferstatus.md index 09fe4aaf46..9a35f189e8 100644 --- a/windows.networking.backgroundtransfer/backgroundtransferstatus.md +++ b/windows.networking.backgroundtransfer/backgroundtransferstatus.md @@ -40,9 +40,12 @@ An error was encountered during the transfer operation. ### -field PausedSystemPolicy:32 Windows Phone only. The transfer is paused by the system due to resource constraints. Transfers will have this status if Battery Saver is activated, if the background task can't get enough memory, CPU, power resources to run, or if the network condition is 2G and the app is not in the foreground +### -field PausedRecoverableWebErrorStatus:8 +One of the app-configured recoverable web error statuses ([RecoverableWebErrorStatuses](downloadoperation_recoverableweberrorstatuses.md)). ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also +[RecoverableWebErrorStatuses](downloadoperation_recoverableweberrorstatuses.md) \ No newline at end of file diff --git a/windows.networking.backgroundtransfer/downloadoperation_currentweberrorstatus.md b/windows.networking.backgroundtransfer/downloadoperation_currentweberrorstatus.md new file mode 100644 index 0000000000..724b5a11fc --- /dev/null +++ b/windows.networking.backgroundtransfer/downloadoperation_currentweberrorstatus.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.BackgroundTransfer.DownloadOperation.CurrentWebErrorStatus +-api-type: winrt property +--- + + + +# Windows.Networking.BackgroundTransfer.DownloadOperation.CurrentWebErrorStatus + +## -description +A transfer's [WebErrorStatus](../windows.web/weberrorstatus.md), which can be monitored during the lifetime of the [DownloadOperation](downloadoperation.md). +## -property-value +A [WebErrorStatus](../windows.web/weberrorstatus.md) error. +## -remarks + +## -see-also + +## -examples + +[WebErrorStatus](../windows.web/weberrorstatus.md), [DownloadOperation](downloadoperation.md) \ No newline at end of file diff --git a/windows.networking.backgroundtransfer/downloadoperation_getdownloadedranges_1956750312.md b/windows.networking.backgroundtransfer/downloadoperation_getdownloadedranges_1956750312.md new file mode 100644 index 0000000000..03505cd9d4 --- /dev/null +++ b/windows.networking.backgroundtransfer/downloadoperation_getdownloadedranges_1956750312.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Networking.BackgroundTransfer.DownloadOperation.GetDownloadedRanges +-api-type: winrt method +--- + + + +# Windows.Networking.BackgroundTransfer.DownloadOperation.GetDownloadedRanges + +## -description +Returns the full list of file ranges that have been downloaded so far. +## -returns +Returns an IVector. +## -remarks + +## -see-also +[BackgroundTransferFileRange](backgroundtransferfilerange.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/downloadoperation_getresultrandomaccessstreamreference_1794718843.md b/windows.networking.backgroundtransfer/downloadoperation_getresultrandomaccessstreamreference_1794718843.md new file mode 100644 index 0000000000..5b9d98a62f --- /dev/null +++ b/windows.networking.backgroundtransfer/downloadoperation_getresultrandomaccessstreamreference_1794718843.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Networking.BackgroundTransfer.DownloadOperation.GetResultRandomAccessStreamReference +-api-type: winrt method +--- + + + +# Windows.Networking.BackgroundTransfer.DownloadOperation.GetResultRandomAccessStreamReference + +## -description +Gets a reference to the random access stream and reads from it. It's necessary to set [IsRandomAccessRequired](downloadoperation_israndomaccessrequired.md) to TRUE before calling GetResultRandomAccessStreamReference. + +## -returns +A reference to the random access stream. +## -remarks + +## -see-also +[IsRandomAccessRequired](downloadoperation_israndomaccessrequired.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/downloadoperation_israndomaccessrequired.md b/windows.networking.backgroundtransfer/downloadoperation_israndomaccessrequired.md new file mode 100644 index 0000000000..a9b6068321 --- /dev/null +++ b/windows.networking.backgroundtransfer/downloadoperation_israndomaccessrequired.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.BackgroundTransfer.DownloadOperation.IsRandomAccessRequired +-api-type: winrt property +--- + + + +# Windows.Networking.BackgroundTransfer.DownloadOperation.IsRandomAccessRequired + +## -description +A boolean property to enable random access. The property must be set to TRUE before calling StartAsync() on a [DownloadOperation](downloadoperation.md) object to use the random access feature. After calling StartAsync(), call [GetResultRandomAccessStreamReference](downloadoperation_getresultrandomaccessstreamreference_1794718843.md) to get a reference to the random access stream and read from it. + +## -property-value +TRUE to use the random access feature. The default value is FALSE. +## -remarks +The IsRandomAccessRequired setter will fail with E_ILLEGAL_METHOD_CALL and a custom error message if StartAsync() has already been called on the [DownloadOperation](downloadoperation.md). + +## -see-also +[DownloadOperation](downloadoperation.md), [GetResultRandomAccessStreamReference](downloadoperation_getresultrandomaccessstreamreference_1794718843.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/downloadoperation_rangesdownloaded.md b/windows.networking.backgroundtransfer/downloadoperation_rangesdownloaded.md new file mode 100644 index 0000000000..07ea6ad4a0 --- /dev/null +++ b/windows.networking.backgroundtransfer/downloadoperation_rangesdownloaded.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.Networking.BackgroundTransfer.DownloadOperation.RangesDownloaded +-api-type: winrt event +--- + + + +# Windows.Networking.BackgroundTransfer.DownloadOperation.RangesDownloaded + +## -description +Provides access to to incremental download progress. +## -remarks + +## -see-also +[BackgroundTransferRangesDownloadedEventArgs](backgroundtransferrangesdownloadedeventargs.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/downloadoperation_recoverableweberrorstatuses.md b/windows.networking.backgroundtransfer/downloadoperation_recoverableweberrorstatuses.md new file mode 100644 index 0000000000..69bc6fc267 --- /dev/null +++ b/windows.networking.backgroundtransfer/downloadoperation_recoverableweberrorstatuses.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.BackgroundTransfer.DownloadOperation.RecoverableWebErrorStatuses +-api-type: winrt property +--- + + + +# Windows.Networking.BackgroundTransfer.DownloadOperation.RecoverableWebErrorStatuses + +## -description +A set of [WebErrorStatus](../windows.web/weberrorstatus.md) values that applications anticipate the download will hit, and that the applications know how to handle. +## -property-value +A set of [WebErrorStatus](../windows.web/weberrorstatus.md) values. +## -remarks + +## -see-also +[WebErrorStatus](../windows.web/weberrorstatus.md) +## -examples + diff --git a/windows.networking.backgroundtransfer/downloadoperation_requesteduri.md b/windows.networking.backgroundtransfer/downloadoperation_requesteduri.md index 51cc5f380b..0ebd4d29ac 100644 --- a/windows.networking.backgroundtransfer/downloadoperation_requesteduri.md +++ b/windows.networking.backgroundtransfer/downloadoperation_requesteduri.md @@ -16,7 +16,8 @@ Gets the URI from which to download the file. The URI to download from. ## -remarks - +The URI can be updated in for transfers that have hit a recoverable error (PausedRecoverableWebErrorStatus), or that have explicitly paused by the app (PausedByApplication). Once the URI has been updated, the app must call [DownloadOperation.Resume](downloadoperation_resume_406343050.md) to initiate a retry. ## -examples ## -see-also +[RecoverableWebErrorStatuses](downloadoperation_recoverableweberrorstatuses.md) \ No newline at end of file diff --git a/windows.networking.connectivity/connectionprofile_getprovidernetworkusageasync_1442391607.md b/windows.networking.connectivity/connectionprofile_getprovidernetworkusageasync_1442391607.md new file mode 100644 index 0000000000..1fc8cc539c --- /dev/null +++ b/windows.networking.connectivity/connectionprofile_getprovidernetworkusageasync_1442391607.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Networking.Connectivity.ConnectionProfile.GetProviderNetworkUsageAsync(Windows.Foundation.DateTime,Windows.Foundation.DateTime,Windows.Networking.Connectivity.NetworkUsageStates) +-api-type: winrt method +--- + + + +# Windows.Networking.Connectivity.ConnectionProfile.GetProviderNetworkUsageAsync + +## -description +Returns the bytes sent and bytes received for each MCC and MNC combination (the combination is represented by a [ProviderId](providernetworkusage_providerid.md)). + +## -parameters +### -param startTime +The start time over which to retrieve data. Can be no more than 60 days prior to the current time. If the specified granularity is PerMinute, the start time can be no more than 120 minutes prior to the current time. +### -param endTime +The end time over which to retrieve data. +### -param states +The state of the connection profile for which usage data should be returned. +## -returns +Returns a single object containing the bytes send and bytes received for the [ProviderId](providernetworkusage_providerid.md). +## -remarks + +## -see-also +[ConnectionProfile](connectionprofile.md), [ProviderId](providernetworkusage_providerid.md) +## -examples + diff --git a/windows.networking.connectivity/providernetworkusage.md b/windows.networking.connectivity/providernetworkusage.md new file mode 100644 index 0000000000..7750ca3828 --- /dev/null +++ b/windows.networking.connectivity/providernetworkusage.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Networking.Connectivity.ProviderNetworkUsage +-api-type: winrt class +--- + + + +# Windows.Networking.Connectivity.ProviderNetworkUsage + +## -description +Represents provider network usage statistics returned by the [ConnectionProfile](connectionprofile.md).[GetProviderNetworkUsageAsync](connectionprofile_getprovidernetworkusageasync_1442391607.md) method. +## -remarks + +## -see-also +[GetProviderNetworkUsageAsync](connectionprofile_getprovidernetworkusageasync_1442391607.md) +## -examples + diff --git a/windows.networking.connectivity/providernetworkusage_bytesreceived.md b/windows.networking.connectivity/providernetworkusage_bytesreceived.md new file mode 100644 index 0000000000..f1a9f8f83c --- /dev/null +++ b/windows.networking.connectivity/providernetworkusage_bytesreceived.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Connectivity.ProviderNetworkUsage.BytesReceived +-api-type: winrt property +--- + + + +# Windows.Networking.Connectivity.ProviderNetworkUsage.BytesReceived + +## -description +Gets a value indicating the number of bytes received by a connection over a specific period of time. +## -property-value +The number of bytes received. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.connectivity/providernetworkusage_bytessent.md b/windows.networking.connectivity/providernetworkusage_bytessent.md new file mode 100644 index 0000000000..20e7f5f1ee --- /dev/null +++ b/windows.networking.connectivity/providernetworkusage_bytessent.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Connectivity.ProviderNetworkUsage.BytesSent +-api-type: winrt property +--- + + + +# Windows.Networking.Connectivity.ProviderNetworkUsage.BytesSent + +## -description +Gets a value indicating the number of bytes sent by the connection over a specific period of time. +## -property-value +The number of bytes sent. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.connectivity/providernetworkusage_providerid.md b/windows.networking.connectivity/providernetworkusage_providerid.md new file mode 100644 index 0000000000..826eaa5169 --- /dev/null +++ b/windows.networking.connectivity/providernetworkusage_providerid.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Connectivity.ProviderNetworkUsage.ProviderId +-api-type: winrt property +--- + + + +# Windows.Networking.Connectivity.ProviderNetworkUsage.ProviderId + +## -description +Gets the ProviderId (a combination of MCC and MNC). +## -property-value +The ProviderId (a combination of MCC and MNC). +## -remarks +The MCC/MNC combo is expressed in the API as a single numeric (0-9) string named ProviderId that is a concatenation of a 3-digit MCC and a 2 or 3-digit MNC to be compliant with E.212. +## -see-also +[GetProviderNetworkUsageAsync](connectionprofile_getprovidernetworkusageasync_1442391607.md) +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandantennasar.md b/windows.networking.networkoperators/mobilebroadbandantennasar.md new file mode 100644 index 0000000000..48b3486e2b --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandantennasar.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar + +## -description +Represents the antenna on a broadband modem. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandantennasar_antennaindex.md b/windows.networking.networkoperators/mobilebroadbandantennasar_antennaindex.md new file mode 100644 index 0000000000..12f4778d95 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandantennasar_antennaindex.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar.AntennaIndex +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar.AntennaIndex + +## -description +Gets the identifier number of the antenna. + +## -property-value +The identifier number of the antenna. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandantennasar_sarbackoffindex.md b/windows.networking.networkoperators/mobilebroadbandantennasar_sarbackoffindex.md new file mode 100644 index 0000000000..486d76cfee --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandantennasar_sarbackoffindex.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar.SarBackoffIndex +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar.SarBackoffIndex + +## -description +Gets the index entry of SAR backoff value in device OEM’s table. + +## -property-value +The index entry of SAR backoff value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma.md b/windows.networking.networkoperators/mobilebroadbandcellcdma.md new file mode 100644 index 0000000000..b68a0de346 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma + +## -description +Represents CDMA network provider/cell information including identifications as well as its respective signal strength. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationid.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationid.md new file mode 100644 index 0000000000..f80b6eded7 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationId + +## -description +Gets the base station ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The base station ID. + +## -remarks +The range of this value is 0~65535; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlastbroadcastgpstime.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlastbroadcastgpstime.md new file mode 100644 index 0000000000..22d2cbde18 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlastbroadcastgpstime.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationLastBroadcastGpsTime +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationLastBroadcastGpsTime + +## -description +Gets the time elapsed since the location information from base station reached mobile station. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The time elapsed since the location information from base station reached mobile station. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlatitude.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlatitude.md new file mode 100644 index 0000000000..3c6241067c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlatitude.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationLatitude +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationLatitude + +## -description +Gets the base station latitude. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The base station latitude. + +## -remarks +The range of this value is -89.999931 ~ 90; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlongitude.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlongitude.md new file mode 100644 index 0000000000..3c735c313e --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationlongitude.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationLongitude +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationLongitude + +## -description +Gets the base station longitude. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The base station longitude. + +## -remarks +The range of this value is 179.999931 ~ 180; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationpncode.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationpncode.md new file mode 100644 index 0000000000..8f7e495ba4 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_basestationpncode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationPNCode +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.BaseStationPNCode + +## -description +Gets the base station PN Number. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The base station PN Number. + +## -remarks +The range of this value is 0~511; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_networkid.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_networkid.md new file mode 100644 index 0000000000..d20baba96d --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_networkid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.NetworkId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.NetworkId + +## -description +Gets the network ID in CDMA only. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The network ID in CDMA + +## -remarks +The range of this value is 0~65535; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_pilotsignalstrengthindb.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_pilotsignalstrengthindb.md new file mode 100644 index 0000000000..a87e970476 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_pilotsignalstrengthindb.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.PilotSignalStrengthInDB +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.PilotSignalStrengthInDB + +## -description +Gets the pilot signal strength in dB. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The pilot signal strength in dB. + +## -remarks +The range of this value is -120~-25; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellcdma_systemid.md b/windows.networking.networkoperators/mobilebroadbandcellcdma_systemid.md new file mode 100644 index 0000000000..4be0da134c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellcdma_systemid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.SystemId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellCdma.SystemId + +## -description +Gets the system ID in CDMA only. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The system ID in CDMA + +## -remarks +The range of this value is 0~32767; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm.md b/windows.networking.networkoperators/mobilebroadbandcellgsm.md new file mode 100644 index 0000000000..9f1458a78c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm + +## -description +Represents GSM network provider/cell information including identifications as well as its respective signal strength. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_basestationid.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_basestationid.md new file mode 100644 index 0000000000..251234f284 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_basestationid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.BaseStationId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.BaseStationId + +## -description +Gets the base station ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The base station ID. + +## -remarks +The range of this value is 0~63; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_cellid.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_cellid.md new file mode 100644 index 0000000000..f61c97bda2 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_cellid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.CellId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.CellId + +## -description +Gets the cell ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The cell ID. + +## -remarks +Returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_channelnumber.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_channelnumber.md new file mode 100644 index 0000000000..7107ed60e6 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_channelnumber.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.ChannelNumber +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.ChannelNumber + +## -description +Gets the Absolute Radio Frequency Channel Number for serving cell. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Absolute Radio Frequency Channel Number for serving cell. + +## -remarks +The range of this value is 0~1023; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_locationareacode.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_locationareacode.md new file mode 100644 index 0000000000..cad12c5c0d --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_locationareacode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.LocationAreaCode +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.LocationAreaCode + +## -description +Gets the Location Area Code (LAC). + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Location Area Code (LAC). + +## -remarks +The range of this value is 0~65535; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_providerid.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_providerid.md new file mode 100644 index 0000000000..5ea4b8783e --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_providerid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.ProviderId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.ProviderId + +## -description +Gets a concatenated string of MCC and MNC + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The provider ID. + +## -remarks +Returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_receivedsignalstrengthindbm.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_receivedsignalstrengthindbm.md new file mode 100644 index 0000000000..591e964bb7 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_receivedsignalstrengthindbm.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.ReceivedSignalStrengthInDBm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.ReceivedSignalStrengthInDBm + +## -description +Gets the received signal strength in dB. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The received signal strength, in dB. + +## -remarks +The range of this value is -110~49; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellgsm_timingadvanceinbitperiods.md b/windows.networking.networkoperators/mobilebroadbandcellgsm_timingadvanceinbitperiods.md new file mode 100644 index 0000000000..1e84577c99 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellgsm_timingadvanceinbitperiods.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.TimingAdvanceInBitPeriods +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellGsm.TimingAdvanceInBitPeriods + +## -description +Gets the Timing Advance in bit periods, where a bit period is 48/13us. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Timing Advance in bit periods. + +## -remarks +The range of this value is 0~255; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte.md b/windows.networking.networkoperators/mobilebroadbandcelllte.md new file mode 100644 index 0000000000..c8a7e6cafc --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandCellLte +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte + +## -description +Represents LTE network provider/cell information including identifications as well as its respective signal strength. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_cellid.md b/windows.networking.networkoperators/mobilebroadbandcelllte_cellid.md new file mode 100644 index 0000000000..199a641837 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_cellid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.CellId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.CellId + +## -description +Gets the cell ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The cell ID. + +## -remarks +Returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_channelnumber.md b/windows.networking.networkoperators/mobilebroadbandcelllte_channelnumber.md new file mode 100644 index 0000000000..abe510f5e3 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_channelnumber.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ChannelNumber +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ChannelNumber + +## -description +Gets the UNTRA Absolute Radio Frequency Channel Number for serving cell. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The UNTRA Absolute Radio Frequency Channel Number for serving cell. + +## -remarks +The range of this value is 0~65535; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_physicalcellid.md b/windows.networking.networkoperators/mobilebroadbandcelllte_physicalcellid.md new file mode 100644 index 0000000000..8359d95c9a --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_physicalcellid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.PhysicalCellId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.PhysicalCellId + +## -description +Gets the pysical cell ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The cell ID. + +## -remarks +The range of this value is 0~503; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_providerid.md b/windows.networking.networkoperators/mobilebroadbandcelllte_providerid.md new file mode 100644 index 0000000000..6e69ef68b3 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_providerid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ProviderId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ProviderId + +## -description +Gets a concatenated string of MCC and MNC. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The provider ID. + +## -remarks +Returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_referencesignalreceivedpowerindbm.md b/windows.networking.networkoperators/mobilebroadbandcelllte_referencesignalreceivedpowerindbm.md new file mode 100644 index 0000000000..80e0e17d36 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_referencesignalreceivedpowerindbm.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ReferenceSignalReceivedPowerInDBm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ReferenceSignalReceivedPowerInDBm + +## -description +Gets the average Reference Signal Received Power in dBm. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The average Reference Signal Received Power in dBm. + +## -remarks +The range of this value is -140~44; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_referencesignalreceivedqualityindbm.md b/windows.networking.networkoperators/mobilebroadbandcelllte_referencesignalreceivedqualityindbm.md new file mode 100644 index 0000000000..01c1c97277 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_referencesignalreceivedqualityindbm.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ReferenceSignalReceivedQualityInDBm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.ReferenceSignalReceivedQualityInDBm + +## -description +Gets the average Reference Signal Received Quality in dBm. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The average Reference Signal Received Quality in dBm. + +## -remarks +The range of this value is -20~-3; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_timingadvanceinbitperiods.md b/windows.networking.networkoperators/mobilebroadbandcelllte_timingadvanceinbitperiods.md new file mode 100644 index 0000000000..bab18fdcf6 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_timingadvanceinbitperiods.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.TimingAdvanceInBitPeriods +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.TimingAdvanceInBitPeriods + +## -description +Gets the Timing Advance in bit periods, where a bit period is 48/13us. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Timing Advance in bit periods. + +## -remarks +The range of this value is 0~255; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelllte_trackingareacode.md b/windows.networking.networkoperators/mobilebroadbandcelllte_trackingareacode.md new file mode 100644 index 0000000000..f239964344 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelllte_trackingareacode.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellLte.TrackingAreaCode +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellLte.TrackingAreaCode + +## -description +Gets the Tracking Area Code. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Tracking Area Code. + +## -remarks +The range of this value is 0~65535; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo.md new file mode 100644 index 0000000000..3a3ca8ff62 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo + +## -description +Retrieves the serving and neighboring network cell information including respective signal strength and cell tower identification information. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellscdma.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellscdma.md new file mode 100644 index 0000000000..f21ccc2b83 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellscdma.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsCdma +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsCdma + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellCdma**](mobilebroadbandcellcdma.md containing all CDMA providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellCdma**](mobilebroadbandcellcdma.md containing all CDMA providers. + +## -remarks +If not available or unknown, the size of array is 0. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellsgsm.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellsgsm.md new file mode 100644 index 0000000000..102fe39c19 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellsgsm.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsGsm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsGsm + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellGsm**](mobilebroadbandcellgsm.md) containing all GSM providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellGsm**](mobilebroadbandcellgsm.md) containing all GSM providers. + +## -remarks +If not available or unknown, the size of array is 0. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellslte.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellslte.md new file mode 100644 index 0000000000..8f7a65082c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellslte.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsLte +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsLte + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellLte**](mobilebroadbandcelllte.md) containing all LTE providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellLte**](mobilebroadbandcelllte.md) containing all LTE providers. + +## -remarks +If not available or unknown, the size of array is 0. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellstdscdma.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellstdscdma.md new file mode 100644 index 0000000000..64bbd7f929 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellstdscdma.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsTdscdma +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsTdscdma + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellTdscdma**](mobilebroadbandcelltdscdma.md) containing all TDSCMA providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellTdscdma**](mobilebroadbandcelltdscdma.md) containing all TDSCMA providers. + +## -remarks +If not available or unknown, the size of array is 0. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellsumts.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellsumts.md new file mode 100644 index 0000000000..f0effa4885 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_neighboringcellsumts.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsUmts +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.NeighboringCellsUmts + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellUmts**](mobilebroadbandcellumts.md) containing all UMTS providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellUmts**](mobilebroadbandcellumts.md) containing all UMTS providers. + +## -remarks +If not available or unknown, the size of array is 0. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellscdma.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellscdma.md new file mode 100644 index 0000000000..0b98b9c0c4 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellscdma.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsCdma +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsCdma + +## -description +Gets a read-only array of serving [**MobileBroadbandCellCdma**](mobilebroadbandcellcdma.md) containing all CDMA providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of serving [**MobileBroadbandCellCdma**](mobilebroadbandcellcdma.md) containing all CDMA providers. + +## -remarks +If not available or unknown, the size of array is 0. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellsgsm.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellsgsm.md new file mode 100644 index 0000000000..0882216282 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellsgsm.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsGsm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsGsm + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellGsm**](mobilebroadbandcellgsm.md) containing all GSM providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellGsm**](mobilebroadbandcellgsm.md) containing all GSM providers. + +## -remarks +If not available or unknown, the size of array is 0. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellslte.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellslte.md new file mode 100644 index 0000000000..2f2176778d --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellslte.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsLte +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsLte + +## -description +Gets a read-only array of neighboring [**MobileBroadbandCellLte**](mobilebroadbandcelllte.md) containing all LTE providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of neighboring [**MobileBroadbandCellLte**](mobilebroadbandcelllte.md) containing all LTE providers. + +## -remarks +If not available or unknown, the size of array is 0. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellstdscdma.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellstdscdma.md new file mode 100644 index 0000000000..5087244453 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellstdscdma.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsTdscdma +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsTdscdma + +## -description +Gets a read-only array of serving [**MobileBroadbandCellTdscdma**](mobilebroadbandcelltdscdma.md) containing all TDSCMA providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of serving [**MobileBroadbandCellTdscdma**](mobilebroadbandcellumts.md) containing all TDSCMA providers. + +## -remarks +If not available or unknown, the size of array is 0. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellsumts.md b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellsumts.md new file mode 100644 index 0000000000..be0cb5a9c4 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellsinfo_servingcellsumts.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsUmts +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellsInfo.ServingCellsUmts + +## -description +Gets a read-only array of serving [**MobileBroadbandCellUmts**](mobilebroadbandcellumts.md) containing all UMTS providers. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +A read-only array of serving [**MobileBroadbandCellUmts**](mobilebroadbandcellumts.md) containing all UMTS providers. + +## -remarks +If not available or unknown, the size of array is 0. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma.md new file mode 100644 index 0000000000..79c368851c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma + +## -description +Represents TDSCDMA network provider/cell information including identifications as well as its respective signal strength. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_cellid.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_cellid.md new file mode 100644 index 0000000000..8976ce0d94 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_cellid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.CellId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.CellId + +## -description +Gets the cell ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The cell ID. + +## -remarks +Returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_cellparameterid.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_cellparameterid.md new file mode 100644 index 0000000000..8193e483f8 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_cellparameterid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.CellParameterId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.CellParameterId + +## -description +Gets the cell parameter ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The cell parameter ID. + +## -remarks +The range of this value is 0~127; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_channelnumber.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_channelnumber.md new file mode 100644 index 0000000000..a428344d4a --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_channelnumber.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.ChannelNumber +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.ChannelNumber + +## -description +Gets the channel number for serving cell. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The channel number for serving cell. + +## -remarks +The range of this value is 0~16383; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_locationareacode.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_locationareacode.md new file mode 100644 index 0000000000..918f7f2356 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_locationareacode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.LocationAreaCode +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.LocationAreaCode + +## -description +Gets the Location Area Code (LAC). + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Location Area Code (LAC). + +## -remarks +The range of this value is 0~65535; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_pathlossindb.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_pathlossindb.md new file mode 100644 index 0000000000..4730adbd90 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_pathlossindb.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.PathLossInDB +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.PathLossInDB + +## -description +Gets the path loss in dB. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The path loss in dB. + +## -remarks +The range of this value is 46~173; returns null if unknown +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_providerid.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_providerid.md new file mode 100644 index 0000000000..2218ad279b --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_providerid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.ProviderId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.ProviderId + +## -description +Gets a concatenated string of MCC and MNC. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The provider ID. + +## -remarks +Returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_receivedsignalcodepowerindbm.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_receivedsignalcodepowerindbm.md new file mode 100644 index 0000000000..ea6b898377 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_receivedsignalcodepowerindbm.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.ReceivedSignalCodePowerInDBm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.ReceivedSignalCodePowerInDBm + +## -description +Gets the received signal code power in dBm. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The received signal code power in dBm. + +## -remarks +The range of this value is -128~-25; returns null if unknown +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcelltdscdma_timingadvanceinbitperiods.md b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_timingadvanceinbitperiods.md new file mode 100644 index 0000000000..f669e5866c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcelltdscdma_timingadvanceinbitperiods.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.TimingAdvanceInBitPeriods +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellTdscdma.TimingAdvanceInBitPeriods + +## -description +Gets the Timing Advance in bit periods, where a bit period is 48/13us. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Timing Advance in bit periods. + +## -remarks +The range of this value is 0~255; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts.md b/windows.networking.networkoperators/mobilebroadbandcellumts.md new file mode 100644 index 0000000000..d469d6383a --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts + +## -description +Represents UMTS network provider/cell information including identifications as well as its respective signal strength. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_cellid.md b/windows.networking.networkoperators/mobilebroadbandcellumts_cellid.md new file mode 100644 index 0000000000..8a90d7a693 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_cellid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.CellId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.CellId + +## -description +Gets the cell ID. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The cell ID. + +## -remarks +Returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_channelnumber.md b/windows.networking.networkoperators/mobilebroadbandcellumts_channelnumber.md new file mode 100644 index 0000000000..933d45aac1 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_channelnumber.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.ChannelNumber +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.ChannelNumber + +## -description +Gets the UTRAN Absolute Radio Frequency Channel Number for serving cell. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The UTRAN Absolute Radio Frequency Channel Number for serving cell. + +## -remarks +The range of this value is 0~16383; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_locationareacode.md b/windows.networking.networkoperators/mobilebroadbandcellumts_locationareacode.md new file mode 100644 index 0000000000..3ddbf13024 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_locationareacode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.LocationAreaCode +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.LocationAreaCode + +## -description +Gets the Location Area Code (LAC). + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The Location Area Code (LAC). + +## -remarks +The range of this value is 0~65535; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_pathlossindb.md b/windows.networking.networkoperators/mobilebroadbandcellumts_pathlossindb.md new file mode 100644 index 0000000000..e6ddc59dd1 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_pathlossindb.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.PathLossInDB +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.PathLossInDB + +## -description +Gets the path loss in dB. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The path loss in dB. + +## -remarks +The range of this value is 46~173; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_primaryscramblingcode.md b/windows.networking.networkoperators/mobilebroadbandcellumts_primaryscramblingcode.md new file mode 100644 index 0000000000..0b364efe2a --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_primaryscramblingcode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.PrimaryScramblingCode +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.PrimaryScramblingCode + +## -description +Gets the primary scrambling code of serving cell. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The primary scrambling code of serving cell. + +## -remarks +The range of this value is 0~511; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_providerid.md b/windows.networking.networkoperators/mobilebroadbandcellumts_providerid.md new file mode 100644 index 0000000000..eeccd52744 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_providerid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.ProviderId +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.ProviderId + +## -description +Gets a concatenated string of MCC and MNC. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The provider ID. + +## -remarks +Returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_receivedsignalcodepowerindbm.md b/windows.networking.networkoperators/mobilebroadbandcellumts_receivedsignalcodepowerindbm.md new file mode 100644 index 0000000000..e32413f91c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_receivedsignalcodepowerindbm.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.ReceivedSignalCodePowerInDBm +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.ReceivedSignalCodePowerInDBm + +## -description +Gets the received signal code power in dBm. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The received signal code power in dBm. + +## -remarks +The range of this value is -120~-25; returns null if unknown. +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandcellumts_signaltonoiseratioindb.md b/windows.networking.networkoperators/mobilebroadbandcellumts_signaltonoiseratioindb.md new file mode 100644 index 0000000000..49d51c9dee --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandcellumts_signaltonoiseratioindb.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.SignalToNoiseRatioInDB +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandCellUmts.SignalToNoiseRatioInDB + +## -description +Gets the signal to noise ratio in dB. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -property-value +The received signal code power in dBm. + +## -remarks +This value is the ratio of the received energy per PN chip for the CPICH to the total received power spectral density at the antenna. +The range of this value is -50~0; returns null if unknown. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandmodem_getispassthroughenabledasync_2012048237.md b/windows.networking.networkoperators/mobilebroadbandmodem_getispassthroughenabledasync_2012048237.md new file mode 100644 index 0000000000..37be798f8e --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandmodem_getispassthroughenabledasync_2012048237.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandModem.GetIsPassthroughEnabledAsync +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandModem.GetIsPassthroughEnabledAsync + +## -description +Gets a value indicating whether passthrough mode is enabled. + +## -returns +An asynchronous operation that returns a boolean value on completion. The value is true if passthrough is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandmodem_setispassthroughenabledasync_1308076323.md b/windows.networking.networkoperators/mobilebroadbandmodem_setispassthroughenabledasync_1308076323.md new file mode 100644 index 0000000000..7278f22e82 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandmodem_setispassthroughenabledasync_1308076323.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandModem.SetIsPassthroughEnabledAsync(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandModem.SetIsPassthroughEnabledAsync + +## -description +Asynchronously enables or disables passthrough mode. + +## -parameters +### -param value +True if passthrough should be enabled; otherwise, false. + +## -returns +An asynchronous operation that returns a [**MobileBroadbandModemStatus**](mobilebroadbandmodemstatus.md) value on completion. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandmodemconfiguration_sarmanager.md b/windows.networking.networkoperators/mobilebroadbandmodemconfiguration_sarmanager.md new file mode 100644 index 0000000000..7b1542f729 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandmodemconfiguration_sarmanager.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandModemConfiguration.SarManager +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandModemConfiguration.SarManager + +## -description +Gets the [**MobileBroadbandSarManager**](mobilebroadbandsarmanager.md) object that manages SAR and antenna relevant operations. + +## -property-value +The [**MobileBroadbandSarManager**](mobilebroadbandsarmanager.md) object that manages SAR and antenna relevant operations. + + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandmodemstatus.md b/windows.networking.networkoperators/mobilebroadbandmodemstatus.md new file mode 100644 index 0000000000..61be29c437 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandmodemstatus.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandModemStatus +-api-type: winrt enum +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandModemStatus + +## -description +Specifies the status of a request to set the modem passthrough status by calling [**SetIsPassthroughEnabledAsync**](mobilebroadbandmodem_setispassthroughenabledasync_1308076323.md). + +## -enum-fields +### -field Success:0 +The call was successful. + +### -field OtherFailure:1 +An unspecified failure occurred. + +### -field NoDeviceSupport:3 +The modem does not support the request. + +### -field Busy:2 +The modem is busy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandnetwork_getcellsinfoasync_164818152.md b/windows.networking.networkoperators/mobilebroadbandnetwork_getcellsinfoasync_164818152.md new file mode 100644 index 0000000000..d0b4c732fd --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandnetwork_getcellsinfoasync_164818152.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandNetwork.GetCellsInfoAsync +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandNetwork.GetCellsInfoAsync + +## -description +Retrieves a [**MobileBroadbandCellsInfo**](C:\Users\drewbat.REDMOND\Source\Repos\winrt-api\windows.networking.networkoperators\mobilebroadbandcellsinfo.md) object that contains all serving and neighboring cell information when device is registered to a network. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. + +## -returns +An asynchronous operation that returns a [**MobileBroadbandCellsInfo**](C:\Users\drewbat.REDMOND\Source\Repos\winrt-api\windows.networking.networkoperators\mobilebroadbandcellsinfo.md) object upon completion. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager.md b/windows.networking.networkoperators/mobilebroadbandsarmanager.md new file mode 100644 index 0000000000..48e1972b2f --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandSarManager +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager + +## -description +Contains the SAR configuration properties and the control method to change them on the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_antennas.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_antennas.md new file mode 100644 index 0000000000..fcfc5100df --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_antennas.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.Antennas +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.Antennas + +## -description +Gets the collection of current SAR configuration models for each antenna on the device. + +## -property-value +The collection of current SAR configuration models for each antenna on the device. + +## -remarks +The size of this collection is guaranteed to be the same as the number of antennas on device. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_disablebackoffasync_1734404839.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_disablebackoffasync_1734404839.md new file mode 100644 index 0000000000..7e2ec0e942 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_disablebackoffasync_1734404839.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.DisableBackoffAsync +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.DisableBackoffAsync + +## -description +Disables SAR backoff functionality on the device. + +## -returns +An asynchronous action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_enablebackoffasync_87015587.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_enablebackoffasync_87015587.md new file mode 100644 index 0000000000..7f7912421c --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_enablebackoffasync_87015587.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.EnableBackoffAsync +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.EnableBackoffAsync + +## -description +Enables SAR backoff functionality on the device. + +## -returns +An asynchronous action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_getistransmittingasync_1398095693.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_getistransmittingasync_1398095693.md new file mode 100644 index 0000000000..2250ef2362 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_getistransmittingasync_1398095693.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.GetIsTransmittingAsync +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.GetIsTransmittingAsync + +## -description +Gets a value that indicates whether the modem is transmitting or idle. + +## -returns +True if the modem is transmitting; otherwise, it is idle. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_hysteresistimerperiod.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_hysteresistimerperiod.md new file mode 100644 index 0000000000..91d23d2909 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_hysteresistimerperiod.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.HysteresisTimerPeriod +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.HysteresisTimerPeriod + +## -description +Gets the time window of the hysteresis timer that is used to determine antenna's transmission state. + +## -property-value +The time window of the hysteresis timer. + +## -remarks +This value is in the range 1 ~ 5, in seconds. + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_isbackoffenabled.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_isbackoffenabled.md new file mode 100644 index 0000000000..ff1496e60b --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_isbackoffenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.IsBackoffEnabled +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.IsBackoffEnabled + +## -description +Gets a value indicating whether SAR backoff functionality is enabled on the device. + +## -property-value +True if SAR backoff functionality is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_issarcontrolledbyhardware.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_issarcontrolledbyhardware.md new file mode 100644 index 0000000000..e4f1213cad --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_issarcontrolledbyhardware.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.IsSarControlledByHardware +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.IsSarControlledByHardware + +## -description +Gets a value indicating if SAR configuration is controlled by device hardware. + +## -property-value +True if SAR configuration is controlled by device hardware; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_iswifihardwareintegrated.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_iswifihardwareintegrated.md new file mode 100644 index 0000000000..529222db5e --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_iswifihardwareintegrated.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.IsWiFiHardwareIntegrated +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.IsWiFiHardwareIntegrated + +## -description +Gets a value indicating if WiFi and cellular SAR are integrated in the device. + +## -property-value +True if WiFi and cellular SAR are integrated in the device; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_revertsartohardwarecontrolasync_578366651.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_revertsartohardwarecontrolasync_578366651.md new file mode 100644 index 0000000000..faadb271e3 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_revertsartohardwarecontrolasync_578366651.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.RevertSarToHardwareControlAsync +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.RevertSarToHardwareControlAsync + +## -description +Sets the device back to hardware control mode. The relevant SAR configuration values are reset to the hardware default settings. + +## -returns +An asynchronous action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_setconfigurationasync_411927944.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_setconfigurationasync_411927944.md new file mode 100644 index 0000000000..cc74105a19 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_setconfigurationasync_411927944.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.SetConfigurationAsync(Windows.Foundation.Collections.IIterable{Windows.Networking.NetworkOperators.MobileBroadbandAntennaSar}) +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.SetConfigurationAsync + +## -description +Sends a request to the device to change the SAR configuration. + +## -parameters +### -param antennas +The collection of antennas containing the SAR backoff property to configure. + +## -returns +An asynchronous action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_settransmissionstatechangedhysteresisasync_1948589296.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_settransmissionstatechangedhysteresisasync_1948589296.md new file mode 100644 index 0000000000..c3aaf0950f --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_settransmissionstatechangedhysteresisasync_1948589296.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.SetTransmissionStateChangedHysteresisAsync(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.SetTransmissionStateChangedHysteresisAsync + +## -description +Sets the hysteresis timer (1-5 seconds) used to determine if transmission activity is idle. + +## -parameters +### -param timerPeriod +/** The time-window size ranging from 1 to 5 seconds. + +## -returns +An asynchronous action. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_starttransmissionstatemonitoring_1445651691.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_starttransmissionstatemonitoring_1445651691.md new file mode 100644 index 0000000000..7958d6d0a0 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_starttransmissionstatemonitoring_1445651691.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.StartTransmissionStateMonitoring +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.StartTransmissionStateMonitoring + +## -description +Starts monitoring the transition state change on the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_stoptransmissionstatemonitoring_1111799607.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_stoptransmissionstatemonitoring_1111799607.md new file mode 100644 index 0000000000..117030ab0a --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_stoptransmissionstatemonitoring_1111799607.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.StopTransmissionStateMonitoring +-api-type: winrt method +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.StopTransmissionStateMonitoring + +## -description +Stops monitoring the transition state change on the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandsarmanager_transmissionstatechanged.md b/windows.networking.networkoperators/mobilebroadbandsarmanager_transmissionstatechanged.md new file mode 100644 index 0000000000..3d20daaf64 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandsarmanager_transmissionstatechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Networking.NetworkOperators.MobileBroadbandSarManager.TransmissionStateChanged +-api-type: winrt event +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandSarManager.TransmissionStateChanged + +## -description +Occurs when there is notification received from device that indicate a change in the current transmission state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandtransmissionstatechangedeventargs.md b/windows.networking.networkoperators/mobilebroadbandtransmissionstatechangedeventargs.md new file mode 100644 index 0000000000..f006ad040a --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandtransmissionstatechangedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Networking.NetworkOperators.MobileBroadbandTransmissionStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandTransmissionStateChangedEventArgs + +## -description +Provides data for the [**TransmissionStateChanged**](mobilebroadbandsarmanager_transmissionstatechanged.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbandtransmissionstatechangedeventargs_istransmitting.md b/windows.networking.networkoperators/mobilebroadbandtransmissionstatechangedeventargs_istransmitting.md new file mode 100644 index 0000000000..115aba21fe --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandtransmissionstatechangedeventargs_istransmitting.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandTransmissionStateChangedEventArgs.IsTransmitting +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandTransmissionStateChangedEventArgs.IsTransmitting + +## -description +Gets a value that indicates whether the modem is transmitting. + +## -property-value +True if the modem is transmitting; otherwise, false. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.sockets/messagewebsocketcontrol_actualunsolicitedponginterval.md b/windows.networking.sockets/messagewebsocketcontrol_actualunsolicitedponginterval.md new file mode 100644 index 0000000000..7360a41746 --- /dev/null +++ b/windows.networking.sockets/messagewebsocketcontrol_actualunsolicitedponginterval.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.Sockets.MessageWebSocketControl.ActualUnsolicitedPongInterval +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.MessageWebSocketControl.ActualUnsolicitedPongInterval + +## -description +Allows an app to get the actual unsolicited WebSocket PONG interval. +## -property-value +System.Timespan +## -remarks +This terminology is defined in WebSocket RFC 6455, which is the time between unsolicited Pong control frames sent by the client to the server. The PONG serves as a unidirectional heartbeat and can be used for the client to determine network connection issues. + +## -see-also +[MessageWebSocket](messagewebsocket.md) +## -examples + diff --git a/windows.networking.sockets/messagewebsocketcontrol_clientcertificate.md b/windows.networking.sockets/messagewebsocketcontrol_clientcertificate.md new file mode 100644 index 0000000000..7be98f0987 --- /dev/null +++ b/windows.networking.sockets/messagewebsocketcontrol_clientcertificate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Sockets.MessageWebSocketControl.ClientCertificate +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.MessageWebSocketControl.ClientCertificate + +## -description +Gets the certificate provided by the client when a secure WebSocket connection has been established. +## -property-value +The client certificate. +## -remarks + +## -see-also +[MessageWebSocket](messagewebsocket.md) +## -examples + diff --git a/windows.networking.sockets/messagewebsocketcontrol_desiredunsolicitedponginterval.md b/windows.networking.sockets/messagewebsocketcontrol_desiredunsolicitedponginterval.md new file mode 100644 index 0000000000..17bccbc5ac --- /dev/null +++ b/windows.networking.sockets/messagewebsocketcontrol_desiredunsolicitedponginterval.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Sockets.MessageWebSocketControl.DesiredUnsolicitedPongInterval +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.MessageWebSocketControl.DesiredUnsolicitedPongInterval + +## -description +Allows an app to get and set the desired unsolicited WebSocket PONG interval. +## -property-value +System.Timespan +## -remarks +This terminology is defined in WebSocket RFC 6455, which is the time between unsolicited Pong control frames sent by the client to the server. The PONG serves as a unidirectional heartbeat and can be used for the client to determine network connection issues. +## -see-also +[MessageWebSocket](messagewebsocket.md) +## -examples + diff --git a/windows.networking.sockets/messagewebsocketcontrol_receivemode.md b/windows.networking.sockets/messagewebsocketcontrol_receivemode.md new file mode 100644 index 0000000000..6587b47b59 --- /dev/null +++ b/windows.networking.sockets/messagewebsocketcontrol_receivemode.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Sockets.MessageWebSocketControl.ReceiveMode +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.MessageWebSocketControl.ReceiveMode + +## -description +Allows clients to control receiving either complete or partial messages. +## -property-value +A [MessageWebSocketReceiveMode](messagewebsocketreceivemode.md) enumeration member indicating either complete or partial messages. +## -remarks + +## -see-also +[MessageWebSocketReceiveMode](messagewebsocketreceivemode.md) +## -examples + diff --git a/windows.networking.sockets/messagewebsocketmessagereceivedeventargs_ismessagecomplete.md b/windows.networking.sockets/messagewebsocketmessagereceivedeventargs_ismessagecomplete.md new file mode 100644 index 0000000000..e2061714f4 --- /dev/null +++ b/windows.networking.sockets/messagewebsocketmessagereceivedeventargs_ismessagecomplete.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.Sockets.MessageWebSocketMessageReceivedEventArgs.IsMessageComplete +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.MessageWebSocketMessageReceivedEventArgs.IsMessageComplete + +## -description +Allow clients to query if a MessageReceived callback indicates the received message is complete or just a partial message. +## -property-value +TRUE if the message is complete. The default value is FALSE. +## -remarks +This flag is always true if ReceiveMode is FullMessage mode (the default), but only true for the last (for a given set of fragments) MessageReceive callback in the new PartialMessage mode. + +## -see-also +[MessageWebSocket](messagewebsocket.md) +## -examples + diff --git a/windows.networking.sockets/messagewebsocketreceivemode.md b/windows.networking.sockets/messagewebsocketreceivemode.md new file mode 100644 index 0000000000..15276e233b --- /dev/null +++ b/windows.networking.sockets/messagewebsocketreceivemode.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Networking.Sockets.MessageWebSocketReceiveMode +-api-type: winrt enum +--- + + + +# Windows.Networking.Sockets.MessageWebSocketReceiveMode + +## -description +Describes the kind of message that the client will accept. +## -enum-fields +### -field PartialMessage:1 +The client will accept a partial message. +### -field FullMessage:0 +The client will accept a full message. +## -remarks + +## -see-also +[MessageWebSocketControl_ReceiveMode](messagewebsocketcontrol_receivemode.md) +## -examples + diff --git a/windows.networking.sockets/socketprotectionlevel.md b/windows.networking.sockets/socketprotectionlevel.md index 3eff5210bb..e38d65ba6e 100644 --- a/windows.networking.sockets/socketprotectionlevel.md +++ b/windows.networking.sockets/socketprotectionlevel.md @@ -64,6 +64,9 @@ A TCP socket that must use SSL for encryption. This value supports the TLS 1.2, This value is supported on Windows 8.1, Windows Server 2012 R2, and later. +### -field Unspecified:9 +The protection level is unspecified. + ## -remarks The [SocketProtectionLevel](socketprotectionlevel.md) enumeration allow clients to control protocol negotiation for security options with servers when using the [StreamSocket](streamsocket.md) object. @@ -81,4 +84,4 @@ The [SocketProtectionLevel](socketprotectionlevel.md) enumeration also allow ser [StreamSocket](streamsocket.md), [StreamSocketInformation.ProtectionLevel](streamsocketinformation_protectionlevel.md) ## -capabilities -ID_CAP_NETWORKING [Windows Phone], bluetooth.rfcomm \ No newline at end of file +ID_CAP_NETWORKING [Windows Phone], bluetooth.rfcomm diff --git a/windows.networking.sockets/streamsocketcontrol_clientcertificate.md b/windows.networking.sockets/streamsocketcontrol_clientcertificate.md index fc75122e63..1e2cc40a11 100644 --- a/windows.networking.sockets/streamsocketcontrol_clientcertificate.md +++ b/windows.networking.sockets/streamsocketcontrol_clientcertificate.md @@ -20,3 +20,4 @@ The client certificate. ## -examples ## -see-also +[StreamSocket](streamsocket.md) \ No newline at end of file diff --git a/windows.networking.sockets/streamsocketcontrol_minprotectionlevel.md b/windows.networking.sockets/streamsocketcontrol_minprotectionlevel.md new file mode 100644 index 0000000000..2d2c98ec6d --- /dev/null +++ b/windows.networking.sockets/streamsocketcontrol_minprotectionlevel.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.Sockets.StreamSocketControl.MinProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.StreamSocketControl.MinProtectionLevel + +## -description +Constrains the TLS protocol version that will be negotiated when the developer uses the ConnectAsync() or UpgradeToSslAsync() methods that require TLS. + +## -property-value +A [SocketProtectionLevels](socketprotectionlevels.md) enumeration member indicating the socket protection level. +## -remarks + When the server does not meet the TLS version specified by MinProtectionLevel, the corresponding ConnectAsync() and/or UpgradeToSslAsnc() execution will behave just as if the server does not support SSL or TLS. +## -see-also +[StreamSocket](streamsocket.md), [SocketProtectionLevels](socketprotectionlevels.md) +## -examples + diff --git a/windows.networking.sockets/streamwebsocketcontrol_actualunsolicitedponginterval.md b/windows.networking.sockets/streamwebsocketcontrol_actualunsolicitedponginterval.md new file mode 100644 index 0000000000..248dc095d9 --- /dev/null +++ b/windows.networking.sockets/streamwebsocketcontrol_actualunsolicitedponginterval.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.Sockets.StreamWebSocketControl.ActualUnsolicitedPongInterval +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.StreamWebSocketControl.ActualUnsolicitedPongInterval + +## -description +Allows an app to get the actual unsolicited WebSocket PONG interval. +## -property-value +System.Timespan +## -remarks +This terminology is defined in WebSocket RFC 6455, which is the time between unsolicited Pong control frames sent by the client to the server. The PONG serves as a unidirectional heartbeat and can be used for the client to determine network connection issues. + +## -see-also +[StreamWebSocket](streamwebsocket.md) +## -examples + diff --git a/windows.networking.sockets/streamwebsocketcontrol_clientcertificate.md b/windows.networking.sockets/streamwebsocketcontrol_clientcertificate.md new file mode 100644 index 0000000000..db14077beb --- /dev/null +++ b/windows.networking.sockets/streamwebsocketcontrol_clientcertificate.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Networking.Sockets.StreamWebSocketControl.ClientCertificate +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.StreamWebSocketControl.ClientCertificate + +## -description +Gets the certificate provided by the client when a secure WebSocket connection has been established. +## -property-value +The client certificate. + +## -remarks + +## -see-also +[StreamWebSocket](streamwebsocket.md) +## -examples + diff --git a/windows.networking.sockets/streamwebsocketcontrol_desiredunsolicitedponginterval.md b/windows.networking.sockets/streamwebsocketcontrol_desiredunsolicitedponginterval.md new file mode 100644 index 0000000000..c2ac1183cd --- /dev/null +++ b/windows.networking.sockets/streamwebsocketcontrol_desiredunsolicitedponginterval.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Networking.Sockets.StreamWebSocketControl.DesiredUnsolicitedPongInterval +-api-type: winrt property +--- + + + +# Windows.Networking.Sockets.StreamWebSocketControl.DesiredUnsolicitedPongInterval + +## -description +Allows an app to get and set the desired unsolicited WebSocket PONG interval. +## -property-value +System.Timespan +## -remarks +This terminology is defined in WebSocket RFC 6455, which is the time between unsolicited Pong control frames sent by the client to the server. The PONG serves as a unidirectional heartbeat and can be used for the client to determine network connection issues. +## -see-also + +## -examples + diff --git a/windows.phone.networking.voip/voipcallcoordinator_setupnewacceptedcall_1137245296.md b/windows.phone.networking.voip/voipcallcoordinator_setupnewacceptedcall_1137245296.md new file mode 100644 index 0000000000..d8c90a0404 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_setupnewacceptedcall_1137245296.md @@ -0,0 +1,41 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.SetupNewAcceptedCall(System.String,System.String,System.String,System.String,Windows.Phone.Networking.Voip.VoipCallMedia,Windows.Phone.Networking.Voip.VoipPhoneCall@) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.SetupNewAcceptedCall + +## -description +Prepares to receive a new incoming call, with the intent that the call will be accepted. + +## -parameters +### -param context +The context for the incoming call. + +### -param contactName +The name of the incoming caller. + +### -param contactNumber +The phone number of the incoming caller. + +### -param serviceName +The name of the service that the caller is using. + +### -param media +Specifies the type of media used by the call; audio, video, or none. + +### -param call +The object that represents the VoIP call. + +## -remarks + +## -see-also + +## -examples + +## capabilities +voipCall diff --git a/windows.phone.networking.voip/voipphonecall_tryshowappui_768095277.md b/windows.phone.networking.voip/voipphonecall_tryshowappui_768095277.md new file mode 100644 index 0000000000..be886739b0 --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_tryshowappui_768095277.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipPhoneCall.TryShowAppUI +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.TryShowAppUI + +## -description +Attempts to launch the app UI for handling a VoIP phone call. + +## -remarks + +## -see-also + +## -examples + +## capabilities +voipCall diff --git a/windows.security.authentication.web.provider/webaccountmanager_invalidateappcacheforaccountasync_1366384385.md b/windows.security.authentication.web.provider/webaccountmanager_invalidateappcacheforaccountasync_1366384385.md new file mode 100644 index 0000000000..2b73f4788a --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountmanager_invalidateappcacheforaccountasync_1366384385.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Security.Authentication.Web.Provider.WebAccountManager.InvalidateAppCacheForAccountAsync(Windows.Security.Credentials.WebAccount) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountManager.InvalidateAppCacheForAccountAsync + +## -description +Clears the web account manager's token cache for a specific web account. + +## -parameters +### -param webAccount +The web account for which tokens will be cleared. + +## -returns +This method does not return a value. + +## -remarks +This method should be called whenever a web account provider app detects that a token cached by the web account manager for a specific account is invalid. + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web.provider/webaccountmanager_invalidateappcacheforallaccountsasync_971965115.md b/windows.security.authentication.web.provider/webaccountmanager_invalidateappcacheforallaccountsasync_971965115.md new file mode 100644 index 0000000000..22e4b04353 --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountmanager_invalidateappcacheforallaccountsasync_971965115.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Security.Authentication.Web.Provider.WebAccountManager.InvalidateAppCacheForAllAccountsAsync +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountManager.InvalidateAppCacheForAllAccountsAsync + +## -description +Clears the web account manager's token cache for all web accounts. + +## -returns +This method does not return a value. + +## -remarks +This method should be called whenever a web account provider app detects that a token cached by the web account manager is invalid. + +## -see-also + +## -examples + diff --git a/windows.security.enterprisedata/fileprotectioninfo_isprotectwhileopensupported.md b/windows.security.enterprisedata/fileprotectioninfo_isprotectwhileopensupported.md new file mode 100644 index 0000000000..3ecb36263e --- /dev/null +++ b/windows.security.enterprisedata/fileprotectioninfo_isprotectwhileopensupported.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Security.EnterpriseData.FileProtectionInfo.IsProtectWhileOpenSupported +-api-type: winrt property +--- + + + +# Windows.Security.EnterpriseData.FileProtectionInfo.IsProtectWhileOpenSupported + +## -description +Determines whether your app can protect a file while it is open. + +## -property-value +**true** if your app can protect a file while it is open, or **false** if that capability is not supported on the device. + +## -remarks +If this property returns **true**, you can protect a file while the file is open. + +This can be useful if users open a file that is not protected and attempt to paste enterprise protected information into it. You can protect the open file and save users from having to respond to a prompt or, depending on the level of policy enforcement, save them from being blocked from pasting content completely. + +## -see-also + +## -examples diff --git a/windows.services.maps.guidance/guidanceroadsegment_isscenic.md b/windows.services.maps.guidance/guidanceroadsegment_isscenic.md new file mode 100644 index 0000000000..8d307b0013 --- /dev/null +++ b/windows.services.maps.guidance/guidanceroadsegment_isscenic.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Services.Maps.Guidance.GuidanceRoadSegment.IsScenic +-api-type: winrt property +--- + + + +# Windows.Services.Maps.Guidance.GuidanceRoadSegment.IsScenic + +## -description +Gets a value that indicates of the road segment is scenic. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the [Windows.Services.Maps.Guidance](windows_services_maps_guidance.md) namespace, please work with your Microsoft Account Team representative. + +## -property-value +**true** if the road segment is scenic; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.localsearch/placeinfohelper.md b/windows.services.maps.localsearch/placeinfohelper.md new file mode 100644 index 0000000000..d3894d6165 --- /dev/null +++ b/windows.services.maps.localsearch/placeinfohelper.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.Maps.LocalSearch.PlaceInfoHelper +-api-type: winrt class +--- + + + +# Windows.Services.Maps.LocalSearch.PlaceInfoHelper + +## -description +Creates [PlaceInfo](../windows.services.maps/placeinfo.md) instances by using businesses and places found in searches that are performed against data that has been cached locally on the device. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.localsearch/placeinfohelper_createfromlocallocation_1392739533.md b/windows.services.maps.localsearch/placeinfohelper_createfromlocallocation_1392739533.md new file mode 100644 index 0000000000..190a5ebb93 --- /dev/null +++ b/windows.services.maps.localsearch/placeinfohelper_createfromlocallocation_1392739533.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.Maps.LocalSearch.PlaceInfoHelper.CreateFromLocalLocation(Windows.Services.Maps.LocalSearch.LocalLocation) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.LocalSearch.PlaceInfoHelper.CreateFromLocalLocation + +## -description +Creates a [PlaceInfo](../windows.services.maps/placeinfo.md) instance. +## -parameters +### -param location +The location of a business or place. +## -returns +A [PlaceInfo](../windows.services.maps/placeinfo.md) that describes the business or place. +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maproute_isscenic.md b/windows.services.maps/maproute_isscenic.md new file mode 100644 index 0000000000..789a494eac --- /dev/null +++ b/windows.services.maps/maproute_isscenic.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapRoute.IsScenic +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapRoute.IsScenic + +## -description +Gets a value that indicates whether the [MapRoute](maproute.md) is based on scenic roads. + +## -property-value +**true** if the [MapRoute](maproute.md) is based on scenic roads; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maprouteoptimization.md b/windows.services.maps/maprouteoptimization.md index cc5e2e4c79..be5a9ac325 100644 --- a/windows.services.maps/maprouteoptimization.md +++ b/windows.services.maps/maprouteoptimization.md @@ -26,6 +26,9 @@ Optimize the route by minimizing the time with traffic. > Traffic-based routing is not automatically updated. To capture changes in traffic conditions, repeat the query. +### -field Scenic:3 +Optimize the route to include the most scenic roads. + ## -remarks Your [Universal Windows app](https://msdn.microsoft.com/windows/uwp/get-started/universal-application-platform-guide) must be authenticated before it can use the [MapControl](../windows.ui.xaml.controls.maps/mapcontrol.md) and map services in the [Windows.Services.Maps](windows_services_maps.md) namespace. To authenticate your app, you must specify a maps authentication key. @@ -34,4 +37,4 @@ See [Request a maps authentication key](https://msdn.microsoft.com/windows/uwp/m ## -examples ## -see-also -[Display routes and directions on a map](http://msdn.microsoft.com/library/bbb4c23a-8f10-41d1-81ea-271be01aed81) \ No newline at end of file +[Display routes and directions on a map](http://msdn.microsoft.com/library/bbb4c23a-8f10-41d1-81ea-271be01aed81) diff --git a/windows.services.maps/placeinfo.md b/windows.services.maps/placeinfo.md new file mode 100644 index 0000000000..24a4415ac1 --- /dev/null +++ b/windows.services.maps/placeinfo.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.Maps.PlaceInfo +-api-type: winrt class +--- + + + +# Windows.Services.Maps.PlaceInfo + +## -description +Displays a map location and information that describes that location in a light-dismissible window which closes automatically when the user clicks outside of the window. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_create_1128518770.md b/windows.services.maps/placeinfo_create_1128518770.md new file mode 100644 index 0000000000..3365a1ff1d --- /dev/null +++ b/windows.services.maps/placeinfo_create_1128518770.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.Create(Windows.Devices.Geolocation.Geopoint,Windows.Services.Maps.PlaceInfoCreateOptions) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.Create + +## -description +Creates a [PlaceInfo](placeinfo.md) instance. + +## -parameters +### -param referencePoint +The geographic map location that you want to show in a light-dismissible window. + +### -param options +The optional information that describes this location. This information will appear in the light-dismissible window. + +## -returns +A [PlaceInfo](placeinfo.md) instance that describes the location. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_create_1355491480.md b/windows.services.maps/placeinfo_create_1355491480.md new file mode 100644 index 0000000000..0a1511a78d --- /dev/null +++ b/windows.services.maps/placeinfo_create_1355491480.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.Create(Windows.Devices.Geolocation.Geopoint) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.Create + +## -description +Creates a [PlaceInfo](placeinfo.md) instance. + +## -parameters +### -param referencePoint +The geographic map location that you want to show in a light-dismissible window. + +## -returns +A [PlaceInfo](placeinfo.md) instance that describes the location. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_createfromidentifier_1124484256.md b/windows.services.maps/placeinfo_createfromidentifier_1124484256.md new file mode 100644 index 0000000000..cadf51f6dc --- /dev/null +++ b/windows.services.maps/placeinfo_createfromidentifier_1124484256.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.CreateFromIdentifier(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.CreateFromIdentifier + +## -description +Creates a [PlaceInfo](placeinfo.md) instance. + +## -parameters +### -param identifier +The identifier of the location. + +## -returns +A [PlaceInfo](placeinfo.md) instance that describes the location. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_createfromidentifier_958458100.md b/windows.services.maps/placeinfo_createfromidentifier_958458100.md new file mode 100644 index 0000000000..a9bfd699ff --- /dev/null +++ b/windows.services.maps/placeinfo_createfromidentifier_958458100.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.CreateFromIdentifier(System.String,Windows.Devices.Geolocation.Geopoint,Windows.Services.Maps.PlaceInfoCreateOptions) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.CreateFromIdentifier + +## -description +Creates a [PlaceInfo](placeinfo.md) instance. + +## -parameters +### -param identifier +The identifier of the location. + +### -param defaultPoint +The geographic map location that you want to show in a light-dismissible window. +>[!Note] +This value is used only if the identifier is invalid, the device is offline, or the details of the place can't be obtained by using the identifier. + +### -param options +The optional information that describes this location. This information will appear in the light-dismissible window. +>[!Note] +This value is used only if the identifier is invalid, the device is offline, or the details of the place can't be obtained by using the identifier. + +## -returns +A [PlaceInfo](placeinfo.md) instance that describes the location. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_createfrommaplocation_1468549753.md b/windows.services.maps/placeinfo_createfrommaplocation_1468549753.md new file mode 100644 index 0000000000..079b942cfd --- /dev/null +++ b/windows.services.maps/placeinfo_createfrommaplocation_1468549753.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.CreateFromMapLocation(Windows.Services.Maps.MapLocation) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.CreateFromMapLocation + +## -description +Creates a [PlaceInfo](placeinfo.md) instance. + +## -parameters +### -param location +The geographic map location that you want to show in a light-dismissible window. + +## -returns +A [PlaceInfo](placeinfo.md) instance that describes the location. + +## -remarks +You can get a [MapLocation](maplocation.md) object by using any of the methods in the [MapLocationFinder](maplocationfinder.md) class. + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_displayaddress.md b/windows.services.maps/placeinfo_displayaddress.md new file mode 100644 index 0000000000..3fffcf9c05 --- /dev/null +++ b/windows.services.maps/placeinfo_displayaddress.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfo.DisplayAddress +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfo.DisplayAddress + +## -description +Gets the address associated with the [PlaceInfo](placeinfo.md). + +## -property-value +The address associated with the [PlaceInfo](placeinfo.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_displayname.md b/windows.services.maps/placeinfo_displayname.md new file mode 100644 index 0000000000..a9318bfbb8 --- /dev/null +++ b/windows.services.maps/placeinfo_displayname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfo.DisplayName + +## -description +Gets the display name associated with the [PlaceInfo](placeinfo.md). + +## -property-value +The display name associated with the [PlaceInfo](placeinfo.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_geoshape.md b/windows.services.maps/placeinfo_geoshape.md new file mode 100644 index 0000000000..14d4b0aef0 --- /dev/null +++ b/windows.services.maps/placeinfo_geoshape.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfo.Geoshape +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfo.Geoshape + +## -description +Gets the geographical shape associated with the [PlaceInfo](placeinfo.md). + +## -property-value +The geographical shape associated with the [PlaceInfo](placeinfo.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_identifier.md b/windows.services.maps/placeinfo_identifier.md new file mode 100644 index 0000000000..b5bf1aa7f7 --- /dev/null +++ b/windows.services.maps/placeinfo_identifier.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfo.Identifier +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfo.Identifier + +## -description +Gets the identifier associated with the [PlaceInfo](placeinfo.md). + +## -property-value +Gets the identifier associated with the [PlaceInfo](placeinfo.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_isshowsupported.md b/windows.services.maps/placeinfo_isshowsupported.md new file mode 100644 index 0000000000..0e7ab149aa --- /dev/null +++ b/windows.services.maps/placeinfo_isshowsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfo.IsShowSupported +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfo.IsShowSupported + +## -description +Gets a value that indicates whether your app can show a light-dismissible window that contains a map location and related information given the current context. + +## -property-value +**true** if your app can show a light-dismissible window that contains a map location and related information given the current context; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_show_8680471.md b/windows.services.maps/placeinfo_show_8680471.md new file mode 100644 index 0000000000..8200b5ae88 --- /dev/null +++ b/windows.services.maps/placeinfo_show_8680471.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.Show(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.Show + +## -description +Shows in a light-dismissible window, the map location and related information that is described in the [PlaceInfo](placeinfo.md). + +## -parameters +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the light-dismissible window, not within that rectangular area. For example, if an app uses a button to show the place, pass the [Rect](../windows.foundation/rect.md) of the button so the light-dismissible window displays around the button, not overlapping it. + +### -param preferredPlacement +The preferred placement of the light-dismissible window relative to the rectangle. + +## -remarks +This method closes any place card UIs that are already visible. + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfo_show_97155545.md b/windows.services.maps/placeinfo_show_97155545.md new file mode 100644 index 0000000000..b474568fa7 --- /dev/null +++ b/windows.services.maps/placeinfo_show_97155545.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfo.Show(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfo.Show + +## -description +Shows in a pop-up window, the map location and related information that is described in the [PlaceInfo](placeinfo.md). + +## -parameters +### -param selection +The [Rect](../windows.foundation/rect.md) is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the light-dismissible window, not within that rectangular area. For example, if an app uses a button to show the place, pass the [Rect](../windows.foundation/rect.md) of the button so the light-dismissible window displays around the button, not overlapping it. + +## -remarks +This method closes any place card UIs that are already visible. + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfocreateoptions.md b/windows.services.maps/placeinfocreateoptions.md new file mode 100644 index 0000000000..85d1a61939 --- /dev/null +++ b/windows.services.maps/placeinfocreateoptions.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.Maps.PlaceInfoCreateOptions +-api-type: winrt class +--- + + + +# Windows.Services.Maps.PlaceInfoCreateOptions + +## -description +Represents the information about a map location that your app can show in a plight-dismissible window within your app. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfocreateoptions_displayaddress.md b/windows.services.maps/placeinfocreateoptions_displayaddress.md new file mode 100644 index 0000000000..c62d44618e --- /dev/null +++ b/windows.services.maps/placeinfocreateoptions_displayaddress.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfoCreateOptions.DisplayAddress +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfoCreateOptions.DisplayAddress + +## -description +Gets the address associated with the [PlaceInfoCreateOptions](placeinfocreateoptions.md). + +## -property-value +The address associated with the [PlaceInfoCreateOptions](placeinfocreateoptions.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfocreateoptions_displayname.md b/windows.services.maps/placeinfocreateoptions_displayname.md new file mode 100644 index 0000000000..fcbb2e565b --- /dev/null +++ b/windows.services.maps/placeinfocreateoptions_displayname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.PlaceInfoCreateOptions.DisplayName +-api-type: winrt property +--- + + + +# Windows.Services.Maps.PlaceInfoCreateOptions.DisplayName + +## -description +Gets the display name associated with the [PlaceInfoCreateOptions](placeinfocreateoptions.md). + +## -property-value +The display name associated with the [PlaceInfoCreateOptions](placeinfocreateoptions.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/placeinfocreateoptions_placeinfocreateoptions_1221375020.md b/windows.services.maps/placeinfocreateoptions_placeinfocreateoptions_1221375020.md new file mode 100644 index 0000000000..0867f05765 --- /dev/null +++ b/windows.services.maps/placeinfocreateoptions_placeinfocreateoptions_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.Services.Maps.PlaceInfoCreateOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.Services.Maps.PlaceInfoCreateOptions.PlaceInfoCreateOptions + +## -description +Creates a [PlaceInfoCreateOptions](placeinfocreateoptions.md) instance. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.storage.provider/hydrationpolicy.md b/windows.storage.provider/hydrationpolicy.md new file mode 100644 index 0000000000..ba72bd46b6 --- /dev/null +++ b/windows.storage.provider/hydrationpolicy.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.Storage.Provider.HydrationPolicy +-api-type: winrt enum +--- + + + +# Windows.Storage.Provider.HydrationPolicy + +## -description +An enumeration of file hydration policy values for a cloud based file. The hydration policy allows a sync root to customize behavior for retrieving data for a placeholder file. + +## -enum-fields +### -field OnDemand:0 +Hyrdration is performed at the user's request. + +### -field Progressive:1 +Gradual hyrdration is performed. + +### -field Full:2 +Full hydration is performed. + +### -field NoPartial:3 +Legacy file hydration. + +## -remarks + +## -see-also + +## -examples + + diff --git a/windows.storage.provider/hydrationpolicymodifier.md b/windows.storage.provider/hydrationpolicymodifier.md new file mode 100644 index 0000000000..2a3d234892 --- /dev/null +++ b/windows.storage.provider/hydrationpolicymodifier.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Storage.Provider.HydrationPolicyModifier +-api-type: winrt enum +--- + + + +# Windows.Storage.Provider.HydrationPolicyModifier + +## -description +Specifies conditions for file hydration. + +## -enum-fields +### -field None:0 +No modifiers. + +### -field ValidationRequired:1 +Once the data is hydrated into the file, it will be validated. + +### -field StreamingAllowed:2 +Streaming is allowed for file hydration. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/insyncpolicy.md b/windows.storage.provider/insyncpolicy.md new file mode 100644 index 0000000000..c391e0e76a --- /dev/null +++ b/windows.storage.provider/insyncpolicy.md @@ -0,0 +1,52 @@ +--- +-api-id: T:Windows.Storage.Provider.InSyncPolicy +-api-type: winrt enum +--- + + + +# Windows.Storage.Provider.InSyncPolicy + +## -description +Contains the file and directory attributes supported by the sync root. + +## -enum-fields +### -field Default:0 +The default sync policy value. + +### -field FileCreationTime:1 +The file creation time. + +### -field FileReadOnlyAttribute:2 +Read-only attribute of a file. + +### -field FileHiddenAttribute:4 +Hidden attribute of a file. + +### -field FileSystemAttribute:8 +System attribute of a file. + +### -field DirectoryCreationTime:16 +The directory creation time. + +### -field DirectoryReadOnlyAttribute:32 +Read-only attribute of a directory. + +### -field DirectoryHiddenAttribute:64 +Hidden attribute of a directory. + +### -field DirectorySystemAttribute:128 +System attribute of a file. + +### -field PreserveInsyncForSyncEngine:2147483648 +Value reserved for the sync engine. + +## -remarks + +## -see-also +[FileAttributes Enumeration](https://msdn.microsoft.com/library/system.io.fileattributes.aspx) + +## -examples + diff --git a/windows.storage.provider/istorageprovideritempropertysource.md b/windows.storage.provider/istorageprovideritempropertysource.md new file mode 100644 index 0000000000..be47ff4258 --- /dev/null +++ b/windows.storage.provider/istorageprovideritempropertysource.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.IStorageProviderItemPropertySource +-api-type: winrt interface +--- + + + +# Windows.Storage.Provider.IStorageProviderItemPropertySource + +## -description +Provides access to storage provider item propeties from the sync root. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/istorageprovideritempropertysource_getitemproperties_1125226903.md b/windows.storage.provider/istorageprovideritempropertysource_getitemproperties_1125226903.md new file mode 100644 index 0000000000..3115b65939 --- /dev/null +++ b/windows.storage.provider/istorageprovideritempropertysource_getitemproperties_1125226903.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Storage.Provider.IStorageProviderItemPropertySource.GetItemProperties(System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.IStorageProviderItemPropertySource.GetItemProperties + +## -description +Gets a list of item properties for a storage provider. + +## -parameters +### -param itemPath +A path to the storage item. + +## -returns +A list of item properties from the storage provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/istorageproviderpropertycapabilities.md b/windows.storage.provider/istorageproviderpropertycapabilities.md new file mode 100644 index 0000000000..2551b47d03 --- /dev/null +++ b/windows.storage.provider/istorageproviderpropertycapabilities.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.IStorageProviderPropertyCapabilities +-api-type: winrt interface +--- + + + +# Windows.Storage.Provider.IStorageProviderPropertyCapabilities + +## -description +Provides access to the property capabilities supported by the sync root. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/istorageproviderpropertycapabilities_ispropertysupported_2031512709.md b/windows.storage.provider/istorageproviderpropertycapabilities_ispropertysupported_2031512709.md new file mode 100644 index 0000000000..67d7034a0c --- /dev/null +++ b/windows.storage.provider/istorageproviderpropertycapabilities_ispropertysupported_2031512709.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Storage.Provider.IStorageProviderPropertyCapabilities.IsPropertySupported(System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.IStorageProviderPropertyCapabilities.IsPropertySupported + +## -description +Determines whether a property is supported by the sync root. + +## -parameters +### -param propertyCanonicalName +The name of the property. E.g., "System.Photo.DateTaken" + +## -returns +**True** if the property is supported by the sync root; **False** otherwise + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/populationpolicy.md b/windows.storage.provider/populationpolicy.md new file mode 100644 index 0000000000..f9cee696e0 --- /dev/null +++ b/windows.storage.provider/populationpolicy.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Storage.Provider.PopulationPolicy +-api-type: winrt enum +--- + + + +# Windows.Storage.Provider.PopulationPolicy + +## -description +An enumeration for the file population values from the sync root. + +## -enum-fields +### -field Full:1 +Full file population. + +### -field NoPartial:2 +Legacy file population. + +## -remarks + +## -see-also + +## -examples + + + diff --git a/windows.storage.provider/protectionmode.md b/windows.storage.provider/protectionmode.md new file mode 100644 index 0000000000..e5f3204ad0 --- /dev/null +++ b/windows.storage.provider/protectionmode.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Storage.Provider.ProtectionMode +-api-type: winrt enum +--- + + + +# Windows.Storage.Provider.ProtectionMode + +## -description +Indicates the type of data contained in the sync root. + +## -enum-fields +### -field Unknown:0 +The sync root can contain any type of file. + +### -field Personal:1 +The sync root should only contain personal files, not encrypted or business related files. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperties.md b/windows.storage.provider/storageprovideritemproperties.md new file mode 100644 index 0000000000..fbab02bcd7 --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperties.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.StorageProviderItemProperties +-api-type: winrt class +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperties + +## -description +Provides access to the properties of a Cloud Storage Provider storage item (like a file or folder). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperties_setasync_309680467.md b/windows.storage.provider/storageprovideritemproperties_setasync_309680467.md new file mode 100644 index 0000000000..cdacbdd811 --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperties_setasync_309680467.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderItemProperties.SetAsync(Windows.Storage.IStorageItem,Windows.Foundation.Collections.IIterable{Windows.Storage.Provider.StorageProviderItemProperty}) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperties.SetAsync + +## -description +Sets custom property values of a storage item. + +## -parameters +### -param item +The storage item. + +### -param itemProperties +An iterable list of the [StorageProviderItemProperty](StorageProviderItemProperty.md) states for the storage item. + +## -returns +An asynchronous action. If you use [Asynchronous programming](https://docs.microsoft.com/windows/uwp/threading-async/asynchronous-programming-universal-windows-platform-apps), the return type is void. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperty.md b/windows.storage.provider/storageprovideritemproperty.md new file mode 100644 index 0000000000..3372a1a971 --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperty.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.StorageProviderItemProperty +-api-type: winrt class +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperty + +## -description +Defines a Cloud Storage Provider property for a storage item (like a file or folder). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperty_iconresource.md b/windows.storage.provider/storageprovideritemproperty_iconresource.md new file mode 100644 index 0000000000..1cce51ef5d --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperty_iconresource.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderItemProperty.IconResource +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperty.IconResource + +## -description +A reference to an icon resource for a Cloud Storage provider property. + +## -property-value +A string value of a reference to an icon resouce. E.g., "SyncProviderResources.dll, -1234" + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperty_id.md b/windows.storage.provider/storageprovideritemproperty_id.md new file mode 100644 index 0000000000..a59efca16d --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperty_id.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderItemProperty.Id +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperty.Id + +## -description +The Id for a storage item provided by the Cloud Storage Provider. + +## -property-value +The Id for the storage item. + +## -remarks +This Id value must match the value provided for [StorageProviderItemPropertyDefinition.Id](storageprovideritempropertydefinition_id.md). + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperty_storageprovideritemproperty_1221375020.md b/windows.storage.provider/storageprovideritemproperty_storageprovideritemproperty_1221375020.md new file mode 100644 index 0000000000..be3730324d --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperty_storageprovideritemproperty_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderItemProperty.#ctor +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperty.StorageProviderItemProperty + +## -description +A StorageProviderItemProperty default constructor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritemproperty_value.md b/windows.storage.provider/storageprovideritemproperty_value.md new file mode 100644 index 0000000000..1cb635ad3b --- /dev/null +++ b/windows.storage.provider/storageprovideritemproperty_value.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderItemProperty.Value +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderItemProperty.Value + +## -description +Descriptive text for the state of a storage provider storage item. + +## -property-value +The string value of the text. + +## -remarks +Values are intended to be used to describe the state of a storage item. For example, in addition to an icon, you might also want to create a string, such as "Large size alert" or "Shared with Bob" + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritempropertydefinition.md b/windows.storage.provider/storageprovideritempropertydefinition.md new file mode 100644 index 0000000000..8808671725 --- /dev/null +++ b/windows.storage.provider/storageprovideritempropertydefinition.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.StorageProviderItemPropertyDefinition +-api-type: winrt class +--- + + + +# Windows.Storage.Provider.StorageProviderItemPropertyDefinition + +## -description +Defines the properties of an item from a Cloud Storage Provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritempropertydefinition_displaynameresource.md b/windows.storage.provider/storageprovideritempropertydefinition_displaynameresource.md new file mode 100644 index 0000000000..9e0c378ee0 --- /dev/null +++ b/windows.storage.provider/storageprovideritempropertydefinition_displaynameresource.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderItemPropertyDefinition.DisplayNameResource +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderItemPropertyDefinition.DisplayNameResource + +## -description +Gets or sets the display name of a Cloud Storage Provider state. + +## -property-value +A string value for the state display name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritempropertydefinition_id.md b/windows.storage.provider/storageprovideritempropertydefinition_id.md new file mode 100644 index 0000000000..c4a7b2c1e9 --- /dev/null +++ b/windows.storage.provider/storageprovideritempropertydefinition_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderItemPropertyDefinition.Id +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderItemPropertyDefinition.Id + +## -description +An Id for a storage item provided by the Cloud Storage Provider when the sync root is registered. + +## -property-value +The Id number for the storage item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovideritempropertydefinition_storageprovideritempropertydefinition_1221375020.md b/windows.storage.provider/storageprovideritempropertydefinition_storageprovideritempropertydefinition_1221375020.md new file mode 100644 index 0000000000..5bde00fa84 --- /dev/null +++ b/windows.storage.provider/storageprovideritempropertydefinition_storageprovideritempropertydefinition_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderItemPropertyDefinition.#ctor +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderItemPropertyDefinition.StorageProviderItemPropertyDefinition + +## -description +A StorageProviderItemPropertyDefinition default constructor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo.md b/windows.storage.provider/storageprovidersyncrootinfo.md new file mode 100644 index 0000000000..9b644d7ab1 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.StorageProviderSyncRootInfo +-api-type: winrt class +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo + +## -description +Contains the properties of a Cloud Storage Provider's sync root to be registered with the operating system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_allowpinning.md b/windows.storage.provider/storageprovidersyncrootinfo_allowpinning.md new file mode 100644 index 0000000000..62f75d9bc6 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_allowpinning.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.AllowPinning +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.AllowPinning + +## -description +Enables or disables the ability for files to be made available offline. + +## -property-value +**True** if pinning is enabled; **False** otherwise + +## -remarks +Pinning refers to a file being made available offline. + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_context.md b/windows.storage.provider/storageprovidersyncrootinfo_context.md new file mode 100644 index 0000000000..d9f8c535c7 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_context.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.Context +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.Context + +## -description +Contains the sync root identity information. + +## -property-value +A buffer containing the sync root identity. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_displaynameresource.md b/windows.storage.provider/storageprovidersyncrootinfo_displaynameresource.md new file mode 100644 index 0000000000..33ccb7694a --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_displaynameresource.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.DisplayNameResource +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.DisplayNameResource + +## -description +An optional display name that maps to the existing sync root registration. + +## -property-value +The display name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_hydrationpolicy.md b/windows.storage.provider/storageprovidersyncrootinfo_hydrationpolicy.md new file mode 100644 index 0000000000..9562e07b00 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_hydrationpolicy.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.HydrationPolicy +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.HydrationPolicy + +## -description +The hydration policy of the sync root registration. + +## -property-value +A [hydration policy](hydrationpolicy.md) enum value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_hydrationpolicymodifier.md b/windows.storage.provider/storageprovidersyncrootinfo_hydrationpolicymodifier.md new file mode 100644 index 0000000000..12d562d14c --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_hydrationpolicymodifier.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.HydrationPolicyModifier +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.HydrationPolicyModifier + +## -description +The hydration policy modifier of the sync root registration. + +## -property-value +A [hydration policy modifier](hydrationpolicymodifier.md) enum value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_iconresource.md b/windows.storage.provider/storageprovidersyncrootinfo_iconresource.md new file mode 100644 index 0000000000..6fcd1e2f2d --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_iconresource.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.IconResource +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.IconResource + +## -description +A path to an icon resource for the custom state of a file or folder. + +## -property-value +The path to the icon resource, e.g. "SyncProvider.dll,-100", or "SyncProvider.dll,-101" + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_id.md b/windows.storage.provider/storageprovidersyncrootinfo_id.md new file mode 100644 index 0000000000..aff2b21ae1 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_id.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.Id +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.Id + +## -description +An identifier for the sync root. + +## -property-value +An identifier in the form: [Storage Provider ID]![Windows SID]![Account ID] + +## -remarks +An example of an ID might look something like: "OneDrive!S-1-1234!Personal" + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_insyncpolicy.md b/windows.storage.provider/storageprovidersyncrootinfo_insyncpolicy.md new file mode 100644 index 0000000000..2e9c8cb20a --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_insyncpolicy.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.InSyncPolicy +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.InSyncPolicy + +## -description +Provides access to the sync policy for the Cloud Storage Provider. + +## -property-value +The sync policy value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_path.md b/windows.storage.provider/storageprovidersyncrootinfo_path.md new file mode 100644 index 0000000000..0358740ced --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_path.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.Path +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.Path + +## -description +A storage folder that represents the path to the root of the cloud based folder system. + +## -property-value +A storage folder. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_populationpolicy.md b/windows.storage.provider/storageprovidersyncrootinfo_populationpolicy.md new file mode 100644 index 0000000000..90ceba8f8f --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_populationpolicy.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.PopulationPolicy +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.PopulationPolicy + +## -description +The population policy of the sync root registration. + +## -property-value +A [population policy](populationpolicy.md) enum value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_protectionmode.md b/windows.storage.provider/storageprovidersyncrootinfo_protectionmode.md new file mode 100644 index 0000000000..9644f4f15c --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_protectionmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.ProtectionMode +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.ProtectionMode + +## -description +The protection mode of the sync root registration. + +## -property-value +A [protection mode](protectionmode.md) enum value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_recyclebinuri.md b/windows.storage.provider/storageprovidersyncrootinfo_recyclebinuri.md new file mode 100644 index 0000000000..b817eb64b9 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_recyclebinuri.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.RecycleBinUri +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.RecycleBinUri + +## -description +A Uri to a cloud storage recycle bin. + +## -property-value +The Uri to the recycle bin. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_showsiblingsasgroup.md b/windows.storage.provider/storageprovidersyncrootinfo_showsiblingsasgroup.md new file mode 100644 index 0000000000..182c1a8bae --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_showsiblingsasgroup.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.ShowSiblingsAsGroup +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.ShowSiblingsAsGroup + +## -description +Shows sibling sync roots listed under the main sync root in the File Explorer. + +## -property-value +**True** if the sibling sync roots are shown, **False** otherwise + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_storageprovideritempropertydefinitions.md b/windows.storage.provider/storageprovidersyncrootinfo_storageprovideritempropertydefinitions.md new file mode 100644 index 0000000000..97e165ddc7 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_storageprovideritempropertydefinitions.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.StorageProviderItemPropertyDefinitions +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.StorageProviderItemPropertyDefinitions + +## -description +Gets the StorageProviderItemPropertyDefinition information for a sync root. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_storageprovidersyncrootinfo_1221375020.md b/windows.storage.provider/storageprovidersyncrootinfo_storageprovidersyncrootinfo_1221375020.md new file mode 100644 index 0000000000..d969e6386f --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_storageprovidersyncrootinfo_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderSyncRootInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.StorageProviderSyncRootInfo + +## -description +A StorageProviderSyncRootInfo default constructor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootinfo_version.md b/windows.storage.provider/storageprovidersyncrootinfo_version.md new file mode 100644 index 0000000000..81de7a1d69 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootinfo_version.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Storage.Provider.StorageProviderSyncRootInfo.Version +-api-type: winrt property +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootInfo.Version + +## -description +The version number of the sync root. + +## -property-value +A string value for the version number. E.g., "1.0" + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootmanager.md b/windows.storage.provider/storageprovidersyncrootmanager.md new file mode 100644 index 0000000000..4b7892805b --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Storage.Provider.StorageProviderSyncRootManager +-api-type: winrt class +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootManager + +## -description +Provides the ability to register or unregister a Cloud Storage Provider sync root with the operating system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootmanager_getcurrentsyncroots_476876826.md b/windows.storage.provider/storageprovidersyncrootmanager_getcurrentsyncroots_476876826.md new file mode 100644 index 0000000000..be978e8e54 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootmanager_getcurrentsyncroots_476876826.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderSyncRootManager.GetCurrentSyncRoots +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootManager.GetCurrentSyncRoots + +## -description +Gets all of the currently registered sync roots. + +## -returns +A collection of currently registered sync roots. + +## -remarks +This collection can include both legacy sync roots and sync roots registered with [SyncRootManager.Register(SyncRootInformation)](syncrootmanager_register_988394462.md). + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootmanager_getsyncrootinformationforfolder_2052089877.md b/windows.storage.provider/storageprovidersyncrootmanager_getsyncrootinformationforfolder_2052089877.md new file mode 100644 index 0000000000..403a5ea3b6 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootmanager_getsyncrootinformationforfolder_2052089877.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderSyncRootManager.GetSyncRootInformationForFolder(Windows.Storage.IStorageFolder) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootManager.GetSyncRootInformationForFolder + +## -description +Returns [SyncRootInformation](syncrootinformation.md) given a storage folder. + +## -parameters +### -param folder +The storage folder for the sync root. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootmanager_getsyncrootinformationforid_463025647.md b/windows.storage.provider/storageprovidersyncrootmanager_getsyncrootinformationforid_463025647.md new file mode 100644 index 0000000000..f7e074bbb2 --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootmanager_getsyncrootinformationforid_463025647.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderSyncRootManager.GetSyncRootInformationForId(System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootManager.GetSyncRootInformationForId + +## -description +Returns [StorageProviderSyncRootInfo](StorageProviderSyncRootInfo.md) given a sync root [Id](StorageProviderSyncRootInfo_id.md). + +## -parameters +### -param id +A string value of the sync root Id. + +## -returns +[StorageProviderSyncRootInfo](StorageProviderSyncRootInfo.md) for the specified sync root. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.provider/storageprovidersyncrootmanager_register_1146790023.md b/windows.storage.provider/storageprovidersyncrootmanager_register_1146790023.md new file mode 100644 index 0000000000..83a87c034d --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootmanager_register_1146790023.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderSyncRootManager.Register(Windows.Storage.Provider.StorageProviderSyncRootInfo) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootManager.Register + +## -description +Registers a sync root with the operating system. + +## -parameters +### -param syncRootInformation +The sync root to register. + +## -remarks +Multiple sync roots cannot be registered with the same [path](syncrootinformation_path.md). + +## -see-also + +## -examples diff --git a/windows.storage.provider/storageprovidersyncrootmanager_unregister_1011759375.md b/windows.storage.provider/storageprovidersyncrootmanager_unregister_1011759375.md new file mode 100644 index 0000000000..efe83b412f --- /dev/null +++ b/windows.storage.provider/storageprovidersyncrootmanager_unregister_1011759375.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Storage.Provider.StorageProviderSyncRootManager.Unregister(System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.Provider.StorageProviderSyncRootManager.Unregister + +## -description +Unregisters a sync root from the operating system. + +## -parameters +### -param id +The Id of the sync root to unregister. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.search/indexeroption.md b/windows.storage.search/indexeroption.md index 8343f8929c..eb679f2ecc 100644 --- a/windows.storage.search/indexeroption.md +++ b/windows.storage.search/indexeroption.md @@ -22,9 +22,11 @@ Use only indexed content and ignore content that has not been indexed. ### -field DoNotUseIndexer:2 Access the file system directly; don't use the system index. +### -field OnlyUseIndexerAndOptimizeForIndexedProperties:3 +Only returns the properties specified in [QueryOptions.SetPropertyPrefetch](queryoptions_setpropertyprefetch_770511515.md) for faster results. ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.storage.streams/fileopendisposition.md b/windows.storage.streams/fileopendisposition.md new file mode 100644 index 0000000000..1429fa1d7b --- /dev/null +++ b/windows.storage.streams/fileopendisposition.md @@ -0,0 +1,37 @@ +--- +-api-id: T:Windows.Storage.Streams.FileOpenDisposition +-api-type: winrt enum +--- + + + +# Windows.Storage.Streams.FileOpenDisposition + +## -description +Enumeration values for actions to take on a file. + +## -enum-fields +### -field OpenExisting:0 +Opens a file only if it exists. + +### -field OpenAlways:1 +Opens a file. If the file does not exist, a new file will be created and opened. + +### -field CreateNew:2 +Creates a new file if one does not exist. If the file does exist, this will fail. + +### -field CreateAlways:3 +Opens a file and truncates it so that its size is zero bytes. If the file does not exist, a new file will be created and opened. + +### -field TruncateExisting:4 +Opens a file and truncates it so that its size is zero bytes. If the file does not exist, this will fail. + +## -remarks +The results of the FileOpenDisposition values depend on whether the file exists or not. + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_openasync_2080890971.md b/windows.storage.streams/filerandomaccessstream_openasync_2080890971.md new file mode 100644 index 0000000000..ecdc2bc772 --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_openasync_2080890971.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenAsync(System.String,Windows.Storage.FileAccessMode) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenAsync + +## -description +Opens a stream to an existing file given the file's path. + +## -parameters +### -param filePath +A path to the file to be opened. + +### -param accessMode +The permissions level to open the stream with. + +## -returns +A stream to the specified file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_openasync_612082505.md b/windows.storage.streams/filerandomaccessstream_openasync_612082505.md new file mode 100644 index 0000000000..0cf9b0c58e --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_openasync_612082505.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenAsync(System.String,Windows.Storage.FileAccessMode,Windows.Storage.StorageOpenOptions,Windows.Storage.Streams.FileOpenDisposition) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenAsync + +## -description +Opens a stream to a file given a file path. If the file does not exist, it can be created using FileOpenDisposition. + +## -parameters +### -param filePath +A path to the file to be opened. + +### -param accessMode +The permissions level to open the stream with. + +### -param sharingOptions +A bitwise combination of the enumeration values that specify options for opening the stream. + +### -param openDisposition +An action to take on the file. + +## -returns +A stream to the specified file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_openforuserasync_1575538143.md b/windows.storage.streams/filerandomaccessstream_openforuserasync_1575538143.md new file mode 100644 index 0000000000..1a28d65d4d --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_openforuserasync_1575538143.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenForUserAsync(Windows.System.User,System.String,Windows.Storage.FileAccessMode,Windows.Storage.StorageOpenOptions,Windows.Storage.Streams.FileOpenDisposition) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenForUserAsync + +## -description +Opens a stream for a user to a file given a file path and the user's information. If the file does not exist, it can be created using FileOpenDisposition. + +## -parameters +### -param user +The user account for opening the stream. + +### -param filePath +A path to the file to be opened. + +### -param accessMode +The permissions level to open the stream with. + +### -param sharingOptions +A bitwise combination of the enumeration values that specify options for opening the stream. + +### -param openDisposition +An action to take on the file. + +## -returns +A stream to the specified file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_openforuserasync_317699079.md b/windows.storage.streams/filerandomaccessstream_openforuserasync_317699079.md new file mode 100644 index 0000000000..38d2354f38 --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_openforuserasync_317699079.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenForUserAsync(Windows.System.User,System.String,Windows.Storage.FileAccessMode) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenForUserAsync + +## -description +Opens a stream for a user to an existing file given the file path and the user's information. + +## -parameters +### -param user +The user account for opening the stream. + +### -param filePath +A path to the file to be opened. + +### -param accessMode +The permissions level to open the stream with. + +## -returns +A stream to the specified file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_opentransactedwriteasync_1463017673.md b/windows.storage.streams/filerandomaccessstream_opentransactedwriteasync_1463017673.md new file mode 100644 index 0000000000..cedaa5670f --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_opentransactedwriteasync_1463017673.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteAsync(System.String,Windows.Storage.StorageOpenOptions,Windows.Storage.Streams.FileOpenDisposition) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteAsync + +## -description +Opens a stream for writing to a file given a file path. If the file does not exist, it can be created using FileOpenDisposition. + +## -parameters +### -param filePath +A path to the file to be opened. + +### -param openOptions +A bitwise combination of the enumeration values that specify options for opening the stream. + +### -param openDisposition +An action to take on the file. + +## -returns +When this method completes, it returns a [StorageStreamTransaction](https://docs.microsoft.com/uwp/api/windows.storage.storagestreamtransaction) containing the random-access stream and methods that can be used to complete transactions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_opentransactedwriteasync_2064499009.md b/windows.storage.streams/filerandomaccessstream_opentransactedwriteasync_2064499009.md new file mode 100644 index 0000000000..14a17dd5a1 --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_opentransactedwriteasync_2064499009.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteAsync + +## -description +Opens a stream for writing to an existing file given the file's path. + +## -parameters +### -param filePath +A path to the file to be opened. + +## -returns +When this method completes, it returns a [StorageStreamTransaction](https://docs.microsoft.com/uwp/api/windows.storage.storagestreamtransaction) containing the random-access stream and methods that can be used to complete transactions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_opentransactedwriteforuserasync_2026388717.md b/windows.storage.streams/filerandomaccessstream_opentransactedwriteforuserasync_2026388717.md new file mode 100644 index 0000000000..63cec90820 --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_opentransactedwriteforuserasync_2026388717.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteForUserAsync(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteForUserAsync + +## -description +Opens a writable stream for a user to an existing file given the file's path and the user's information. + +## -parameters +### -param user +The user account for opening the stream. + +### -param filePath +A path to the file to be opened. + +## -returns +When this method completes, it returns a [StorageStreamTransaction](https://docs.microsoft.com/uwp/api/windows.storage.storagestreamtransaction) containing the random-access stream and methods that can be used to complete transactions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.streams/filerandomaccessstream_opentransactedwriteforuserasync_548700159.md b/windows.storage.streams/filerandomaccessstream_opentransactedwriteforuserasync_548700159.md new file mode 100644 index 0000000000..447894693b --- /dev/null +++ b/windows.storage.streams/filerandomaccessstream_opentransactedwriteforuserasync_548700159.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteForUserAsync(Windows.System.User,System.String,Windows.Storage.StorageOpenOptions,Windows.Storage.Streams.FileOpenDisposition) +-api-type: winrt method +--- + + + +# Windows.Storage.Streams.FileRandomAccessStream.OpenTransactedWriteForUserAsync + +## -description +Opens a writable stream for a user to a file given a file path and the user's information. If the file does not exist, it can be created using FileOpenDisposition. + +## -parameters +### -param user +The user account for opening the stream. + +### -param filePath +A path to the file to be opened. + +### -param openOptions +A bitwise combination of the enumeration values that specify options for opening the stream. + +### -param openDisposition +An action to take on the file. + +## -returns +When this method completes, it returns a [StorageStreamTransaction](https://docs.microsoft.com/uwp/api/windows.storage.storagestreamtransaction) containing the random-access stream and methods that can be used to complete transactions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage/storagelibrary_arefoldersuggestionsavailableasync_1288155017.md b/windows.storage/storagelibrary_arefoldersuggestionsavailableasync_1288155017.md index ca0b1ed7e2..cf54d62c59 100644 --- a/windows.storage/storagelibrary_arefoldersuggestionsavailableasync_1288155017.md +++ b/windows.storage/storagelibrary_arefoldersuggestionsavailableasync_1288155017.md @@ -1,21 +1,63 @@ ---- --api-id: M:Windows.Storage.StorageLibrary.AreFolderSuggestionsAvailableAsync --api-type: winrt method ---- - +--- +-api-id: M:Windows.Storage.StorageLibrary.AreFolderSuggestionsAvailableAsync +-api-type: winrt method +--- + -# Windows.Storage.StorageLibrary.AreFolderSuggestionsAvailableAsync - +# Windows.Storage.StorageLibrary.AreFolderSuggestionsAvailableAsync + ## -description +Determines if there are suggestions for placing your content in a new or existing folder within the StorageLibrary. ## -returns +**True** if there are folder suggestions; **False** otherwise ## -remarks +If this feature is not supported on your version of Windows, the method will return **false**. ## -see-also ## -examples +This example demonstrates how to determine whether the content in your Pictures library has any folder suggestions. + +```csharp +private async Task SetupPicturesLibraryAsync() +{ + if (this.picturesLibrary == null) + { + this.picturesLibrary = await StorageLibrary.GetLibraryAsync(KnownLibraryId.Pictures); + this.picturesLibrary.DefinitionChanged += PicturesLibrary_DefinitionChanged; + } + return this.picturesLibrary; +} + +private async void CheckForFolderSuggestions_Clicked(object sender, RoutedEventArgs e) +{ + var library = await SetupPicturesLibraryAsync(); + + if (await library.AreFolderSuggestionsAvailableAsync()) + { + // There are new folders that could be added to the library. + // Prompt the user to add one or more of them. + + // Note that the RequestAddFolderAsync method returns only one folder. + // If the user adds multiple folders, only one will be returned. + // In this example, to keep track of all the added folders, the app can subscribe to the + // StorageLibrary.DefinitionChanged event by awaiting library.RequestAddFolderAsync(); + } +} + +private void PicturesLibrary_DefinitionChanged(StorageLibrary sender, object args) +{ + foreach (StorageFolder folder in sender.Folders) + { + // Do something with every folder in the library + } +} +``` +> [!NOTE] +> Don't forget to include the **picturesLibrary** capability in your app's package manifest. For more information on Capabilities in the manifest, see [App capability declarations](https://docs.microsoft.com/windows/uwp/packaging/app-capability-declarations). \ No newline at end of file diff --git a/windows.storage/storageprovider_ispropertysupportedforpartialfileasync_2060468245.md b/windows.storage/storageprovider_ispropertysupportedforpartialfileasync_2060468245.md new file mode 100644 index 0000000000..3235097392 --- /dev/null +++ b/windows.storage/storageprovider_ispropertysupportedforpartialfileasync_2060468245.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Storage.StorageProvider.IsPropertySupportedForPartialFileAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Storage.StorageProvider.IsPropertySupportedForPartialFileAsync + +## -description +Determines if a property is supported by a cloud storage provider. + +## -parameters +### -param propertyCanonicalName +The name of the property. E.g., "System.Photo.DateTaken" or "System.Music.Artist" + +## -returns +**True** if the property is supported by the cloud storage provider; **False** otherwise + +## -remarks + +## -see-also +[Windows Properties](https://msdn.microsoft.com/library/7532e58f-bbf2-4e36-9d81-c8e04b92cb7c) +[SystemProperties class](https://docs.microsoft.com/uwp/api/windows.storage.systemproperties) + +## -examples + diff --git a/windows.system.diagnostics/diagnosticactionresult.md b/windows.system.diagnostics/diagnosticactionresult.md new file mode 100644 index 0000000000..dee57ace17 --- /dev/null +++ b/windows.system.diagnostics/diagnosticactionresult.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.Diagnostics.DiagnosticActionResult +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.DiagnosticActionResult + +## -description +Represents a property bag containing the results of a diagnostic action. + +## -remarks +This API requires the **Diagnostics** capability. + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticactionresult_extendederror.md b/windows.system.diagnostics/diagnosticactionresult_extendederror.md new file mode 100644 index 0000000000..6a09634be3 --- /dev/null +++ b/windows.system.diagnostics/diagnosticactionresult_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.DiagnosticActionResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.DiagnosticActionResult.ExtendedError + +## -description +Contains extended error data about a diagnostic action. + +## -property-value +An **HRESULT** containing the error data. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticactionresult_results.md b/windows.system.diagnostics/diagnosticactionresult_results.md new file mode 100644 index 0000000000..a8b8d165a2 --- /dev/null +++ b/windows.system.diagnostics/diagnosticactionresult_results.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.DiagnosticActionResult.Results +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.DiagnosticActionResult.Results + +## -description +Contains the results of executing a diagnostics troubleshooting package. + +## -property-value +Key-value pair containing the results, such as root causes, resolutions, and so on. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticactionstate.md b/windows.system.diagnostics/diagnosticactionstate.md new file mode 100644 index 0000000000..9ac3644c9d --- /dev/null +++ b/windows.system.diagnostics/diagnosticactionstate.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.System.Diagnostics.DiagnosticActionState +-api-type: winrt enum +--- + + + +# Windows.System.Diagnostics.DiagnosticActionState + +## -description +Indicates the current state of the execution of a diagnostics troubleshooting package. + +## -enum-fields +### -field Initializing:0 +The diagnostics run is initializing. + +### -field Downloading:1 +The diagnostics run is downloading the troubleshooting package. + +### -field VerifyingTrust:2 +The diagnostics run is verifying trust of the downloaded troubleshooting package. + +### -field Detecting:3 +The diagnostics run is detecting. + +### -field Resolving:4 +The diagnostics run is resolving. + +### -field VerifyingResolution:5 +The diagnostics run is verifying resolution. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticinvoker.md b/windows.system.diagnostics/diagnosticinvoker.md new file mode 100644 index 0000000000..948c27795a --- /dev/null +++ b/windows.system.diagnostics/diagnosticinvoker.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.Diagnostics.DiagnosticInvoker +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.DiagnosticInvoker + +## -description +Contains functionality for executing a diagnostics troubleshooting package. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system.diagnostics/diagnosticinvoker_getdefault_846721868.md b/windows.system.diagnostics/diagnosticinvoker_getdefault_846721868.md new file mode 100644 index 0000000000..6de072064f --- /dev/null +++ b/windows.system.diagnostics/diagnosticinvoker_getdefault_846721868.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.Diagnostics.DiagnosticInvoker.GetDefault +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.DiagnosticInvoker.GetDefault + +## -description +Gets the default diagnostics invoker. + +## -returns +Returns the default diagnostics invoker. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticinvoker_getforuser_2058550280.md b/windows.system.diagnostics/diagnosticinvoker_getforuser_2058550280.md new file mode 100644 index 0000000000..815c967c6d --- /dev/null +++ b/windows.system.diagnostics/diagnosticinvoker_getforuser_2058550280.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.System.Diagnostics.DiagnosticInvoker.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.DiagnosticInvoker.GetForUser + +## -description +Gets the diagnostics invoker for the specified user. + +## -parameters +### -param user +The user for which to get the diagnostics invoker. + +## -returns +Returns the diagnostics invoker for the specified *user*. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticinvoker_issupported.md b/windows.system.diagnostics/diagnosticinvoker_issupported.md new file mode 100644 index 0000000000..ce012322e5 --- /dev/null +++ b/windows.system.diagnostics/diagnosticinvoker_issupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.DiagnosticInvoker.IsSupported +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.DiagnosticInvoker.IsSupported + +## -description +Gets a Boolean value indicating if the diagnostics invoker is supported. + +## -property-value +A Boolean value indicating if the diagnostics invoker is supported. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/diagnosticinvoker_rundiagnosticactionasync_1910164149.md b/windows.system.diagnostics/diagnosticinvoker_rundiagnosticactionasync_1910164149.md new file mode 100644 index 0000000000..2b46a5ed92 --- /dev/null +++ b/windows.system.diagnostics/diagnosticinvoker_rundiagnosticactionasync_1910164149.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.System.Diagnostics.DiagnosticInvoker.RunDiagnosticActionAsync(Windows.Data.Json.JsonObject) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.DiagnosticInvoker.RunDiagnosticActionAsync + +## -description +Asynchronously runs the diagnostics invoker with the specified diagnostics context. + +## -parameters +### -param context +A Json object containing the context for the diagnostics action. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/processdiagnosticinfo_getappdiagnosticinfos_212734444.md b/windows.system.diagnostics/processdiagnosticinfo_getappdiagnosticinfos_212734444.md new file mode 100644 index 0000000000..4bfa5fb012 --- /dev/null +++ b/windows.system.diagnostics/processdiagnosticinfo_getappdiagnosticinfos_212734444.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.Diagnostics.ProcessDiagnosticInfo.GetAppDiagnosticInfos +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.ProcessDiagnosticInfo.GetAppDiagnosticInfos + +## -description +Gets one or more [AppDiagnosticInfo](..\windows.system\appdiagnosticinfo.md) objects if the [IsPackaged](processdiagnosticinfo_ispackaged.md) property is **true**. + +## -returns +Returns one or more [AppDiagnosticInfo](..\windows.system\appdiagnosticinfo.md) objects. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/processdiagnosticinfo_ispackaged.md b/windows.system.diagnostics/processdiagnosticinfo_ispackaged.md index 8879ee9a5d..6998ec6904 100644 --- a/windows.system.diagnostics/processdiagnosticinfo_ispackaged.md +++ b/windows.system.diagnostics/processdiagnosticinfo_ispackaged.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.System.Diagnostics.ProcessDiagnosticInfo.IsPackaged --api-type: winrt property ---- - +--- +-api-id: P:Windows.System.Diagnostics.ProcessDiagnosticInfo.IsPackaged +-api-type: winrt property +--- + -# Windows.System.Diagnostics.ProcessDiagnosticInfo.IsPackaged - +# Windows.System.Diagnostics.ProcessDiagnosticInfo.IsPackaged + ## -description +Gets a Boolean value indicating whether or not this [ProcessDiagnosticInfo](processdiagnosticinfo.md) instance has any related [UWP](https://docs.microsoft.com/windows/uwp/get-started/universal-application-platform-guide) information. ## -property-value +A Boolean value indicating whether or not this [ProcessDiagnosticInfo](processdiagnosticinfo.md) instance has any related [UWP](https://docs.microsoft.com/windows/uwp/get-started/universal-application-platform-guide) information. ## -remarks diff --git a/windows.system.diagnostics/processdiagnosticinfo_trygetforprocessid_691679817.md b/windows.system.diagnostics/processdiagnosticinfo_trygetforprocessid_691679817.md index 297099975e..80ae13a47d 100644 --- a/windows.system.diagnostics/processdiagnosticinfo_trygetforprocessid_691679817.md +++ b/windows.system.diagnostics/processdiagnosticinfo_trygetforprocessid_691679817.md @@ -1,18 +1,20 @@ ---- --api-id: M:Windows.System.Diagnostics.ProcessDiagnosticInfo.TryGetForProcessId(System.UInt32) --api-type: winrt method ---- - +--- +-api-id: M:Windows.System.Diagnostics.ProcessDiagnosticInfo.TryGetForProcessId(System.UInt32) +-api-type: winrt method +--- + -# Windows.System.Diagnostics.ProcessDiagnosticInfo.TryGetForProcessId - +# Windows.System.Diagnostics.ProcessDiagnosticInfo.TryGetForProcessId + ## -description +Gets a [ProcessDiagnosticInfo](processdiagnosticinfo.md) object for the specified process. ## -parameters ### -param processId +The identifier of the process for which to retrieve a [ProcessDiagnosticInfo](processdiagnosticinfo.md) object. ## -returns diff --git a/windows.system.profile.systemmanufacturers/oemsupportinfo.md b/windows.system.profile.systemmanufacturers/oemsupportinfo.md new file mode 100644 index 0000000000..8c1cc5edbb --- /dev/null +++ b/windows.system.profile.systemmanufacturers/oemsupportinfo.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.Profile.SystemManufacturers.OemSupportInfo +-api-type: winrt class +--- + + + +# Windows.System.Profile.SystemManufacturers.OemSupportInfo + +## -description +Provides support information about the manufacturer of the device. This includes the OEM’s name, web site address, and other support details. + +## -remarks + +## -see-also +[OEMInformation](https://docs.microsoft.com/windows-hardware/customize/desktop/unattend/microsoft-windows-shell-setup-oeminformation) + +## -examples + diff --git a/windows.system.profile.systemmanufacturers/oemsupportinfo_supportapplink.md b/windows.system.profile.systemmanufacturers/oemsupportinfo_supportapplink.md new file mode 100644 index 0000000000..a8afdd39f4 --- /dev/null +++ b/windows.system.profile.systemmanufacturers/oemsupportinfo_supportapplink.md @@ -0,0 +1,33 @@ +--- +-api-id: P:Windows.System.Profile.SystemManufacturers.OemSupportInfo.SupportAppLink +-api-type: winrt property +--- + + + +# Windows.System.Profile.SystemManufacturers.OemSupportInfo.SupportAppLink + +## -description +Gets the protocol handler link to the OEM-built support app that will be launched instead of the web URL. + +## -property-value +The protocol handler link to the OEM-built support app. + +## -remarks + +## -see-also + +## -examples +In the following app manifest file snippet, the **Protocol Name** is **contoso-contact-support** so this will be the value that will be used for **SupportAppLink**. + +```xml + + + + contoso-resource:appDisplayName + + + +``` diff --git a/windows.system.profile.systemmanufacturers/oemsupportinfo_supportlink.md b/windows.system.profile.systemmanufacturers/oemsupportinfo_supportlink.md new file mode 100644 index 0000000000..550cb6a47d --- /dev/null +++ b/windows.system.profile.systemmanufacturers/oemsupportinfo_supportlink.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Profile.SystemManufacturers.OemSupportInfo.SupportLink +-api-type: winrt property +--- + + + +# Windows.System.Profile.SystemManufacturers.OemSupportInfo.SupportLink + +## -description +Gets the Uniform Resource Identifier (URI) for the Original Equipment Manufacturer (OEM) support web site. + +## -property-value +The URI for the OEM support web site. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.profile.systemmanufacturers/oemsupportinfo_supportprovider.md b/windows.system.profile.systemmanufacturers/oemsupportinfo_supportprovider.md new file mode 100644 index 0000000000..c386e3d4be --- /dev/null +++ b/windows.system.profile.systemmanufacturers/oemsupportinfo_supportprovider.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Profile.SystemManufacturers.OemSupportInfo.SupportProvider +-api-type: winrt property +--- + + + +# Windows.System.Profile.SystemManufacturers.OemSupportInfo.SupportProvider + +## -description +Gets the name of the support provider for the device. + +## -property-value +The name of the support provider for the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.profile.systemmanufacturers/systemsupportinfo.md b/windows.system.profile.systemmanufacturers/systemsupportinfo.md new file mode 100644 index 0000000000..e3bf24e1a7 --- /dev/null +++ b/windows.system.profile.systemmanufacturers/systemsupportinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Profile.SystemManufacturers.SystemSupportInfo +-api-type: winrt class +--- + + + +# Windows.System.Profile.SystemManufacturers.SystemSupportInfo + +## -description +Provides support information about the device. This includes the local system edition, and OEM support information. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.profile.systemmanufacturers/systemsupportinfo_localsystemedition.md b/windows.system.profile.systemmanufacturers/systemsupportinfo_localsystemedition.md new file mode 100644 index 0000000000..923f7d7b8c --- /dev/null +++ b/windows.system.profile.systemmanufacturers/systemsupportinfo_localsystemedition.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Profile.SystemManufacturers.SystemSupportInfo.LocalSystemEdition +-api-type: winrt property +--- + + + +# Windows.System.Profile.SystemManufacturers.SystemSupportInfo.LocalSystemEdition + +## -description +Gets a string containing the local system edition of the device. + +## -property-value +A string containing the local system edition of the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.profile.systemmanufacturers/systemsupportinfo_oemsupportinfo.md b/windows.system.profile.systemmanufacturers/systemsupportinfo_oemsupportinfo.md new file mode 100644 index 0000000000..382b0c45b3 --- /dev/null +++ b/windows.system.profile.systemmanufacturers/systemsupportinfo_oemsupportinfo.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.Profile.SystemManufacturers.SystemSupportInfo.OemSupportInfo +-api-type: winrt property +--- + + + +# Windows.System.Profile.SystemManufacturers.SystemSupportInfo.OemSupportInfo + +## -description +Gets the OEM support information for the system. + +## -property-value +The OEM support info for the system. + +## -remarks +OEM support info includes the OEM’s name, web site address, and other support details. + +## -see-also +[OEMSupportInfo](oemsupportinfo.md) + +## -examples + diff --git a/windows.system.profile.systemmanufacturers/windows_system_profile_systemmanufacturers.md b/windows.system.profile.systemmanufacturers/windows_system_profile_systemmanufacturers.md index e685ce30f9..cb6c28974b 100644 --- a/windows.system.profile.systemmanufacturers/windows_system_profile_systemmanufacturers.md +++ b/windows.system.profile.systemmanufacturers/windows_system_profile_systemmanufacturers.md @@ -6,7 +6,7 @@ # Windows.System.Profile.SystemManufacturers ## -description -Provides info for hardware developers and OEM. +Provides info for hardware developers and OEMs. ## -remarks diff --git a/windows.system.profile/systemidentificationsource.md b/windows.system.profile/systemidentificationsource.md index f0b9f6d615..84bddab84a 100644 --- a/windows.system.profile/systemidentificationsource.md +++ b/windows.system.profile/systemidentificationsource.md @@ -22,9 +22,11 @@ The ID was generated by a Trusted Platform Module (TPM). ### -field Uefi:2 The ID was generated by a Unified Extensible Firmware Interface (UEFI). +### -field Registry:3 +The ID was generated from the system registry. ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.system.remotesystems/remotesystem_kind.md b/windows.system.remotesystems/remotesystem_kind.md index 9680df269e..22f36ecade 100644 --- a/windows.system.remotesystems/remotesystem_kind.md +++ b/windows.system.remotesystems/remotesystem_kind.md @@ -10,12 +10,13 @@ public string Kind { get; } # Windows.System.RemoteSystems.RemoteSystem.Kind ## -description -Gets a String representation of the device type of the given remote system (Desktop, Xbox, ...). +Gets a String representation of the device type of the given remote system (desktop, Xbox, ...). ## -property-value The device type of the remote system. ## -remarks +This property should not be used to make functionality or experience decisions regarding connected devices. Instead, device capabilities should be checked with the [GetCapabilitySupportedAsync](remotesystem_getcapabilitysupportedasync_1130940389.md) method. The **Kind** property is meant to provide developers with information about the types of devices being connected to so that they can display this information in the UI. ## -examples diff --git a/windows.system.remotesystems/remotesystem_manufacturerdisplayname.md b/windows.system.remotesystems/remotesystem_manufacturerdisplayname.md new file mode 100644 index 0000000000..d8c0427f29 --- /dev/null +++ b/windows.system.remotesystems/remotesystem_manufacturerdisplayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystem.ManufacturerDisplayName +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystem.ManufacturerDisplayName + +## -description +Gets the manufacturer name of the given remote system. + +## -property-value +The name of the given remote system's manufacturer. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystem_modeldisplayname.md b/windows.system.remotesystems/remotesystem_modeldisplayname.md new file mode 100644 index 0000000000..0552bf75bd --- /dev/null +++ b/windows.system.remotesystems/remotesystem_modeldisplayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystem.ModelDisplayName +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystem.ModelDisplayName + +## -description +Gets the model name of the given remote system. + +## -property-value +The model name of the given remote system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemkinds_iot.md b/windows.system.remotesystems/remotesystemkinds_iot.md new file mode 100644 index 0000000000..7e76c5b356 --- /dev/null +++ b/windows.system.remotesystems/remotesystemkinds_iot.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemKinds.Iot +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemKinds.Iot + +## -description +Gets the string representation of the **Internet of Things (IoT)** device type. + +## -property-value +String representing **IoT**. + +## -remarks + +## -examples + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemkinds_laptop.md b/windows.system.remotesystems/remotesystemkinds_laptop.md new file mode 100644 index 0000000000..2c4d7fc569 --- /dev/null +++ b/windows.system.remotesystems/remotesystemkinds_laptop.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemKinds.Laptop +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemKinds.Laptop + +## -description +Gets the string representation of the **laptop** device type. + +## -property-value +String representing **laptop**. + +## -remarks + +## -examples + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemkinds_tablet.md b/windows.system.remotesystems/remotesystemkinds_tablet.md new file mode 100644 index 0000000000..2c8b6b611f --- /dev/null +++ b/windows.system.remotesystems/remotesystemkinds_tablet.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemKinds.Tablet +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemKinds.Tablet + +## -description +Gets the string representation of the **tablet** device type. + +## -property-value +String representing **tablet**. + +## -remarks + +## -examples + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession.md b/windows.system.remotesystems/remotesystemsession.md index 3a05b269b3..d09aff77bd 100644 --- a/windows.system.remotesystems/remotesystemsession.md +++ b/windows.system.remotesystems/remotesystemsession.md @@ -22,7 +22,7 @@ A session that has been joined is represented by a [RemoteSystemSession](RemoteS ## -examples See the code example below for the process of joining a remote session (including obtaining a reference to a [RemoteSystemSession](RemoteSystemSession.md) instance). -```java +```csharp public async void JoinExistingSession() { // request to join. sessionInfo has already been selected by user. @@ -52,7 +52,7 @@ public async void JoinExistingSession() { Alternatively, see the following code for an example of how to create a remote session and handle join requests. -```java +```csharp public async void StartNewSharedExperience() { var manager = new RemoteSystemSessionController("Bob’s Minecraft game"); diff --git a/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md b/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md index daefc0425f..e40a409366 100644 --- a/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md +++ b/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md @@ -22,7 +22,7 @@ A watcher object to be used in discovering remote sessions. ## -examples See the code example below for the process of discovering a remote session. -```java +```csharp // Discover an existing shared experience. public void DiscoverExistingSessions() { diff --git a/windows.system.remotesystems/remotesystemsessioncontroller.md b/windows.system.remotesystems/remotesystemsessioncontroller.md index ddc4a180e8..7982a085d4 100644 --- a/windows.system.remotesystems/remotesystemsessioncontroller.md +++ b/windows.system.remotesystems/remotesystemsessioncontroller.md @@ -20,7 +20,7 @@ Every remote session has one participant that is the session's controller. Only ## -examples See the following code for an example of how to create a remote session and handle join requests. -```java +```csharp public async void StartNewSharedExperience() { diff --git a/windows.system.remotesystems/remotesystemsessioncreationresult.md b/windows.system.remotesystems/remotesystemsessioncreationresult.md index fed9fc7290..1b01fd892b 100644 --- a/windows.system.remotesystems/remotesystemsessioncreationresult.md +++ b/windows.system.remotesystems/remotesystemsessioncreationresult.md @@ -19,7 +19,7 @@ Represents the result of an attempt by a [RemoteSystemSessionController](RemoteS ## -examples See the following code for an example of how to create a remote session and handle join requests. -```java +```csharp public async void StartNewSharedExperience() { diff --git a/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md b/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md index 88d106ef30..f645873f1d 100644 --- a/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md +++ b/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md @@ -20,7 +20,7 @@ This class is instantiated whenever the [RemoteSystemSession.Disconnected](Remot ## -examples See the code example below for the process of joining a remote session (including using a [RemoteSystemSessionDisconnectedEventArgs](RemoteSystemSessionDisconnectedEventArgs.md) instance). -```java +```csharp public async void JoinExistingSession() { diff --git a/windows.system.remotesystems/remotesystemsessioninfo.md b/windows.system.remotesystems/remotesystemsessioninfo.md index bd768e38b7..11651ad92b 100644 --- a/windows.system.remotesystems/remotesystemsessioninfo.md +++ b/windows.system.remotesystems/remotesystemsessioninfo.md @@ -20,7 +20,7 @@ A session that has been joined is represented by a [RemoteSystemSession](RemoteS ## -examples See the code example below for the full process of discovering a remote session (including obtaining a reference to a [RemoteSystemSessionInfo](RemoteSystemSessionInfo.md) instance). -```java +```csharp // Discover an existing shared experience. public void DiscoverExistingSessions() { @@ -49,7 +49,7 @@ public void DiscoverExistingSessions() { Once a [RemoteSystemSessionInfo](RemoteSystemSessionInfo.md) reference has be acquired, it can be used to issue a join request. See the code example below for the process of joining a remote session. -```java +```csharp public async void JoinExistingSession() { diff --git a/windows.system.remotesystems/remotesystemsessioninvitation.md b/windows.system.remotesystems/remotesystemsessioninvitation.md index 8cc22ba396..d72d967816 100644 --- a/windows.system.remotesystems/remotesystemsessioninvitation.md +++ b/windows.system.remotesystems/remotesystemsessioninvitation.md @@ -22,7 +22,7 @@ The device receiving an invitation will need to use a [RemoteSystemSessionInvita ## -examples See the following code for an example of how to receive and handle remote session invitations. -```java +```csharp public void SubscribeAndHandleInvites() { var invitationListener = new RemoteSystemSessionInvitationListener(); diff --git a/windows.system.remotesystems/remotesystemsessioninvitationlistener.md b/windows.system.remotesystems/remotesystemsessioninvitationlistener.md index dbc57de45e..30af668776 100644 --- a/windows.system.remotesystems/remotesystemsessioninvitationlistener.md +++ b/windows.system.remotesystems/remotesystemsessioninvitationlistener.md @@ -19,7 +19,7 @@ Contains the functionality for receiving and handling invitations to join remote ## -examples See the following code for an example of how to receive and handle remote session invitations. -```java +```csharp public void SubscribeAndHandleInvites() { var invitationListener = new RemoteSystemSessionInvitationListener(); diff --git a/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md b/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md index 0143b24417..550bc0dc2d 100644 --- a/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md +++ b/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md @@ -20,7 +20,7 @@ This class is instantiated whenever the [RemoteSystemSessionInvitationListener.I ## -examples See the following code for an example of how to receive and handle remote session invitations. -```java +```csharp public void SubscribeAndHandleInvites() { var invitationListener = new RemoteSystemSessionInvitationListener(); diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequest.md b/windows.system.remotesystems/remotesystemsessionjoinrequest.md index cb84cb065f..693072ab53 100644 --- a/windows.system.remotesystems/remotesystemsessionjoinrequest.md +++ b/windows.system.remotesystems/remotesystemsessionjoinrequest.md @@ -19,7 +19,7 @@ Represents a remote device's request to join a session controlled by this device ## -examples See the following code for an example of how to create a remote session and handle join requests. -```java +```csharp public async void StartNewSharedExperience() { diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md index ee4481cac5..98f961b6c9 100644 --- a/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md +++ b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md @@ -20,7 +20,7 @@ This class is instantiated whenever the [RemoteSystemSessionController.JoinReque ## -examples See the following code for an example of how to create a remote session and handle join requests. -```java +```csharp public async void StartNewSharedExperience() { diff --git a/windows.system.remotesystems/remotesystemsessionjoinresult.md b/windows.system.remotesystems/remotesystemsessionjoinresult.md index 1aacb4864b..5de8856c90 100644 --- a/windows.system.remotesystems/remotesystemsessionjoinresult.md +++ b/windows.system.remotesystems/remotesystemsessionjoinresult.md @@ -19,7 +19,7 @@ Represents the result of this device's attempt to join a remote session. ## -examples See the code example below for the process of joining a remote session. -```java +```csharp public async void JoinExistingSession() { diff --git a/windows.system.remotesystems/remotesystemsessionwatcher.md b/windows.system.remotesystems/remotesystemsessionwatcher.md index 26c0fd9d02..84d20072f3 100644 --- a/windows.system.remotesystems/remotesystemsessionwatcher.md +++ b/windows.system.remotesystems/remotesystemsessionwatcher.md @@ -20,7 +20,7 @@ This class is instantiated when the [RemoteSystemSession.CreateWatcher](RemoteSy ## -examples See the code example below for the process of discovering a remote session. -```java +```csharp // Discover an existing shared experience. public void DiscoverExistingSessions() { diff --git a/windows.system/appdiagnosticinfo.md b/windows.system/appdiagnosticinfo.md index 5338d4dfb6..1d1eb65d80 100644 --- a/windows.system/appdiagnosticinfo.md +++ b/windows.system/appdiagnosticinfo.md @@ -10,7 +10,6 @@ public class AppDiagnosticInfo # Windows.System.AppDiagnosticInfo ## -description - Contains APIs for getting a basic set of diagnostic information for all running apps. ## -remarks diff --git a/windows.system/appdiagnosticinfo_createresourcegroupwatcher_1362483101.md b/windows.system/appdiagnosticinfo_createresourcegroupwatcher_1362483101.md index 70baa301ba..9db4f7b6ec 100644 --- a/windows.system/appdiagnosticinfo_createresourcegroupwatcher_1362483101.md +++ b/windows.system/appdiagnosticinfo_createresourcegroupwatcher_1362483101.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.System.AppDiagnosticInfo.CreateResourceGroupWatcher --api-type: winrt method ---- - +--- +-api-id: M:Windows.System.AppDiagnosticInfo.CreateResourceGroupWatcher +-api-type: winrt method +--- + -# Windows.System.AppDiagnosticInfo.CreateResourceGroupWatcher - +# Windows.System.AppDiagnosticInfo.CreateResourceGroupWatcher + ## -description +Creates a **ResourceGroupInfoWatcher** that monitors the execution state of an app or task, and provides notifications when its state changes. ## -returns +A **ResourceGroupInfoWatcher** that can be used to monitor diagnostic info. ## -remarks @@ -19,3 +21,5 @@ public ResourceGroupInfoWatcher AppDiagnosticInfo.CreateResourceGroupWatcher() ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfo_createwatcher_1506431823.md b/windows.system/appdiagnosticinfo_createwatcher_1506431823.md index beedfc1626..2dc754f232 100644 --- a/windows.system/appdiagnosticinfo_createwatcher_1506431823.md +++ b/windows.system/appdiagnosticinfo_createwatcher_1506431823.md @@ -1,17 +1,19 @@ ---- --api-id: M:Windows.System.AppDiagnosticInfo.CreateWatcher --api-type: winrt method ---- - +--- +-api-id: M:Windows.System.AppDiagnosticInfo.CreateWatcher +-api-type: winrt method +--- + -# Windows.System.AppDiagnosticInfo.CreateWatcher - +# Windows.System.AppDiagnosticInfo.CreateWatcher + ## -description +Creates an **[AppDiagnosticInfoWatcher](appdiagnosticinfowatcher.md)** that monitors information about the execution state of an app, and provides notifications when its state changes. ## -returns +An **[AppDiagnosticInfoWatcher](appdiagnosticinfowatcher.md)** that can be used to monitor diagnostic info. ## -remarks @@ -19,3 +21,5 @@ public AppDiagnosticInfoWatcher AppDiagnosticInfo.CreateWatcher() ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfo_getresourcegroups_93138928.md b/windows.system/appdiagnosticinfo_getresourcegroups_93138928.md index a71056c798..56c8bb8f42 100644 --- a/windows.system/appdiagnosticinfo_getresourcegroups_93138928.md +++ b/windows.system/appdiagnosticinfo_getresourcegroups_93138928.md @@ -10,8 +10,10 @@ public IVector AppDiagnosticInfo.GetResourceGroups() # Windows.System.AppDiagnosticInfo.GetResourceGroups ## -description +Gets diagnostic information such as memory usage over time, energy use over time, and so on, for each resource group in the app. ## -returns +Diagnostic info for each resource group in the app. ## -remarks @@ -19,3 +21,5 @@ public IVector AppDiagnosticInfo.GetResourceGroups() ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfo_requestaccessasync_380675631.md b/windows.system/appdiagnosticinfo_requestaccessasync_380675631.md new file mode 100644 index 0000000000..ba075b40df --- /dev/null +++ b/windows.system/appdiagnosticinfo_requestaccessasync_380675631.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppDiagnosticInfo.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.System.AppDiagnosticInfo.RequestAccessAsync + +## -description +Asynchronously requests access to diagnostic information. + +## -returns +Returns an async operation with a **[DiagnosticAccessStatus](diagnosticaccessstatus.md)** value indicating the level of diagnostic info available to this app. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfo_requestinfoforappasync_1781805390.md b/windows.system/appdiagnosticinfo_requestinfoforappasync_1781805390.md new file mode 100644 index 0000000000..c85319c4fa --- /dev/null +++ b/windows.system/appdiagnosticinfo_requestinfoforappasync_1781805390.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppDiagnosticInfo.RequestInfoForAppAsync +-api-type: winrt method +--- + + + +# Windows.System.AppDiagnosticInfo.RequestInfoForAppAsync + +## -description +Gets a collection of **[AppDiagnosticInfo](appdiagnosticinfo.md)** objects for all running instances of this app. + +## -returns +A collection of **[AppDiagnosticInfo](appdiagnosticinfo.md)** objects for all running instances of this app. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfo_requestinfoforappasync_867551342.md b/windows.system/appdiagnosticinfo_requestinfoforappasync_867551342.md index 5197b07bdf..0104692fbb 100644 --- a/windows.system/appdiagnosticinfo_requestinfoforappasync_867551342.md +++ b/windows.system/appdiagnosticinfo_requestinfoforappasync_867551342.md @@ -1,20 +1,23 @@ ---- --api-id: M:Windows.System.AppDiagnosticInfo.RequestInfoForAppAsync(System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.System.AppDiagnosticInfo.RequestInfoForAppAsync(System.String) +-api-type: winrt method +--- + -# Windows.System.AppDiagnosticInfo.RequestInfoForAppAsync - +# Windows.System.AppDiagnosticInfo.RequestInfoForAppAsync + ## -description +Gets a collection of **[AppDiagnosticInfo](appdiagnosticinfo.md)** objects for all instances of the specified running app. ## -parameters -### -param aumid +### -param appUserModelId +The identifier of the running app for which to get the **[AppDiagnosticInfo](appdiagnosticinfo.md)**. ## -returns +A collection of **[AppDiagnosticInfo](appdiagnosticinfo.md)** objects for all instances of the app specified by *appUserModelId*. ## -remarks @@ -22,3 +25,6 @@ public IAsyncOperation> AppDiagnosticInfo.RequestInfoForAppAs ## -examples +## -capabilities +appDiagnostics + diff --git a/windows.system/appdiagnosticinfo_requestinfoforpackageasync_71771511.md b/windows.system/appdiagnosticinfo_requestinfoforpackageasync_71771511.md index c1bf3082d0..eb6167091e 100644 --- a/windows.system/appdiagnosticinfo_requestinfoforpackageasync_71771511.md +++ b/windows.system/appdiagnosticinfo_requestinfoforpackageasync_71771511.md @@ -1,20 +1,23 @@ ---- --api-id: M:Windows.System.AppDiagnosticInfo.RequestInfoForPackageAsync(System.String) --api-type: winrt method ---- - +--- +-api-id: M:Windows.System.AppDiagnosticInfo.RequestInfoForPackageAsync(System.String) +-api-type: winrt method +--- + -# Windows.System.AppDiagnosticInfo.RequestInfoForPackageAsync - +# Windows.System.AppDiagnosticInfo.RequestInfoForPackageAsync + ## -description +Gets a collection of **[AppDiagnosticInfo](appdiagnosticinfo.md)** objects for all instances of the specified app package. ## -parameters ### -param packageFamilyName +The identifier of the app package for which to get the **[AppDiagnosticInfo](appdiagnosticinfo.md)**. ## -returns +A collection of **[AppDiagnosticInfo](appdiagnosticinfo.md)** objects for all instances of the app package specified by *packageFamilyName*. ## -remarks @@ -22,3 +25,5 @@ public IAsyncOperation> AppDiagnosticInfo.RequestInfoForPacka ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcher.md b/windows.system/appdiagnosticinfowatcher.md index 348700b3b4..f35f108f01 100644 --- a/windows.system/appdiagnosticinfowatcher.md +++ b/windows.system/appdiagnosticinfowatcher.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.System.AppDiagnosticInfoWatcher --api-type: winrt class ---- - +--- +-api-id: T:Windows.System.AppDiagnosticInfoWatcher +-api-type: winrt class +--- + -# Windows.System.AppDiagnosticInfoWatcher - +# Windows.System.AppDiagnosticInfoWatcher + ## -description +Allows you to monitor diagnostic information for an app and get notifications when an app is added or removed from the list of running apps. ## -remarks @@ -17,3 +18,5 @@ public class AppDiagnosticInfoWatcher ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcher_added.md b/windows.system/appdiagnosticinfowatcher_added.md index 8cd8a41176..a8cdbec97b 100644 --- a/windows.system/appdiagnosticinfowatcher_added.md +++ b/windows.system/appdiagnosticinfowatcher_added.md @@ -1,15 +1,16 @@ ---- --api-id: E:Windows.System.AppDiagnosticInfoWatcher.Added --api-type: winrt event ---- - +--- +-api-id: E:Windows.System.AppDiagnosticInfoWatcher.Added +-api-type: winrt event +--- + -# Windows.System.AppDiagnosticInfoWatcher.Added - +# Windows.System.AppDiagnosticInfoWatcher.Added + ## -description +Event that fires when an app is added to the list of running apps. ## -remarks @@ -17,3 +18,5 @@ public event TypedEventHandler Added --> -# Windows.System.AppDiagnosticInfoWatcher.EnumerationCompleted - +# Windows.System.AppDiagnosticInfoWatcher.EnumerationCompleted + ## -description +Fires when the watcher has completed enumerating the list of running apps that are available to monitor. ## -remarks +After enumeration is complete, the watcher will start reporting when apps are added or removed. ## -see-also ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcher_removed.md b/windows.system/appdiagnosticinfowatcher_removed.md index 7ac85ae891..403b5a682c 100644 --- a/windows.system/appdiagnosticinfowatcher_removed.md +++ b/windows.system/appdiagnosticinfowatcher_removed.md @@ -1,15 +1,16 @@ ---- --api-id: E:Windows.System.AppDiagnosticInfoWatcher.Removed --api-type: winrt event ---- - +--- +-api-id: E:Windows.System.AppDiagnosticInfoWatcher.Removed +-api-type: winrt event +--- + -# Windows.System.AppDiagnosticInfoWatcher.Removed - +# Windows.System.AppDiagnosticInfoWatcher.Removed + ## -description +Fires when one of the apps has been removed from the list of running apps. ## -remarks @@ -17,3 +18,5 @@ public event TypedEventHandler Removed -# Windows.System.AppDiagnosticInfoWatcher.Start - +# Windows.System.AppDiagnosticInfoWatcher.Start + ## -description +Start firing events when the execution state changes, or apps change, within the list of running apps. ## -remarks @@ -17,3 +18,5 @@ public void AppDiagnosticInfoWatcher.Start() ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcher_status.md b/windows.system/appdiagnosticinfowatcher_status.md index 12845cd82b..fc5752e19b 100644 --- a/windows.system/appdiagnosticinfowatcher_status.md +++ b/windows.system/appdiagnosticinfowatcher_status.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.System.AppDiagnosticInfoWatcher.Status --api-type: winrt property ---- - +--- +-api-id: P:Windows.System.AppDiagnosticInfoWatcher.Status +-api-type: winrt property +--- + -# Windows.System.AppDiagnosticInfoWatcher.Status - +# Windows.System.AppDiagnosticInfoWatcher.Status + ## -description +Gets this **AppDiagnosticInfoWatcher** status. ## -property-value +The status such as Started, Stopped, and so on. ## -remarks @@ -19,3 +21,5 @@ public AppDiagnosticInfoWatcherStatus Status { get; } ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcher_stop_1201535524.md b/windows.system/appdiagnosticinfowatcher_stop_1201535524.md index cccbbc8f49..753690562b 100644 --- a/windows.system/appdiagnosticinfowatcher_stop_1201535524.md +++ b/windows.system/appdiagnosticinfowatcher_stop_1201535524.md @@ -1,15 +1,16 @@ ---- --api-id: M:Windows.System.AppDiagnosticInfoWatcher.Stop --api-type: winrt method ---- - +--- +-api-id: M:Windows.System.AppDiagnosticInfoWatcher.Stop +-api-type: winrt method +--- + -# Windows.System.AppDiagnosticInfoWatcher.Stop - +# Windows.System.AppDiagnosticInfoWatcher.Stop + ## -description +Stops firing events when the execution state changes, or apps change, within the list of running apps. ## -remarks @@ -17,3 +18,5 @@ public void AppDiagnosticInfoWatcher.Stop() ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcher_stopped.md b/windows.system/appdiagnosticinfowatcher_stopped.md index 0201382b04..51cb090ee9 100644 --- a/windows.system/appdiagnosticinfowatcher_stopped.md +++ b/windows.system/appdiagnosticinfowatcher_stopped.md @@ -1,19 +1,23 @@ ---- --api-id: E:Windows.System.AppDiagnosticInfoWatcher.Stopped --api-type: winrt event ---- - +--- +-api-id: E:Windows.System.AppDiagnosticInfoWatcher.Stopped +-api-type: winrt event +--- + -# Windows.System.AppDiagnosticInfoWatcher.Stopped - +# Windows.System.AppDiagnosticInfoWatcher.Stopped + ## -description +Event that fires when this **AppDiagnosticInfoWatcher** stops watching for changes. ## -remarks ## -see-also +[Windows.System.AppDiagnosticInfoWatcher.Stop](appdiagnosticinfowatcher_stop_1201535524.md) ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatchereventargs.md b/windows.system/appdiagnosticinfowatchereventargs.md index de35616fb6..1cf140ca6f 100644 --- a/windows.system/appdiagnosticinfowatchereventargs.md +++ b/windows.system/appdiagnosticinfowatchereventargs.md @@ -1,15 +1,16 @@ ---- --api-id: T:Windows.System.AppDiagnosticInfoWatcherEventArgs --api-type: winrt class ---- - +--- +-api-id: T:Windows.System.AppDiagnosticInfoWatcherEventArgs +-api-type: winrt class +--- + -# Windows.System.AppDiagnosticInfoWatcherEventArgs - +# Windows.System.AppDiagnosticInfoWatcherEventArgs + ## -description +The data object passed to an **[AppDiagnosticInfoWatcher](appdiagnosticinfowatcher.md)** event. ## -remarks @@ -17,3 +18,5 @@ public class AppDiagnosticInfoWatcherEventArgs ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatchereventargs_appdiagnosticinfo.md b/windows.system/appdiagnosticinfowatchereventargs_appdiagnosticinfo.md index f35cae279d..d688a648f8 100644 --- a/windows.system/appdiagnosticinfowatchereventargs_appdiagnosticinfo.md +++ b/windows.system/appdiagnosticinfowatchereventargs_appdiagnosticinfo.md @@ -1,21 +1,26 @@ ---- --api-id: P:Windows.System.AppDiagnosticInfoWatcherEventArgs.AppDiagnosticInfo --api-type: winrt property ---- - +--- +-api-id: P:Windows.System.AppDiagnosticInfoWatcherEventArgs.AppDiagnosticInfo +-api-type: winrt property +--- + -# Windows.System.AppDiagnosticInfoWatcherEventArgs.AppDiagnosticInfo - +# Windows.System.AppDiagnosticInfoWatcherEventArgs.AppDiagnosticInfo + ## -description +Gets diagnostic info for the app package. ## -property-value +The [AppDiagnosticInfo](appdiagnosticinfo.md) for the current event. ## -remarks +Typically there will only be one app associated with the **AppDiagnosticInfo**, but there can be more. ## -see-also ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appdiagnosticinfowatcherstatus.md b/windows.system/appdiagnosticinfowatcherstatus.md index 03cbf1596b..830817e334 100644 --- a/windows.system/appdiagnosticinfowatcherstatus.md +++ b/windows.system/appdiagnosticinfowatcherstatus.md @@ -1,32 +1,42 @@ ---- --api-id: T:Windows.System.AppDiagnosticInfoWatcherStatus --api-type: winrt enum ---- - +--- +-api-id: T:Windows.System.AppDiagnosticInfoWatcherStatus +-api-type: winrt enum +--- + -# Windows.System.AppDiagnosticInfoWatcherStatus - +# Windows.System.AppDiagnosticInfoWatcherStatus + ## -description +Defines the status values that are returned from a call to [AppDiagnosticInfoWatcher.Status](appdiagnosticinfowatcher_status.md). ## -enum-fields -### -field Stopping:3 - -### -field Stopped:4 - -### -field Aborted:5 +### -field Created:0 +The **AppDiagnosticInfoWatcher** has been created. ### -field Started:1 +The **AppDiagnosticInfoWatcher** has started. ### -field EnumerationCompleted:2 +The **AppDiagnosticInfoWatcher** has finished enumerating running apps. -### -field Created:0 +### -field Stopping:3 +The **AppDiagnosticInfoWatcher** is stopping. + +### -field Stopped:4 +The **AppDiagnosticInfoWatcher** has stopped. + +### -field Aborted:5 +The **AppDiagnosticInfoWatcher** was aborted. ## -remarks ## -see-also +[AppDiagnosticInfoWatcher](appdiagnosticinfowatcher.md) ## -examples +## -capabilities +appDiagnostics diff --git a/windows.system/appmemoryreport_expectedtotalcommitlimit.md b/windows.system/appmemoryreport_expectedtotalcommitlimit.md new file mode 100644 index 0000000000..397e0ae7a6 --- /dev/null +++ b/windows.system/appmemoryreport_expectedtotalcommitlimit.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.System.AppMemoryReport.ExpectedTotalCommitLimit +-api-type: winrt property +--- + + + +# Windows.System.AppMemoryReport.ExpectedTotalCommitLimit + +## -description +Gets the expected commit limit for the current app. + +## -property-value +The expected commit limit in bytes. + +## -remarks +When an app launches on Xbox, it is initially given a small commit limit (the sum of the app’s available usage of private plus shared commit memory) which may grow as the system frees memory. This property returns the expected upper limit. + +When an app launches on a non-Xbox system, the commit limit the app gets at launch remains the same and this property will return the same value as [Windows.System.AppMemoryReport.TotalCommitLimit](appmemoryreport_totalcommitlimit.md). + +## -see-also + + +## -examples diff --git a/windows.system/appresourcegroupbackgroundtaskreport.md b/windows.system/appresourcegroupbackgroundtaskreport.md new file mode 100644 index 0000000000..be626f5f4e --- /dev/null +++ b/windows.system/appresourcegroupbackgroundtaskreport.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.AppResourceGroupBackgroundTaskReport +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupBackgroundTaskReport + +## -description +Provides snapshot information about a background task such as its name, trigger name, entry point name, and task identifier. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupbackgroundtaskreport_entrypoint.md b/windows.system/appresourcegroupbackgroundtaskreport_entrypoint.md new file mode 100644 index 0000000000..949f9579f4 --- /dev/null +++ b/windows.system/appresourcegroupbackgroundtaskreport_entrypoint.md @@ -0,0 +1,44 @@ +--- +-api-id: P:Windows.System.AppResourceGroupBackgroundTaskReport.EntryPoint +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupBackgroundTaskReport.EntryPoint + +## -description +Gets the name of the background task entry point. + +## -property-value +The name of the entry point as specified in the app manifest. + +## -remarks +The entry point string is taken from the definition in the manifest. For example, the EntryPoint string will be `"Tasks.BackgroundTaskClass"` for a manifest that contains the following declaration: +```xml + + + + + + +``` + +For JavaScript tasks, the entry point string is taken from the value of the **StartPage** attribute in the background task registration. For example, the entry point string will be `"js\completionGroupBackgroundTask.js"` for a manifest that contains the following declaration: + +```xml + + + + + +``` + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupbackgroundtaskreport_name.md b/windows.system/appresourcegroupbackgroundtaskreport_name.md new file mode 100644 index 0000000000..0581631982 --- /dev/null +++ b/windows.system/appresourcegroupbackgroundtaskreport_name.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.System.AppResourceGroupBackgroundTaskReport.Name +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupBackgroundTaskReport.Name + +## -description +Gets the name of the background task. + +## -property-value +The background task name. + +## -remarks +This is the name supplied by the app when it registered the task with [BackgroundTaskBuilder]( https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Background.BackgroundTaskBuilder) + +Some background tasks do not have names and will return an empty string because they are not explicitly registered. For example, background audio playback tasks and app-service tasks. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupbackgroundtaskreport_taskid.md b/windows.system/appresourcegroupbackgroundtaskreport_taskid.md new file mode 100644 index 0000000000..5f9b692e84 --- /dev/null +++ b/windows.system/appresourcegroupbackgroundtaskreport_taskid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.System.AppResourceGroupBackgroundTaskReport.TaskId +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupBackgroundTaskReport.TaskId + +## -description +Gets the background task's identifier. + +## -property-value +The background task GUID. + +## -remarks +The identifier is an internally generated session-unique identifier. You can use it to disambiguate multiple background task instances. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupbackgroundtaskreport_trigger.md b/windows.system/appresourcegroupbackgroundtaskreport_trigger.md new file mode 100644 index 0000000000..a54eff4700 --- /dev/null +++ b/windows.system/appresourcegroupbackgroundtaskreport_trigger.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.System.AppResourceGroupBackgroundTaskReport.Trigger +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupBackgroundTaskReport.Trigger + +## -description +Gets the name of the trigger that activated this task. + +## -property-value +The name of the trigger. + +## -remarks +If the task is activated by a trigger, then this will be the trigger type name; otherwise it will be an internally-generated string that identifies the activation behavior. For example, the trigger string would be `"Windows.ApplicationModel.Background.ActivitySensorTrigger"` if an app set a background task trigger in code like this: + +```csharp +var builder = new Windows.ApplicationModel.Background.BackgroundTaskBuilder; +builder.SetTrigger(new Windows.ApplicationModel.Background.ActivitySensorTrigger(50)); +``` + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupenergyquotastate.md b/windows.system/appresourcegroupenergyquotastate.md new file mode 100644 index 0000000000..cff23f97db --- /dev/null +++ b/windows.system/appresourcegroupenergyquotastate.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.System.AppResourceGroupEnergyQuotaState +-api-type: winrt enum +--- + + + +# Windows.System.AppResourceGroupEnergyQuotaState + +## -description +Describes how the resource group is performing relative to its energy quota. + +## -enum-fields +### -field Unknown:0 +Unable to determine the energy quota state. + +### -field Under:2 +The resource group has not used its energy quota. + +### -field Over:1 +The resource group has used more than its energy quota. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/appresourcegroupexecutionstate.md b/windows.system/appresourcegroupexecutionstate.md new file mode 100644 index 0000000000..14fe2e79ef --- /dev/null +++ b/windows.system/appresourcegroupexecutionstate.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.System.AppResourceGroupExecutionState +-api-type: winrt enum +--- + + + +# Windows.System.AppResourceGroupExecutionState + +## -description +Describes the execution state of the resource group. + +## -enum-fields +### -field Unknown:0 +The execution state is not known. + +### -field Suspending:2 +The resource group is part of an app that is entering the suspend state. + +### -field Suspended:3 +The resource group is part of an app that has been suspended. + +### -field Running:1 +The resource group is part of an app that is currently running. + +### -field NotRunning:4 +The resource group is part of an app that is not running. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/appresourcegroupinfo.md b/windows.system/appresourcegroupinfo.md new file mode 100644 index 0000000000..967831ecd5 --- /dev/null +++ b/windows.system/appresourcegroupinfo.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.System.AppResourceGroupInfo +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupInfo + +## -description +Provides diagnostic information such as memory usage and energy use. + +## -remarks +Resource groups allow you to group components for the purposes of resource management. If you don't define a group, you will get at least one by default, and possibly more, depending on whether the app has background tasks. + +Resource groups are specified in the manifest with the **ResourceGroup** tag. + +## -see-also +[uap:Extension](https://docs.microsoft.com/uwp/schemas/appxpackage/uapmanifestschema/element-uap-extension) + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfo_getbackgroundtaskreports_1387467427.md b/windows.system/appresourcegroupinfo_getbackgroundtaskreports_1387467427.md new file mode 100644 index 0000000000..2cf5d4975c --- /dev/null +++ b/windows.system/appresourcegroupinfo_getbackgroundtaskreports_1387467427.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppResourceGroupInfo.GetBackgroundTaskReports +-api-type: winrt method +--- + + + +# Windows.System.AppResourceGroupInfo.GetBackgroundTaskReports + +## -description +Provides information about background tasks such as their entry points, names, task ids, and trigger names. + +## -returns +Information about each background task. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfo_getmemoryreport_70410041.md b/windows.system/appresourcegroupinfo_getmemoryreport_70410041.md new file mode 100644 index 0000000000..7f54a6e598 --- /dev/null +++ b/windows.system/appresourcegroupinfo_getmemoryreport_70410041.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppResourceGroupInfo.GetMemoryReport +-api-type: winrt method +--- + + + +# Windows.System.AppResourceGroupInfo.GetMemoryReport + +## -description +Provides information about memory usage such as the commit limit, commit usage, and so on. + +## -returns +Information about memory usage. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfo_getprocessdiagnosticinfos_392632681.md b/windows.system/appresourcegroupinfo_getprocessdiagnosticinfos_392632681.md new file mode 100644 index 0000000000..ff54513ec4 --- /dev/null +++ b/windows.system/appresourcegroupinfo_getprocessdiagnosticinfos_392632681.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppResourceGroupInfo.GetProcessDiagnosticInfos +-api-type: winrt method +--- + + + +# Windows.System.AppResourceGroupInfo.GetProcessDiagnosticInfos + +## -description +Gets process diagnostic information for the group such as used CPU time, disk I/O usage, and so on. + +## -returns +The process diagnostic info. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfo_getstatereport_1250213219.md b/windows.system/appresourcegroupinfo_getstatereport_1250213219.md new file mode 100644 index 0000000000..7b567ca0c9 --- /dev/null +++ b/windows.system/appresourcegroupinfo_getstatereport_1250213219.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppResourceGroupInfo.GetStateReport +-api-type: winrt method +--- + + + +# Windows.System.AppResourceGroupInfo.GetStateReport + +## -description +Gets the state report information such as execution state, energy quota state, and so on. + +## -returns +The state info. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfo_instanceid.md b/windows.system/appresourcegroupinfo_instanceid.md new file mode 100644 index 0000000000..9652249603 --- /dev/null +++ b/windows.system/appresourcegroupinfo_instanceid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfo.InstanceId +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfo.InstanceId + +## -description +Gets the instance identifier. + +## -property-value +The instance ID. + +## -remarks +This is a system-generated value that is unique per session; it is not guaranteed to be unique across device reboots. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfo_isshared.md b/windows.system/appresourcegroupinfo_isshared.md new file mode 100644 index 0000000000..c6efd5378e --- /dev/null +++ b/windows.system/appresourcegroupinfo_isshared.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfo.IsShared +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfo.IsShared + +## -description +Indicates whether the group is part of a shared resource group. Being part of a shared resource group indicates that there are multiple apps in the package and that they share a common component. + +## -property-value +**True** means the group is part of a shared resource group; **false**, otherwise. + +## -remarks +When a resource group is shared, it will show up in the resource group collections reported by multiple apps if those apps that share this resource group are currently running. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher.md b/windows.system/appresourcegroupinfowatcher.md new file mode 100644 index 0000000000..9dde8d1424 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.System.AppResourceGroupInfoWatcher +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupInfoWatcher + +## -description +Allows you to monitor the set of resource groups ([AppResourceGroupInfo](appresourcegroupinfo.md) objects) for an app, and get notifications when a resource group is added or removed. + +## -remarks +For example, a resource group is added when an out-of-process background task is activated; a resource group is removed when a background task completes. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_added.md b/windows.system/appresourcegroupinfowatcher_added.md new file mode 100644 index 0000000000..f932a2ddfc --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_added.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.System.AppResourceGroupInfoWatcher.Added +-api-type: winrt event +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.Added + +## -description +Event that fires when a resource group is added. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_enumerationcompleted.md b/windows.system/appresourcegroupinfowatcher_enumerationcompleted.md new file mode 100644 index 0000000000..ebd5fe371b --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_enumerationcompleted.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.System.AppResourceGroupInfoWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.EnumerationCompleted + +## -description +Fires when the watcher has completed enumerating the resource groups that are available to monitor. + +## -remarks + After enumeration is complete, the watcher will start reporting when items are added or removed. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_executionstatechanged.md b/windows.system/appresourcegroupinfowatcher_executionstatechanged.md new file mode 100644 index 0000000000..9ce149d838 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_executionstatechanged.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.System.AppResourceGroupInfoWatcher.ExecutionStateChanged +-api-type: winrt event +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.ExecutionStateChanged + +## -description +Event that fires when the execution state (running, suspending, an so on) for this group changes. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_removed.md b/windows.system/appresourcegroupinfowatcher_removed.md new file mode 100644 index 0000000000..d536a6f920 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_removed.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.System.AppResourceGroupInfoWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.Removed + +## -description +Fires when one of the resource groups has been removed from the list of [AppResourceGroupInfos](appresourcegroupinfo.md) in the package. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_start_1587696324.md b/windows.system/appresourcegroupinfowatcher_start_1587696324.md new file mode 100644 index 0000000000..ca7d4cda33 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_start_1587696324.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.System.AppResourceGroupInfoWatcher.Start +-api-type: winrt method +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.Start + +## -description +Start firing events when the execution state changes, or resource groups change, within the set of resource groups for this app. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_status.md b/windows.system/appresourcegroupinfowatcher_status.md new file mode 100644 index 0000000000..25b30ec8c4 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_status.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfoWatcher.Status +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.Status + +## -description +Gets this **AppResourceGroupInfoWatcher** status. + +## -property-value +The status such as Started, Stopped, and so on. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_stop_1201535524.md b/windows.system/appresourcegroupinfowatcher_stop_1201535524.md new file mode 100644 index 0000000000..04b8aec192 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_stop_1201535524.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.System.AppResourceGroupInfoWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.Stop + +## -description +Stops firing events when the execution state changes, or resource groups change, within the set of resource groups for this app. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcher_stopped.md b/windows.system/appresourcegroupinfowatcher_stopped.md new file mode 100644 index 0000000000..abce360821 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcher_stopped.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.System.AppResourceGroupInfoWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.System.AppResourceGroupInfoWatcher.Stopped + +## -description +Event that fires when this **AppResourceGroupInfoWatcher** stops watching for resource group changes. + +## -remarks + +## -see-also +[Windows.System.AppResourceGroupInfoWatcher.Stop](appresourcegroupinfowatcher_stop_1201535524.md) + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatchereventargs.md b/windows.system/appresourcegroupinfowatchereventargs.md new file mode 100644 index 0000000000..71cd54d960 --- /dev/null +++ b/windows.system/appresourcegroupinfowatchereventargs.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.AppResourceGroupInfoWatcherEventArgs +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupInfoWatcherEventArgs + +## -description +Provides information about app resource groups. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatchereventargs_appdiagnosticinfos.md b/windows.system/appresourcegroupinfowatchereventargs_appdiagnosticinfos.md new file mode 100644 index 0000000000..9815834326 --- /dev/null +++ b/windows.system/appresourcegroupinfowatchereventargs_appdiagnosticinfos.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfoWatcherEventArgs.AppDiagnosticInfos +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfoWatcherEventArgs.AppDiagnosticInfos + +## -description +Gets diagnostic info for the resource group. + +## -property-value +The diagnostic info for the apps associated with the [AppResourceGroupInfo](appresourcegroupinfo.md) for the current event. + +## -remarks +Typically there will only be one app associated with the **AppResourceGroupInfo**, but there can be more. + +## -see-also + +## -examples +```csharp +// A resource group has been added to the list in the AppDiagnosticInfo. +private void OnResourceGroupAdded( + AppResourceGroupInfoWatcher sender, AppResourceGroupInfoWatcherEventArgs args) +{ + // A resource group can be associated with multiple apps. The event args here + // indicate which apps are part of the watched resource group. Otherwise the + // app has to keep a map between them. + if (args.AppDiagnosticInfos.Count > 0) + { + Debug.WriteLine("ResourceGroup added for {0}", args.AppDiagnosticInfos[0].AppInfo.DisplayInfo); + } +} +``` + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatchereventargs_appresourcegroupinfo.md b/windows.system/appresourcegroupinfowatchereventargs_appresourcegroupinfo.md new file mode 100644 index 0000000000..e64458530a --- /dev/null +++ b/windows.system/appresourcegroupinfowatchereventargs_appresourcegroupinfo.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfoWatcherEventArgs.AppResourceGroupInfo +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfoWatcherEventArgs.AppResourceGroupInfo + +## -description +Gets diagnostic info, such as memory usage, and energy use. + +## -property-value +The **AppResourceGroupInfo** that was added or removed. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs.md b/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs.md new file mode 100644 index 0000000000..dd61c56384 --- /dev/null +++ b/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.System.AppResourceGroupInfoWatcherExecutionStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupInfoWatcherExecutionStateChangedEventArgs + +## -description +Provides info about the execution state of this resource group when the state changes. + +## -remarks + +## -see-also +[Windows.System.AppResourceGroupInfoWatcher.ExecutionStateChanged](appresourcegroupinfowatcher_executionstatechanged.md) + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs_appdiagnosticinfos.md b/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs_appdiagnosticinfos.md new file mode 100644 index 0000000000..d11330f24b --- /dev/null +++ b/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs_appdiagnosticinfos.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfoWatcherExecutionStateChangedEventArgs.AppDiagnosticInfos +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfoWatcherExecutionStateChangedEventArgs.AppDiagnosticInfos + +## -description +Gets diagnostic info for the resource group. + +## -property-value +The diagnostic info for each resource group associated with this app. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs_appresourcegroupinfo.md b/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs_appresourcegroupinfo.md new file mode 100644 index 0000000000..9be83617de --- /dev/null +++ b/windows.system/appresourcegroupinfowatcherexecutionstatechangedeventargs_appresourcegroupinfo.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupInfoWatcherExecutionStateChangedEventArgs.AppResourceGroupInfo +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupInfoWatcherExecutionStateChangedEventArgs.AppResourceGroupInfo + +## -description +Gets diagnostic info, such as memory usage over time, energy use over time, and so on. + +## -property-value +The diagnostic info for this app. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupinfowatcherstatus.md b/windows.system/appresourcegroupinfowatcherstatus.md new file mode 100644 index 0000000000..ecbedec8ca --- /dev/null +++ b/windows.system/appresourcegroupinfowatcherstatus.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.System.AppResourceGroupInfoWatcherStatus +-api-type: winrt enum +--- + + + +# Windows.System.AppResourceGroupInfoWatcherStatus + +## -description +Describes the various states that the [AppResourceGroupInfoWatcher](appresourcegroupinfowatcher.md) may be in. + +## -enum-fields +### -field Stopping:3 +The watcher is in the process of stopping monitoring changes. + +### -field Stopped:4 +The watcher has stopped monitoring changes. + +### -field Started:1 +The watcher has started monitoring changes. + +### -field EnumerationCompleted:2 +The watcher has completed enumerating the resource groups that are available to monitor. After enumeration is complete, the watcher will report when items are added or removed. + +### -field Created:0 +The watcher has been created. + +### -field Aborted:5 +The watcher has been stopped by the system as the result of an internal error or other failure condition. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/appresourcegroupmemoryreport.md b/windows.system/appresourcegroupmemoryreport.md new file mode 100644 index 0000000000..6e268afdeb --- /dev/null +++ b/windows.system/appresourcegroupmemoryreport.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.System.AppResourceGroupMemoryReport +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupMemoryReport + +## -description +Provides memory information for a resource group, such as commit usage. + +## -remarks + +## -see-also + +[Pushing the Limits of Windows: Virtual Memory](https://blogs.technet.microsoft.com/markrussinovich/2008/11/17/pushing-the-limits-of-windows-virtual-memory/) + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupmemoryreport_commitusagelevel.md b/windows.system/appresourcegroupmemoryreport_commitusagelevel.md new file mode 100644 index 0000000000..f405d81fa9 --- /dev/null +++ b/windows.system/appresourcegroupmemoryreport_commitusagelevel.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.System.AppResourceGroupMemoryReport.CommitUsageLevel +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupMemoryReport.CommitUsageLevel + +## -description +Returns the commit usage level for the resource group. + +## -property-value +The amount of memory that has been allocated a data storage location as opposed to simply being reserved for future allocation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/appresourcegroupmemoryreport_commitusagelimit.md b/windows.system/appresourcegroupmemoryreport_commitusagelimit.md new file mode 100644 index 0000000000..45409cae3f --- /dev/null +++ b/windows.system/appresourcegroupmemoryreport_commitusagelimit.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.System.AppResourceGroupMemoryReport.CommitUsageLimit +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupMemoryReport.CommitUsageLimit + +## -description +Gets the limit of the amount of memory that can be committed (allocated) by this resource group. + +## -property-value +The maximum amount of memory that is available for allocation. + +## -remarks +The commit limit is roughly the current pagefile size + the amount of RAM - the amount of RAM allocated to non-pageable memory. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupmemoryreport_privatecommitusage.md b/windows.system/appresourcegroupmemoryreport_privatecommitusage.md new file mode 100644 index 0000000000..489f3f216a --- /dev/null +++ b/windows.system/appresourcegroupmemoryreport_privatecommitusage.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupMemoryReport.PrivateCommitUsage +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupMemoryReport.PrivateCommitUsage + +## -description +Gets the amount of private memory (memory that can't be shared between processes) committed by this resource group. + +## -property-value +The amount of private commit memory. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupmemoryreport_totalcommitusage.md b/windows.system/appresourcegroupmemoryreport_totalcommitusage.md new file mode 100644 index 0000000000..2d5bc85363 --- /dev/null +++ b/windows.system/appresourcegroupmemoryreport_totalcommitusage.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.System.AppResourceGroupMemoryReport.TotalCommitUsage +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupMemoryReport.TotalCommitUsage + +## -description +Gets the total amount of memory committed by this resource group. + +## -property-value +The total amount of committed memory. + +## -remarks +The total amount of committed memory is the sum of the private commit + the shared commit. + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupstatereport.md b/windows.system/appresourcegroupstatereport.md new file mode 100644 index 0000000000..c663bd89e9 --- /dev/null +++ b/windows.system/appresourcegroupstatereport.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.AppResourceGroupStateReport +-api-type: winrt class +--- + + + +# Windows.System.AppResourceGroupStateReport + +## -description +Provides information, such as the execution state and energy quota usage, for a resource group. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupstatereport_energyquotastate.md b/windows.system/appresourcegroupstatereport_energyquotastate.md new file mode 100644 index 0000000000..a679c676ac --- /dev/null +++ b/windows.system/appresourcegroupstatereport_energyquotastate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupStateReport.EnergyQuotaState +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupStateReport.EnergyQuotaState + +## -description +Gets the energy quota state of the resource group, such as whether it is under quota or over quota. + +## -property-value +The energy quota state. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/appresourcegroupstatereport_executionstate.md b/windows.system/appresourcegroupstatereport_executionstate.md new file mode 100644 index 0000000000..603e52e6c4 --- /dev/null +++ b/windows.system/appresourcegroupstatereport_executionstate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.AppResourceGroupStateReport.ExecutionState +-api-type: winrt property +--- + + + +# Windows.System.AppResourceGroupStateReport.ExecutionState + +## -description +Gets the execution state of the resource group, such as whether it is suspended, running, and so on. + +## -property-value +The execution state. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/datetimesettings.md b/windows.system/datetimesettings.md new file mode 100644 index 0000000000..12cbf90ba9 --- /dev/null +++ b/windows.system/datetimesettings.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.System.DateTimeSettings +-api-type: winrt class +--- + + + +# Windows.System.DateTimeSettings + +## -description +Sets the system date and time. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/datetimesettings_setsystemdatetime_1576727465.md b/windows.system/datetimesettings_setsystemdatetime_1576727465.md new file mode 100644 index 0000000000..328f41b8f4 --- /dev/null +++ b/windows.system/datetimesettings_setsystemdatetime_1576727465.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.System.DateTimeSettings.SetSystemDateTime(Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.System.DateTimeSettings.SetSystemDateTime + +## -description +Set the system date and time. + +## -parameters +### -param utcDateTime +The date and time value (in coordinated universal time (UTC)) to set the system clock to. + +## -remarks +Coordinated universal time does not observe daylight saving time. + +## -see-also + +## -examples diff --git a/windows.system/diagnosticaccessstatus.md b/windows.system/diagnosticaccessstatus.md new file mode 100644 index 0000000000..bd723e22f1 --- /dev/null +++ b/windows.system/diagnosticaccessstatus.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.System.DiagnosticAccessStatus +-api-type: winrt enum +--- + + + +# Windows.System.DiagnosticAccessStatus + +## -description +Indicates if your app has permission to access to UWP app diagnostic information. + +## -enum-fields +### -field Unspecified:0 +Diagnostic access is unspecified. + +### -field Limited:2 +Diagnostic access is allowed for this app package only. + +### -field Denied:1 +Diagnostic access is denied for all app packages. + +### -field Allowed:3 +Diagnostic access is allowed for all app packages. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +appDiagnostics diff --git a/windows.system/dispatcherqueue.md b/windows.system/dispatcherqueue.md index dbfdc17edd..23da488946 100644 --- a/windows.system/dispatcherqueue.md +++ b/windows.system/dispatcherqueue.md @@ -4,16 +4,17 @@ --- # Windows.System.DispatcherQueue ## -description +Manages a prioritized queue on which tasks execute in a serial fashion on a thread. ## -remarks +All tasks dispatched to a queue execute on the same thread. ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueue_createtimer_750542120.md b/windows.system/dispatcherqueue_createtimer_750542120.md index 7047069d4c..469d3785c4 100644 --- a/windows.system/dispatcherqueue_createtimer_750542120.md +++ b/windows.system/dispatcherqueue_createtimer_750542120.md @@ -10,12 +10,14 @@ public DispatcherQueueTimer DispatcherQueue.CreateTimer() # Windows.System.DispatcherQueue.CreateTimer ## -description +Creates a **DispatcherQueueTimer** on the **DispatcherQueue** to execute a task periodically after a time interval has elapsed. ## -returns +An **DispatcherQueueTimer** that can queue tasks on a timed basis to the current **DispatcherQueue**. ## -remarks +By default, a repeating timer is created. Set **IsRepeating** to **false** to make it non-repeating. ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueue_getforcurrentthread_1771949562.md b/windows.system/dispatcherqueue_getforcurrentthread_1771949562.md index 1bd9a0cebb..48306d5f0b 100644 --- a/windows.system/dispatcherqueue_getforcurrentthread_1771949562.md +++ b/windows.system/dispatcherqueue_getforcurrentthread_1771949562.md @@ -10,12 +10,13 @@ public DispatcherQueue DispatcherQueue.GetForCurrentThread() # Windows.System.DispatcherQueue.GetForCurrentThread ## -description +Gets the **DispatcherQueue** associated with the current thread. ## -returns +A **DispatcherQueue** instance that will execute tasks serially on the current thread. ## -remarks ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueue_shutdowncompleted.md b/windows.system/dispatcherqueue_shutdowncompleted.md new file mode 100644 index 0000000000..50cbdafcad --- /dev/null +++ b/windows.system/dispatcherqueue_shutdowncompleted.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.System.DispatcherQueue.ShutdownCompleted +-api-type: winrt event +--- + + + +# Windows.System.DispatcherQueue.ShutdownCompleted + +## -description +Fires after the **DispatcherQueue** event loop stops which is the last step in the **DispatcherQueue** shutdown process. + +## -remarks +The event is fired on the thread running the **DispatcherQueue** event loop. After this event is fired, any work posted to the **DispatcherQueue** will not be scheduled. + +## -see-also + +## -examples +```csharp +// Invoked after the DispatcherQueue event loop exits. +_dispatcherQueue.ShutdownCompleted += (s, e) => +{ + // clean up state +}; +``` diff --git a/windows.system/dispatcherqueue_shutdownstarting.md b/windows.system/dispatcherqueue_shutdownstarting.md new file mode 100644 index 0000000000..570c462d2d --- /dev/null +++ b/windows.system/dispatcherqueue_shutdownstarting.md @@ -0,0 +1,34 @@ +--- +-api-id: E:Windows.System.DispatcherQueue.ShutdownStarting +-api-type: winrt event +--- + + + +# Windows.System.DispatcherQueue.ShutdownStarting + +## -description +Fires before the dispatcher queue initiates an exit from its event loop. + +## -remarks +The event is fired on the thread running the **DispatcherQueue** event loop. + +This event fires before the **DispatcherQueue** initiates the exit from the event loop. Event handlers for this event can queue work from within the handler. The event handler can take a deferral and continue to post work to the **DispatcherQueue** until the deferral completes. Once the deferral completes, no new work will be accepted by the **DispatcherQueue**. + +## -see-also + +## -examples +```csharp +_dispatcherQueue.ShutdownStarting += (s, e) => +{ + // Queue is shutting down, do this last operation to + // update state before the dispatcher loop exits + _queue.TryEnqueue( + () => + { + // clean up state + }); +}; +``` diff --git a/windows.system/dispatcherqueue_tryenqueue_1081774707.md b/windows.system/dispatcherqueue_tryenqueue_1081774707.md index 43d53babc4..1ea27b1176 100644 --- a/windows.system/dispatcherqueue_tryenqueue_1081774707.md +++ b/windows.system/dispatcherqueue_tryenqueue_1081774707.md @@ -10,17 +10,43 @@ public bool DispatcherQueue.TryEnqueue(DispatcherQueuePriority priority, Dispatc # Windows.System.DispatcherQueue.TryEnqueue ## -description +Adds a task to the **DispatcherQueue** which will be executed on the thread associated with the **DispatcherQueue**. ## -parameters ### -param priority +The priority of the task such as Low, Normal, or High. ### -param callback +A delegate to the task to execute. ## -returns +**True** indicates that the task was added to the queue; **false**, otherwise. ## -remarks +The queue will invoke **callback** serially and in priority order. + +Once [ShutdownQueueAsync()](dispatcherqueuecontroller_shutdownqueueasync_542547627.md) has been called, the queue will not queue new tasks and this method will return **false**. ## -see-also ## -examples +``` csharp +// Create a new thread and initialize a DispatcherQueueController +// and run a DispatcherQueue event loop on it. + +_queueController = + DispatcherQueueController.CreateOnDedicatedThread(); +_queue = _queueController.DispatcherQueue; + +// This is the first TryEnqueue() after creating the DispatcherQueue. The +// first TryEnqueue task is guaranteed //to be invoked first on the new +// thread, regardless of what priority it was enqueued at. + + +bool isQueued = _queue.TryEnqueue(Windows.System.DispatcherQueuePriority.High, + () => + { + // task to perform on another thread. + }); +``` diff --git a/windows.system/dispatcherqueue_tryenqueue_591440238.md b/windows.system/dispatcherqueue_tryenqueue_591440238.md index 261c481d7d..623bfc15cf 100644 --- a/windows.system/dispatcherqueue_tryenqueue_591440238.md +++ b/windows.system/dispatcherqueue_tryenqueue_591440238.md @@ -10,15 +10,38 @@ public bool DispatcherQueue.TryEnqueue(DispatcherQueueHandler callback) # Windows.System.DispatcherQueue.TryEnqueue ## -description +Adds a task to the **DispatcherQueue** which will be executed on the thread associated with the **DispatcherQueue**. ## -parameters ### -param callback +The task to execute. ## -returns +**True** indicates that the task was added to the queue; **false**, otherwise. ## -remarks +The task will be queued at **Normal** priority. The queue will invoke **callback** serially and in priority order. + +Once [ShutdownQueueAsync()](dispatcherqueuecontroller_shutdownqueueasync_542547627.md) has been called, the queue will not queue new tasks and this method will return **false**. ## -see-also ## -examples +``` csharp +// Create a new thread and initialize a DispatcherQueueController +// and run a DispatcherQueue event loop on it. + +_queueController = + DispatcherQueueController.CreateOnDedicatedThread(); +_queue = _queueController.DispatcherQueue; + +// This is the first TryEnqueue() after creating the DispatcherQueue +// The callback is guaranteed to be invoked first despite Priority on the +// newly created thread. +bool isQueued = _queue.TryEnqueue( + () => + { + // task to perform on another thread. + }); +``` diff --git a/windows.system/dispatcherqueuecontroller.md b/windows.system/dispatcherqueuecontroller.md index 18886bb876..0e3fe865aa 100644 --- a/windows.system/dispatcherqueuecontroller.md +++ b/windows.system/dispatcherqueuecontroller.md @@ -4,16 +4,20 @@ --- # Windows.System.DispatcherQueueController ## -description +Manages the lifetime of a [DispatcherQueue](dispatcherqueue.md). Provides methods to create and shutdown the **DispatcherQueue**. ## -remarks +*Object and Thread Lifetime* + +**DispatcherQueueController** and its associated **DispatcherQueue** will be kept alive while the event loop is running. When **Shutdown** is completed, the loop is terminated and the dedicated thread will unwind. However, +**DispacherQueueController** and the associated **DispatcherQueue** object can outlive thread’s lifetime and will be disposed when all their references are released. ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueuecontroller_createondedicatedthread_660689653.md b/windows.system/dispatcherqueuecontroller_createondedicatedthread_660689653.md new file mode 100644 index 0000000000..4f28c0c5ef --- /dev/null +++ b/windows.system/dispatcherqueuecontroller_createondedicatedthread_660689653.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.DispatcherQueueController.CreateOnDedicatedThread +-api-type: winrt method +--- + + + +# Windows.System.DispatcherQueueController.CreateOnDedicatedThread + +## -description +Creates a [DispatcherQueue](dispatcherqueue.md) that you can use to run tasks on a dedicated thread. + +## -returns +The created **DispatcherQueueController**. + +## -remarks +You can access the created **DispatcherQueue** via [DispatcherQueueController.DispatcherQueue](dispatcherqueuecontroller_dispatcherqueue.md). + +## -see-also + +## -examples diff --git a/windows.system/dispatcherqueuecontroller_dispatcherqueue.md b/windows.system/dispatcherqueuecontroller_dispatcherqueue.md index 643e4e3b43..26bd90318f 100644 --- a/windows.system/dispatcherqueuecontroller_dispatcherqueue.md +++ b/windows.system/dispatcherqueuecontroller_dispatcherqueue.md @@ -10,12 +10,13 @@ public DispatcherQueue DispatcherQueue { get; } # Windows.System.DispatcherQueueController.DispatcherQueue ## -description +Gets the **DispatcherQueue** associated with this **DispatcherQueueController**. ## -property-value +The **DispatcherQueue** instance that you use to queue tasks that run on a thread. ## -remarks ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueuecontroller_shutdownqueueasync_542547627.md b/windows.system/dispatcherqueuecontroller_shutdownqueueasync_542547627.md index bb7f60d80f..d0cf71c72e 100644 --- a/windows.system/dispatcherqueuecontroller_shutdownqueueasync_542547627.md +++ b/windows.system/dispatcherqueuecontroller_shutdownqueueasync_542547627.md @@ -10,12 +10,57 @@ public IAsyncAction DispatcherQueueController.ShutdownQueueAsync() # Windows.System.DispatcherQueueController.ShutdownQueueAsync ## -description +Stops the **DispatcherQueue** associated with this **DispatcherQueueController**. Shuts down the thread if the **DispatcherQueueController** was created by **CreateOnDedicatedThread**. ## -returns +An asynchronous operation which will complete after the queue has dispatched all of its remaining work. ## -remarks +After [ShutdownQueueAsync](https://microsoft.sharepoint.com/sites/infopedia/engineering) fires, two events ([DispatcherQueue.ShutdownStarting](dispatcherqueue_shutdownstarting.md) and [DispatcherQueue.ShutdownCompleted](dispatcherqueue_shutdowncompleted.md)) fire on the **DispatcherQueue** to notify listeners that the **DispatcherQueue** is shutting down. The events are fired on the thread running the **DispatcherQueue** event loop itself. + +**DispatcherQueue.ShutdownStarting** fires before the event loop exits. The event handler can take a deferral and continue to post work until the deferral completes. Once the deferral completes, the **DispatcherQueue** will no longer accept work and **DispatcherQueue.TryEnqueue** will return false. +**DispatcherQueue.ShutdownCompleted** will fire after the event loop has been exited. This event can be used to clean up any state maintained by partner components that were maintained on the dedicated thread. ## -see-also ## -examples +```csharp +// Shutdown the event loop +public async void ShutdownLoop() +{ + if (_queueController != null) + { + // The await will complete after the event loop exits + await _queueController.ShutdownQueueAsync(); + _queueController = null; + _queue = null; + } +} + +// Another class that has access to the dedicated thread’s DispatcherQueue. +public class ModuleA +{ + public async void ShutdownSetup() + { + // Gets the DispatcherQueue for the dedicated thread + + // Invoked when controller begins the ShutdownQueueAsync. + _dispatcherQueue.ShutdownStarting += (s, e) => + { + // Queue is shutting down, do this last operation which + // will update state before the loop exits + _queue.TryEnqueue( + () => + { + FinalInThreadCleanup(_myState); + }); + }; + // Invoked after the DispatcherQueue event loop exits. + _dispatcherQueue.ShutdownCompleted += (s, e) => + { + CleanUp(_myState); + }; + } +} +``` diff --git a/windows.system/dispatcherqueuehandler.md b/windows.system/dispatcherqueuehandler.md index 4125aaecdf..ddd9794c93 100644 --- a/windows.system/dispatcherqueuehandler.md +++ b/windows.system/dispatcherqueuehandler.md @@ -10,11 +10,18 @@ public delegate void DispatcherQueueHandler() # Windows.System.DispatcherQueueHandler ## -description +A callback that will be executed on the **DispatcherQueue** thread. ## -parameters + ## -remarks ## -see-also ## -examples - +```csharp +Windows.System.DispatcherQueueHandler handler = () => + { + // code for DispatcherQueue to run + }; +``` diff --git a/windows.system/dispatcherqueuepriority.md b/windows.system/dispatcherqueuepriority.md index b676e7a3d9..0469eb7454 100644 --- a/windows.system/dispatcherqueuepriority.md +++ b/windows.system/dispatcherqueuepriority.md @@ -4,23 +4,26 @@ --- # Windows.System.DispatcherQueuePriority ## -description +Defines the priority levels that can be given to work assigned to a [DispatcherQueue](dispatcherqueue.md). ## -enum-fields ### -field Normal:0 +Work will be dispatched once all **High** priority tasks are dispatched. If a new **High** priority work is scheduled, all new **High** priority tasks are processed before resuming **Normal** tasks. This is the default priority. ### -field Low:-10 +**Low** priority work will be scheduled when there isn't any other work to process. Work at **Low** priority can be preempted by new incoming **High** and **Normal** priority tasks. ### -field High:10 +Work scheduled at **High** priority will be dispatched first, along with other **High** priority System tasks, before processing **Normal** or **Low** priority work. ## -remarks ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueueshutdownstartingeventargs.md b/windows.system/dispatcherqueueshutdownstartingeventargs.md new file mode 100644 index 0000000000..4d76d8c3b9 --- /dev/null +++ b/windows.system/dispatcherqueueshutdownstartingeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.System.DispatcherQueueShutdownStartingEventArgs +-api-type: winrt class +--- + + + +# Windows.System.DispatcherQueueShutdownStartingEventArgs + +## -description +Provides the arguments for the [ShutdownStarting](dispatcherqueue_shutdownstarting.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/dispatcherqueueshutdownstartingeventargs_getdeferral_254836512.md b/windows.system/dispatcherqueueshutdownstartingeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..812b0cd2ef --- /dev/null +++ b/windows.system/dispatcherqueueshutdownstartingeventargs_getdeferral_254836512.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.System.DispatcherQueueShutdownStartingEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.System.DispatcherQueueShutdownStartingEventArgs.GetDeferral + +## -description +Gets a deferral object so that you can use to continue to post work to the **DisbpatcherQueue** until you mark the deferral complete. + +## -returns +The deferral object. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/dispatcherqueuetimer.md b/windows.system/dispatcherqueuetimer.md index 55a61762bd..6ca9990b18 100644 --- a/windows.system/dispatcherqueuetimer.md +++ b/windows.system/dispatcherqueuetimer.md @@ -4,16 +4,45 @@ --- # Windows.System.DispatcherQueueTimer ## -description +Executes a task in a **DispatcherQueue** periodically after a time interval has elapsed. ## -remarks +The system guarantees to invoke the event handler only after the specified duration expires. However, there may be some delay before the tick handler is invoked if there are other pending work items in the queue. + +Timer tasks run at a priority lower than idle. + +Timers don’t keep the **DispatcherQueue** event loop alive. Timers created after the **DispatcherQueue** event loop has stopped will not be processed. ## -see-also ## -examples +```csharp +public void ConfigureRepeatingTimer() +{ + _queueController = DispatcherQueueController.CreateOnDedicatedThread(); + _queue = _queueController.DispatcherQueue; + + _repeatingTimer = _queue.CreateTimer (); + _repeatingTimer.Interval = TimeSpan.FromSeconds(5); + + // The tick handler will be invoked repeatedly after every 5 + // seconds on the dedicated thread. + _repeatingTimer.Tick += (s, e) => + { + DoWork(); + }; + + // Start the Timer + _repeatingTimer.Start(); +} +private DispatcherQueue _queue; +private DispatcherQueueController _queueController; +private DispatcherQueueTimer _repeatingTimer; +``` diff --git a/windows.system/dispatcherqueuetimer_interval.md b/windows.system/dispatcherqueuetimer_interval.md index 58df071362..b65c873bdf 100644 --- a/windows.system/dispatcherqueuetimer_interval.md +++ b/windows.system/dispatcherqueuetimer_interval.md @@ -10,12 +10,14 @@ public TimeSpan Interval { get; set; } # Windows.System.DispatcherQueueTimer.Interval ## -description +Gets and sets the interval for the timer. ## -property-value +The amount of time before the timer ticks. ## -remarks +If you change the **DispatcherQueueTimer.Interval** while the timer is running, the timer will restart with the new value. ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueuetimer_isrepeating.md b/windows.system/dispatcherqueuetimer_isrepeating.md index 91ffa74887..a6b09b2c3b 100644 --- a/windows.system/dispatcherqueuetimer_isrepeating.md +++ b/windows.system/dispatcherqueuetimer_isrepeating.md @@ -10,12 +10,14 @@ public bool IsRepeating { get; set; } # Windows.System.DispatcherQueueTimer.IsRepeating ## -description +Indicates whether the timer is repeating. ## -property-value +**True** indicates that the timer fires every **DispatcherQueueTimer.Interval**; **false** means that it fires once, after **DispatcherQueueTimer.Interval** elapses. ## -remarks +If you change the **IsRepeating** value while the timer is running, the timer will restart with the new value. ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueuetimer_isrunning.md b/windows.system/dispatcherqueuetimer_isrunning.md new file mode 100644 index 0000000000..ff6dc3945a --- /dev/null +++ b/windows.system/dispatcherqueuetimer_isrunning.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.System.DispatcherQueueTimer.IsRunning +-api-type: winrt property +--- + + + +# Windows.System.DispatcherQueueTimer.IsRunning + +## -description +Indicates whether the timer is currently running. + +## -property-value +**True** indicates that the timer is running; otherwise **false** + +## -remarks + +## -see-also + +## -examples diff --git a/windows.system/dispatcherqueuetimer_start_1587696324.md b/windows.system/dispatcherqueuetimer_start_1587696324.md index d0f9948c9c..bf56748aeb 100644 --- a/windows.system/dispatcherqueuetimer_start_1587696324.md +++ b/windows.system/dispatcherqueuetimer_start_1587696324.md @@ -10,10 +10,10 @@ public void DispatcherQueueTimer.Start() # Windows.System.DispatcherQueueTimer.Start ## -description +Starts the timer. ## -remarks ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueuetimer_stop_1201535524.md b/windows.system/dispatcherqueuetimer_stop_1201535524.md index fd612e28c0..4364029f51 100644 --- a/windows.system/dispatcherqueuetimer_stop_1201535524.md +++ b/windows.system/dispatcherqueuetimer_stop_1201535524.md @@ -10,10 +10,10 @@ public void DispatcherQueueTimer.Stop() # Windows.System.DispatcherQueueTimer.Stop ## -description +Stops the timer. ## -remarks ## -see-also ## -examples - diff --git a/windows.system/dispatcherqueuetimer_tick.md b/windows.system/dispatcherqueuetimer_tick.md index 2649819eab..581574782a 100644 --- a/windows.system/dispatcherqueuetimer_tick.md +++ b/windows.system/dispatcherqueuetimer_tick.md @@ -10,10 +10,10 @@ public event TypedEventHandler Tick # Windows.System.DispatcherQueueTimer.Tick ## -description +Event that fires when the timer **Interval** elapses. ## -remarks ## -see-also ## -examples - diff --git a/windows.system/memorymanager_expectedappmemoryusagelimit.md b/windows.system/memorymanager_expectedappmemoryusagelimit.md new file mode 100644 index 0000000000..b6c10c34ca --- /dev/null +++ b/windows.system/memorymanager_expectedappmemoryusagelimit.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.System.MemoryManager.ExpectedAppMemoryUsageLimit +-api-type: winrt property +--- + + + +# Windows.System.MemoryManager.ExpectedAppMemoryUsageLimit + +## -description +Gets the amount of memory that your app may expect to have available. + +## -property-value +The expected memory cap in bytes. + +## -remarks +When an app launches on Xbox, it is initially given a small app memory usage limit that may grow as the system frees memory. This property returns the expected upper limit that your app will be able to use. + +When an app launches on a non-Xbox system, the memory usage limit the app gets at launch remains the same and this property will return the same value as [Windows.System.MemoryManager.AppMemoryUsageLimit](memorymanager_appmemoryusagelimit.md). + +## -see-also +[](memorymanager_appmemoryusagelimitchanging.md) +[](memorymanager_trysetappmemoryusagelimit_415446483.md) + +## -examples diff --git a/windows.system/memorymanager_trysetappmemoryusagelimit_415446483.md b/windows.system/memorymanager_trysetappmemoryusagelimit_415446483.md index f4a8bf6b26..4c7ee0da42 100644 --- a/windows.system/memorymanager_trysetappmemoryusagelimit_415446483.md +++ b/windows.system/memorymanager_trysetappmemoryusagelimit_415446483.md @@ -17,7 +17,7 @@ Tries to set a specific memory cap for the current app or task. In cases where m The new memory limit to set. ## -returns -True if the operation succeeded; otherwise, false. +**True** if the operation succeeded; otherwise, **false**. ## -remarks diff --git a/windows.ui.composition.effects/scenelightingeffect_reflectancemodel.md b/windows.ui.composition.effects/scenelightingeffect_reflectancemodel.md new file mode 100644 index 0000000000..730b02bdc5 --- /dev/null +++ b/windows.ui.composition.effects/scenelightingeffect_reflectancemodel.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Effects.SceneLightingEffect.ReflectanceModel +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Effects.SceneLightingEffect.ReflectanceModel + +## -description + +Gets or sets a value that indicates how the reflectance of a [SceneLightingEffect](scenelightingeffect.md) is modeled. + +## -property-value + +A value that indicates how the reflectance of a [SceneLightingEffect](scenelightingeffect.md) is modeled. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.effects/scenelightingeffectreflectancemodel.md b/windows.ui.composition.effects/scenelightingeffectreflectancemodel.md new file mode 100644 index 0000000000..0c78b1ba07 --- /dev/null +++ b/windows.ui.composition.effects/scenelightingeffectreflectancemodel.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.UI.Composition.Effects.SceneLightingEffectReflectanceModel +-api-type: winrt enum +--- + + + +# Windows.UI.Composition.Effects.SceneLightingEffectReflectanceModel + +## -description + +Defines constants that specify how the reflectance of a [SceneLightingEffect](scenelightingeffect.md) is modeled. + +## -enum-fields + +### -field PhysicallyBasedBlinnPhong:1 + +The PhysicallyBasedBlinnPhong model is used. + +### -field BlinnPhong:0 + +The BlinnPhong model is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontracker_configurevector2positioninertiamodifiers_19386247.md b/windows.ui.composition.interactions/interactiontracker_configurevector2positioninertiamodifiers_19386247.md new file mode 100644 index 0000000000..83127aca4c --- /dev/null +++ b/windows.ui.composition.interactions/interactiontracker_configurevector2positioninertiamodifiers_19386247.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.InteractionTracker.ConfigureVector2PositionInertiaModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaModifier}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.InteractionTracker.ConfigureVector2PositionInertiaModifiers + +## -description + +Applies a collection of InteractionTrackerInertiaModifier objects to the position of an InteractionTracker. + +## -parameters +### -param modifiers + +The collection of InteractionTrackerInertiaModifier objects to apply to the position of an InteractionTracker. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion.md b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion.md new file mode 100644 index 0000000000..85386a57f2 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion +-api-type: winrt class +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion + +## -description + +A [ScalarNaturalMotionAnimation](../windows.ui.composition/scalarnaturalmotionanimation.md) that defines motion of InteractionTracker during its inertia state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_condition.md b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_condition.md new file mode 100644 index 0000000000..b710043fc6 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_condition.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion.Condition +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion.Condition + +## -description + +Gets or sets an [ExpressionAnimation](../windows.ui.composition/expressionanimation.md) describing when the modifier should be applied. + +## -property-value + +An [ExpressionAnimation](../windows.ui.composition/expressionanimation.md) describing when the modifier should be applied. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_create_996921895.md b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_create_996921895.md new file mode 100644 index 0000000000..8b89150539 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_create_996921895.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion.Create(Windows.UI.Composition.Compositor) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion.Create + +## -description + +Creates an instance of [InteractionTrackerInertiaNaturalMotion](interactiontrackerinertianaturalmotion.md). + +## -parameters +### -param compositor + +The compositor to use when creating the InteractionTrackerInertiaNaturalMotion object. + +## -returns + +Returns the created InteractionTrackerInertiaNaturalMotion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_naturalmotion.md b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_naturalmotion.md new file mode 100644 index 0000000000..8260b8ece4 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackerinertianaturalmotion_naturalmotion.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion.NaturalMotion +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerInertiaNaturalMotion.NaturalMotion + +## -description + +Gets or set a [ScalarNaturalMotionAnimation](../windows.ui.composition/scalarnaturalmotionanimation.md) that describes the modified motion for [InteractionTracker](interactiontracker.md) if the expression in the Condition property is **true**. + +## -property-value + +A ScalarNaturalMotionAnimation that describes the modified motion for [InteractionTracker](interactiontracker.md) if the expression in the Condition property is **true**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackervector2inertiamodifier.md b/windows.ui.composition.interactions/interactiontrackervector2inertiamodifier.md new file mode 100644 index 0000000000..e5c33e75e7 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackervector2inertiamodifier.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaModifier +-api-type: winrt class +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaModifier + +## -description + +Base class for [InteractionTrackerVector2InertiaNaturalMotion](interactiontrackervector2inertianaturalmotion.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion.md b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion.md new file mode 100644 index 0000000000..f04a0c5740 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion +-api-type: winrt class +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion + +## -description + +A [Vector2NaturalMotionAnimation](../windows.ui.composition/vector2naturalmotionanimation.md) that defines motion of InteractionTracker during its inertia state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_condition.md b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_condition.md new file mode 100644 index 0000000000..0dcc00ca1d --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_condition.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion.Condition +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion.Condition + +## -description + +Gets or sets an [ExpressionAnimation](../windows.ui.composition/expressionanimation.md) describing when the modifier should be applied. + +## -property-value + +An [ExpressionAnimation](../windows.ui.composition/expressionanimation.md) describing when the modifier should be applied. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_create_996921895.md b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_create_996921895.md new file mode 100644 index 0000000000..3d7043f58f --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_create_996921895.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion.Create(Windows.UI.Composition.Compositor) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion.Create + +## -description + +Creates an instance of [InteractionTrackerVector2InertiaNaturalMotion](interactiontrackervector2inertianaturalmotion.md). + +## -parameters +### -param compositor + +The compositor to use when creating the InteractionTrackerInertiaNaturalMotion object. + +## -returns + +Returns the created InteractionTrackerInertiaNaturalMotion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_naturalmotion.md b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_naturalmotion.md new file mode 100644 index 0000000000..7d1d0e1aa3 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontrackervector2inertianaturalmotion_naturalmotion.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion.NaturalMotion +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.InteractionTrackerVector2InertiaNaturalMotion.NaturalMotion + +## -description + +Gets or set a [Vector2NaturalMotionAnimation](../windows.ui.composition/vector2naturalmotionanimation.md) that describes the modified motion for [InteractionTracker](interactiontracker.md) if the expression in the Condition property is **true**. + +## -property-value + +A Vector2NaturalMotionAnimation that describes the modified motion for [InteractionTracker](interactiontracker.md) if the expression in the Condition property is **true**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/ambientlight_intensity.md b/windows.ui.composition/ambientlight_intensity.md index 7124538095..7dc551624c 100644 --- a/windows.ui.composition/ambientlight_intensity.md +++ b/windows.ui.composition/ambientlight_intensity.md @@ -1,18 +1,22 @@ ---- --api-id: P:Windows.UI.Composition.AmbientLight.Intensity --api-type: winrt property ---- - +--- +-api-id: P:Windows.UI.Composition.AmbientLight.Intensity +-api-type: winrt property +--- + -# Windows.UI.Composition.AmbientLight.Intensity - +# Windows.UI.Composition.AmbientLight.Intensity + ## -description +Gets or sets the intensity of the light. + ## -property-value +The intensity of the light. + ## -remarks ## -see-also diff --git a/windows.ui.composition/compositionanimation_initialvalueexpressions.md b/windows.ui.composition/compositionanimation_initialvalueexpressions.md new file mode 100644 index 0000000000..71388c70b8 --- /dev/null +++ b/windows.ui.composition/compositionanimation_initialvalueexpressions.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionAnimation.InitialValueExpressions +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionAnimation.InitialValueExpressions + +## -description + +Gets the initial values for the animation. + +## -property-value + +The initial values for the animation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstop.md b/windows.ui.composition/compositioncolorgradientstop.md new file mode 100644 index 0000000000..35d7863711 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstop.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionColorGradientStop +-api-type: winrt class +--- + + + +# Windows.UI.Composition.CompositionColorGradientStop + +## -description + +Describes the location and color of a transition point in a gradient. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstop_color.md b/windows.ui.composition/compositioncolorgradientstop_color.md new file mode 100644 index 0000000000..b80379c9a9 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstop_color.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionColorGradientStop.Color +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionColorGradientStop.Color + +## -description + +Gets or sets the color of the gradient stop. + +## -property-value + +The color of the gradient stop. The default is Transparent. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstop_offset.md b/windows.ui.composition/compositioncolorgradientstop_offset.md new file mode 100644 index 0000000000..b1219b279e --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstop_offset.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionColorGradientStop.Offset +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionColorGradientStop.Offset + +## -description + +Gets or sets the location of the gradient stop within the gradient vector. + +## -property-value + +The relative location of this gradient stop along the gradient vector. The default is 0. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection.md b/windows.ui.composition/compositioncolorgradientstopcollection.md new file mode 100644 index 0000000000..23ac09d762 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionColorGradientStopCollection +-api-type: winrt class +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection + +## -description + +Represents a collection of [CompositionColorGradientStop](compositioncolorgradientstop.md) objects that can be individually accessed by index. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_append_1863213688.md b/windows.ui.composition/compositioncolorgradientstopcollection_append_1863213688.md new file mode 100644 index 0000000000..3c296b7dbc --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_append_1863213688.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.Append(Windows.UI.Composition.CompositionColorGradientStop) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.Append + +## -description + +Adds a new item to the collection. + +## -parameters +### -param value + +The item to add. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_clear_556466.md b/windows.ui.composition/compositioncolorgradientstopcollection_clear_556466.md new file mode 100644 index 0000000000..cb58271bc0 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_clear_556466.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.Clear +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.Clear + +## -description + +Removes all items from the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_first_1920739956.md b/windows.ui.composition/compositioncolorgradientstopcollection_first_1920739956.md new file mode 100644 index 0000000000..8cacc1be04 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_first_1920739956.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.First +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.First + +## -description + +Returns an iterator for the items in the collection. + +## -returns + +The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_getat_496709656.md b/windows.ui.composition/compositioncolorgradientstopcollection_getat_496709656.md new file mode 100644 index 0000000000..3007f669ad --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_getat_496709656.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.GetAt + +## -description + +Returns the item located at the specified index. + +## -parameters +### -param index + +The integer index for the value to retrieve. + +## -returns + +The CompositionColorGradientStop value at the specified index. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_getmany_817513506.md b/windows.ui.composition/compositioncolorgradientstopcollection_getmany_817513506.md new file mode 100644 index 0000000000..5308ca8dd3 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_getmany_817513506.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.GetMany(System.UInt32,Windows.UI.Composition.CompositionColorGradientStop[]) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.GetMany + +## -description + +Retrieves multiple elements in a single pass through the iterator. + +## -parameters +### -param startIndex + +The index from which to start retrieval. + +### -param items + +Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. + +## -returns + +The number of items retrieved. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_getview_37498667.md b/windows.ui.composition/compositioncolorgradientstopcollection_getview_37498667.md new file mode 100644 index 0000000000..2be0fcc41c --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_getview_37498667.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.GetView +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.GetView + +## -description + +Gets an immutable view into the collection. + +## -returns + +An object representing the immutable collection view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_indexof_666529096.md b/windows.ui.composition/compositioncolorgradientstopcollection_indexof_666529096.md new file mode 100644 index 0000000000..46964be47e --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_indexof_666529096.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.IndexOf(Windows.UI.Composition.CompositionColorGradientStop,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.IndexOf + +## -description + +Retrieves the index of the specified item. + +## -parameters +### -param value + +The value to find in the collection. + +### -param index + +The index of the item to find, if found. + +## -returns + +**true** if an item with the specified value was found; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_insertat_1256665262.md b/windows.ui.composition/compositioncolorgradientstopcollection_insertat_1256665262.md new file mode 100644 index 0000000000..3bab6a9c65 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_insertat_1256665262.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.InsertAt(System.UInt32,Windows.UI.Composition.CompositionColorGradientStop) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.InsertAt + +## -description + +Inserts the specified item at the specified index. + +## -parameters +### -param index + +The index at which to set the value. + +### -param value + +The value to set. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_removeat_1960564133.md b/windows.ui.composition/compositioncolorgradientstopcollection_removeat_1960564133.md new file mode 100644 index 0000000000..179382954b --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_removeat_1960564133.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.RemoveAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.RemoveAt + +## -description + +Removes the item at the specified index. + +## -parameters +### -param index + +The index position of the item to remove. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_removeatend_1813436897.md b/windows.ui.composition/compositioncolorgradientstopcollection_removeatend_1813436897.md new file mode 100644 index 0000000000..d3edba9b5a --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_removeatend_1813436897.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.RemoveAtEnd +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.RemoveAtEnd + +## -description + +Removes the last item in the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_replaceall_2146052979.md b/windows.ui.composition/compositioncolorgradientstopcollection_replaceall_2146052979.md new file mode 100644 index 0000000000..42f825be45 --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_replaceall_2146052979.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.ReplaceAll(Windows.UI.Composition.CompositionColorGradientStop[]) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.ReplaceAll + +## -description + +Initially clears the collection, then inserts the provided array as new items. + +## -parameters +### -param items + +The new collection items. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_setat_1001935070.md b/windows.ui.composition/compositioncolorgradientstopcollection_setat_1001935070.md new file mode 100644 index 0000000000..20f7713b9b --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_setat_1001935070.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionColorGradientStopCollection.SetAt(System.UInt32,Windows.UI.Composition.CompositionColorGradientStop) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.SetAt + +## -description + +Sets the value at the specified index to the [CompositionColorGradientStop](compositioncolorgradientstop.md) value specified. + +## -parameters +### -param index + +The index at which to set the value. + +### -param value + +The value to set. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorgradientstopcollection_size.md b/windows.ui.composition/compositioncolorgradientstopcollection_size.md new file mode 100644 index 0000000000..0f197d103d --- /dev/null +++ b/windows.ui.composition/compositioncolorgradientstopcollection_size.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionColorGradientStopCollection.Size +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionColorGradientStopCollection.Size + +## -description + +Gets the size (count) of the collection. + +## -property-value + +The count of items in the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncolorspace.md b/windows.ui.composition/compositioncolorspace.md index 33ca0e41fa..f1a0ee783b 100644 --- a/windows.ui.composition/compositioncolorspace.md +++ b/windows.ui.composition/compositioncolorspace.md @@ -23,8 +23,15 @@ Use the HSL color space for interpolation. Use the ARGB color space for interpolation. +### -field HslLinear:3 + + +### -field RgbLinear:4 + + ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also + diff --git a/windows.ui.composition/compositiondropshadowsourcepolicy.md b/windows.ui.composition/compositiondropshadowsourcepolicy.md index 0d839c18a1..9035e1f575 100644 --- a/windows.ui.composition/compositiondropshadowsourcepolicy.md +++ b/windows.ui.composition/compositiondropshadowsourcepolicy.md @@ -1,20 +1,23 @@ ---- --api-id: T:Windows.UI.Composition.CompositionDropShadowSourcePolicy --api-type: winrt enum ---- - +--- +-api-id: T:Windows.UI.Composition.CompositionDropShadowSourcePolicy +-api-type: winrt enum +--- + -# Windows.UI.Composition.CompositionDropShadowSourcePolicy - +# Windows.UI.Composition.CompositionDropShadowSourcePolicy + ## -description +Specifies the masking policy for a shadow. ## -enum-fields ### -field InheritFromVisualContent:1 +Shadow uses a mask using the alpha value of the visual's brush. ### -field Default:0 +Shadow defaults to rectangular shape or the mask provided. ## -remarks diff --git a/windows.ui.composition/compositiongradientbrush.md b/windows.ui.composition/compositiongradientbrush.md new file mode 100644 index 0000000000..ec792dd19c --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionGradientBrush +-api-type: winrt class +--- + + + +# Windows.UI.Composition.CompositionGradientBrush + +## -description + +Represents a brush that describes a gradient, composed of gradient stops. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_anchorpoint.md b/windows.ui.composition/compositiongradientbrush_anchorpoint.md new file mode 100644 index 0000000000..aaeee42c2a --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_anchorpoint.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.AnchorPoint +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.AnchorPoint + +## -description + +Gets or sets the point on the brush to be positioned at the brush's offset. + +## -property-value + +The point on the brush to be positioned at the brush's offset. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_centerpoint.md b/windows.ui.composition/compositiongradientbrush_centerpoint.md new file mode 100644 index 0000000000..102baada27 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_centerpoint.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.CenterPoint +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.CenterPoint + +## -description + +Gets or sets the point about which the brush is rotated and scaled. + +## -property-value + +The point about which the brush is rotated and scaled. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_colorstops.md b/windows.ui.composition/compositiongradientbrush_colorstops.md new file mode 100644 index 0000000000..3db5fb5015 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_colorstops.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.ColorStops +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.ColorStops + +## -description + +Gets the brush's gradient stops. + +## -property-value + +A collection of the [CompositionColorGradientStop](compositioncolorgradientstop.md) objects associated with the brush, each of which specifies a color and an offset along the brush's gradient axis. The default is an empty [CompositionColorGradientStopCollection](compositioncolorgradientstopcollection.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_extendmode.md b/windows.ui.composition/compositiongradientbrush_extendmode.md new file mode 100644 index 0000000000..0027e95244 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_extendmode.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.ExtendMode +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.ExtendMode + +## -description + +Gets or sets a value that specifies how to draw the gradient outside the brush's gradient vector or space. + +## -property-value + +The mode used to paint the gradient. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_interpolationspace.md b/windows.ui.composition/compositiongradientbrush_interpolationspace.md new file mode 100644 index 0000000000..31eea459a9 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_interpolationspace.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.InterpolationSpace +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.InterpolationSpace + +## -description + +Gets or sets a value that specifies how the gradient's colors are interpolated. + +## -property-value + +A value of the enumeration that specifies how the gradient's colors are interpolated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_offset.md b/windows.ui.composition/compositiongradientbrush_offset.md new file mode 100644 index 0000000000..e6909e1724 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_offset.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.Offset +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.Offset + +## -description + +Gets or sets the offset of the brush relative to the object being painted. + +## -property-value + +The offset of the brush relative to the object being painted. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_rotationangle.md b/windows.ui.composition/compositiongradientbrush_rotationangle.md new file mode 100644 index 0000000000..233dad8e98 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_rotationangle.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.RotationAngle +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.RotationAngle + +## -description + +Gets or sets the rotation angle of the brush in radians. + +## -property-value + +The rotation angle of the brush in radians. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_rotationangleindegrees.md b/windows.ui.composition/compositiongradientbrush_rotationangleindegrees.md new file mode 100644 index 0000000000..84a483da60 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_rotationangleindegrees.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.RotationAngleInDegrees +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.RotationAngleInDegrees + +## -description + +Gets or sets the rotation angle of the brush in degrees. + +## -property-value + +The rotation angle of the brush in degrees. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_scale.md b/windows.ui.composition/compositiongradientbrush_scale.md new file mode 100644 index 0000000000..4ef4852bff --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_scale.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.Scale +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.Scale + +## -description + +Gets or sets the scale to apply to the brush. + +## -property-value + +The scale to apply to the brush. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientbrush_transformmatrix.md b/windows.ui.composition/compositiongradientbrush_transformmatrix.md new file mode 100644 index 0000000000..43301ffb66 --- /dev/null +++ b/windows.ui.composition/compositiongradientbrush_transformmatrix.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionGradientBrush.TransformMatrix +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionGradientBrush.TransformMatrix + +## -description + +Gets or sets the matrix of transforms to apply to the brush. + +## -property-value + +The matrix of transforms to apply to the brush. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongradientextendmode.md b/windows.ui.composition/compositiongradientextendmode.md new file mode 100644 index 0000000000..28a5fceda4 --- /dev/null +++ b/windows.ui.composition/compositiongradientextendmode.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionGradientExtendMode +-api-type: winrt enum +--- + + + +# Windows.UI.Composition.CompositionGradientExtendMode + +## -description + +Defines constants that specify how to draw the gradient outside the brush's gradient vector or space. + +## -enum-fields +### -field Wrap:1 + +The gradient is wrapped. + +### -field Mirror:2 + +The gradient is repeated in the reverse direction.. + +### -field Clamp:0 + +The gradient is not extended. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionlight_exclusionsfromtargets.md b/windows.ui.composition/compositionlight_exclusionsfromtargets.md new file mode 100644 index 0000000000..3504aece9a --- /dev/null +++ b/windows.ui.composition/compositionlight_exclusionsfromtargets.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionLight.ExclusionsFromTargets +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionLight.ExclusionsFromTargets + +## -description + +Gets a collection of Visuals that are not targeted by the light. + +## -property-value + +The collection of Visuals that are not targeted by the light. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionlineargradientbrush.md b/windows.ui.composition/compositionlineargradientbrush.md new file mode 100644 index 0000000000..353976d0ba --- /dev/null +++ b/windows.ui.composition/compositionlineargradientbrush.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionLinearGradientBrush +-api-type: winrt class +--- + + + +# Windows.UI.Composition.CompositionLinearGradientBrush + +## -description + +Represents a brush that paints an area with a linear gradient. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionlineargradientbrush_endpoint.md b/windows.ui.composition/compositionlineargradientbrush_endpoint.md new file mode 100644 index 0000000000..ac8fc34bb3 --- /dev/null +++ b/windows.ui.composition/compositionlineargradientbrush_endpoint.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionLinearGradientBrush.EndPoint +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionLinearGradientBrush.EndPoint + +## -description + +Gets or sets the ending two-dimensional coordinates of the linear gradient. + +## -property-value + +The ending two-dimensional coordinates of the linear gradient. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionlineargradientbrush_startpoint.md b/windows.ui.composition/compositionlineargradientbrush_startpoint.md new file mode 100644 index 0000000000..90a02a9a70 --- /dev/null +++ b/windows.ui.composition/compositionlineargradientbrush_startpoint.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionLinearGradientBrush.StartPoint +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionLinearGradientBrush.StartPoint + +## -description + +Gets or sets the starting two-dimensional coordinates of the linear gradient. + +## -property-value + +The starting two-dimensional coordinates for the linear gradient. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionobject_dispatcherqueue.md b/windows.ui.composition/compositionobject_dispatcherqueue.md new file mode 100644 index 0000000000..ab156595f5 --- /dev/null +++ b/windows.ui.composition/compositionobject_dispatcherqueue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionObject.DispatcherQueue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionObject.DispatcherQueue + +## -description + +Gets the [DispatcherQueue](../windows.system/dispatcherqueue.md) for the CompostionObject. + +## -property-value + +The [DispatcherQueue](../windows.system/dispatcherqueue.md) for the CompostionObject. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createcolorgradientstop_1232190734.md b/windows.ui.composition/compositor_createcolorgradientstop_1232190734.md new file mode 100644 index 0000000000..2843a7c4fb --- /dev/null +++ b/windows.ui.composition/compositor_createcolorgradientstop_1232190734.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateColorGradientStop(System.Single,Windows.UI.Color) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateColorGradientStop + +## -description + +Creates an instance of [CompositionColorGradientStop](compositioncolorgradientstop.md) with the specified offset and color. + +## -parameters +### -param offset + +The location of the gradient stop within the gradient vector. + +### -param color + +The color of the gradient stop. + +## -returns + +The created CompositionColorGradientStop object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createcolorgradientstop_492882295.md b/windows.ui.composition/compositor_createcolorgradientstop_492882295.md new file mode 100644 index 0000000000..7c7d1d1f85 --- /dev/null +++ b/windows.ui.composition/compositor_createcolorgradientstop_492882295.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateColorGradientStop +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateColorGradientStop + +## -description + +Creates an instance of [CompositionColorGradientStop](compositioncolorgradientstop.md). + +## -returns + +The created CompositionColorGradientStop object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createlineargradientbrush_883922324.md b/windows.ui.composition/compositor_createlineargradientbrush_883922324.md new file mode 100644 index 0000000000..858dbd2dc7 --- /dev/null +++ b/windows.ui.composition/compositor_createlineargradientbrush_883922324.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateLinearGradientBrush +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateLinearGradientBrush + +## -description + +Creates an instance of [CompositionLinearGradientBrush](compositionlineargradientbrush.md). + +## -returns + +The created CompositionLinearGradientBrush object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createspringscalaranimation_382525509.md b/windows.ui.composition/compositor_createspringscalaranimation_382525509.md new file mode 100644 index 0000000000..d89f96c295 --- /dev/null +++ b/windows.ui.composition/compositor_createspringscalaranimation_382525509.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateSpringScalarAnimation +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateSpringScalarAnimation + +## -description + +Creates an instance of [SpringScalarNaturalMotionAnimation](springscalarnaturalmotionanimation.md). + +## -returns + +The created SpringScalarNaturalMotionAnimation object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createspringvector2animation_2110573320.md b/windows.ui.composition/compositor_createspringvector2animation_2110573320.md new file mode 100644 index 0000000000..6b5aeb1ec5 --- /dev/null +++ b/windows.ui.composition/compositor_createspringvector2animation_2110573320.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateSpringVector2Animation +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateSpringVector2Animation + +## -description + +Creates an instance of [SpringVector2NaturalMotionAnimation](springvector2naturalmotionanimation.md). + +## -returns + +The created SpringVector2NaturalMotionAnimation object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createspringvector3animation_1142037425.md b/windows.ui.composition/compositor_createspringvector3animation_1142037425.md new file mode 100644 index 0000000000..2c743a37b3 --- /dev/null +++ b/windows.ui.composition/compositor_createspringvector3animation_1142037425.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateSpringVector3Animation +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateSpringVector3Animation + +## -description + +Creates an instance of [SpringVector3NaturalMotionAnimation](springvector3naturalmotionanimation.md). + +## -returns + +The created SpringVector3NaturalMotionAnimation object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/distantlight_intensity.md b/windows.ui.composition/distantlight_intensity.md index d280fa3cdd..b68dc01a99 100644 --- a/windows.ui.composition/distantlight_intensity.md +++ b/windows.ui.composition/distantlight_intensity.md @@ -1,18 +1,22 @@ ---- --api-id: P:Windows.UI.Composition.DistantLight.Intensity --api-type: winrt property ---- - +--- +-api-id: P:Windows.UI.Composition.DistantLight.Intensity +-api-type: winrt property +--- + -# Windows.UI.Composition.DistantLight.Intensity - +# Windows.UI.Composition.DistantLight.Intensity + ## -description +Gets or sets the intensity of the light. + ## -property-value +The intensity of the light. + ## -remarks ## -see-also diff --git a/windows.ui.composition/dropshadow_sourcepolicy.md b/windows.ui.composition/dropshadow_sourcepolicy.md index 7e0a1bf361..ebfa1c8c15 100644 --- a/windows.ui.composition/dropshadow_sourcepolicy.md +++ b/windows.ui.composition/dropshadow_sourcepolicy.md @@ -1,17 +1,19 @@ ---- --api-id: P:Windows.UI.Composition.DropShadow.SourcePolicy --api-type: winrt property ---- - +--- +-api-id: P:Windows.UI.Composition.DropShadow.SourcePolicy +-api-type: winrt property +--- + -# Windows.UI.Composition.DropShadow.SourcePolicy - +# Windows.UI.Composition.DropShadow.SourcePolicy + ## -description +Used to define the shadow masking policy to be used for the shadow. ## -property-value +The masking policy to apply to the shadow. ## -remarks diff --git a/windows.ui.composition/initialvalueexpressioncollection.md b/windows.ui.composition/initialvalueexpressioncollection.md new file mode 100644 index 0000000000..dc08d3c30f --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.InitialValueExpressionCollection +-api-type: winrt class +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection + +## -description + +A collection of values that specify where an animation will start. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_clear_556466.md b/windows.ui.composition/initialvalueexpressioncollection_clear_556466.md new file mode 100644 index 0000000000..8a5cc2098a --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_clear_556466.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.Clear +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.Clear + +## -description + +Removes all items from the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_first_1920739956.md b/windows.ui.composition/initialvalueexpressioncollection_first_1920739956.md new file mode 100644 index 0000000000..748313129f --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_first_1920739956.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.First +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.First + +## -description + +Retrieves the first item in the collection. + +## -returns + +The first item in the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_getview_37498667.md b/windows.ui.composition/initialvalueexpressioncollection_getview_37498667.md new file mode 100644 index 0000000000..3f11bcc6b4 --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_getview_37498667.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.GetView +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.GetView + +## -description + +Gets an immutable view into the collection. + +## -returns + +An object representing the immutable collection view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_haskey_425964900.md b/windows.ui.composition/initialvalueexpressioncollection_haskey_425964900.md new file mode 100644 index 0000000000..7ee5e1abfd --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_haskey_425964900.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.HasKey(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.HasKey + +## -description + +Returns a value that indicates whether the collection contains the specified key. + +## -parameters + +### -param key + +The key to check for. + +## -returns + +**true** if the key is in the collection; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_insert_2006825190.md b/windows.ui.composition/initialvalueexpressioncollection_insert_2006825190.md new file mode 100644 index 0000000000..73cd734996 --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_insert_2006825190.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.Insert(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.Insert + +## -description + +Inserts an item into the collection. + +## -parameters + +### -param key + +The key to identify the item to insert. + +### -param value + +The item to insert. + +## -returns + +**true** if animation was successfully inserted; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_lookup_711408188.md b/windows.ui.composition/initialvalueexpressioncollection_lookup_711408188.md new file mode 100644 index 0000000000..f7d338a11f --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_lookup_711408188.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.Lookup(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.Lookup + +## -description + +Retrieves the item associated with the specified key. + +## -parameters + +### -param key + +The key that identifies the item to retrieve. + +## -returns + +The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_remove_1498489487.md b/windows.ui.composition/initialvalueexpressioncollection_remove_1498489487.md new file mode 100644 index 0000000000..afe448e036 --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_remove_1498489487.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Composition.InitialValueExpressionCollection.Remove(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.Remove + +## -description + +Removes the specified item from the collection. + +## -parameters + +### -param key + +The key that identifies the item to remove. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/initialvalueexpressioncollection_size.md b/windows.ui.composition/initialvalueexpressioncollection_size.md new file mode 100644 index 0000000000..64bc057332 --- /dev/null +++ b/windows.ui.composition/initialvalueexpressioncollection_size.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.InitialValueExpressionCollection.Size +-api-type: winrt property +--- + + + +# Windows.UI.Composition.InitialValueExpressionCollection.Size + +## -description + +Gets the size (count) of the collection. + +## -property-value + +The count of items in the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/layervisual_shadow.md b/windows.ui.composition/layervisual_shadow.md new file mode 100644 index 0000000000..e5591af876 --- /dev/null +++ b/windows.ui.composition/layervisual_shadow.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Composition.LayerVisual.Shadow +-api-type: winrt property +--- + + + +# Windows.UI.Composition.LayerVisual.Shadow + +## -description +The shadow to be applied to the flattened representation of the children of a [LayerVisual](layervisual.md). + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/naturalmotionanimation.md b/windows.ui.composition/naturalmotionanimation.md new file mode 100644 index 0000000000..9e08d14b72 --- /dev/null +++ b/windows.ui.composition/naturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.NaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.NaturalMotionAnimation + +## -description + +Represents a physics-based animation that uses forces to dynamically move content. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/naturalmotionanimation_delaybehavior.md b/windows.ui.composition/naturalmotionanimation_delaybehavior.md new file mode 100644 index 0000000000..78ab56fcc7 --- /dev/null +++ b/windows.ui.composition/naturalmotionanimation_delaybehavior.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.NaturalMotionAnimation.DelayBehavior +-api-type: winrt property +--- + + + +# Windows.UI.Composition.NaturalMotionAnimation.DelayBehavior + +## -description + +The delay behavior of the NaturalMotionAnimation. + +## -property-value + +The delay behavior of the NaturalMotionAnimation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/naturalmotionanimation_delaytime.md b/windows.ui.composition/naturalmotionanimation_delaytime.md new file mode 100644 index 0000000000..548a0b462f --- /dev/null +++ b/windows.ui.composition/naturalmotionanimation_delaytime.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.NaturalMotionAnimation.DelayTime +-api-type: winrt property +--- + + + +# Windows.UI.Composition.NaturalMotionAnimation.DelayTime + +## -description + +Delay before the animation starts after [CompositionObject.StartAnimation](compositionobject_startanimation.md) is called. + +## -property-value + +Delay before the animation starts after [CompositionObject.StartAnimation](compositionobject_startanimation.md) is called. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/naturalmotionanimation_stopbehavior.md b/windows.ui.composition/naturalmotionanimation_stopbehavior.md new file mode 100644 index 0000000000..77006074c0 --- /dev/null +++ b/windows.ui.composition/naturalmotionanimation_stopbehavior.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.NaturalMotionAnimation.StopBehavior +-api-type: winrt property +--- + + + +# Windows.UI.Composition.NaturalMotionAnimation.StopBehavior + +## -description + +Specifies how to set the property value when [StopAnimation](compositionobject_stopanimation.md) is called. + +## -property-value + +Specifies how to set the property value when [StopAnimation](compositionobject_stopanimation.md) is called. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/pointlight_intensity.md b/windows.ui.composition/pointlight_intensity.md index 7faa3951c0..d968b1537e 100644 --- a/windows.ui.composition/pointlight_intensity.md +++ b/windows.ui.composition/pointlight_intensity.md @@ -1,18 +1,22 @@ ---- --api-id: P:Windows.UI.Composition.PointLight.Intensity --api-type: winrt property ---- - +--- +-api-id: P:Windows.UI.Composition.PointLight.Intensity +-api-type: winrt property +--- + -# Windows.UI.Composition.PointLight.Intensity - +# Windows.UI.Composition.PointLight.Intensity + ## -description +Gets or sets the intensity of the light. + ## -property-value +The intensity of the light. + ## -remarks ## -see-also diff --git a/windows.ui.composition/scalarnaturalmotionanimation.md b/windows.ui.composition/scalarnaturalmotionanimation.md new file mode 100644 index 0000000000..a20dcfca1d --- /dev/null +++ b/windows.ui.composition/scalarnaturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.ScalarNaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.ScalarNaturalMotionAnimation + +## -description + +The base Scalar NaturalMotionAnimation used to target a Scalar property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/scalarnaturalmotionanimation_finalvalue.md b/windows.ui.composition/scalarnaturalmotionanimation_finalvalue.md new file mode 100644 index 0000000000..1dda68eedb --- /dev/null +++ b/windows.ui.composition/scalarnaturalmotionanimation_finalvalue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.ScalarNaturalMotionAnimation.FinalValue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.ScalarNaturalMotionAnimation.FinalValue + +## -description + +Gets or sets a value that indicates where the animation ends. + +## -property-value + +A value that indicates where the animation ends. The default is **null**. If left **null**, the ending value of the property being animated is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/scalarnaturalmotionanimation_initialvalue.md b/windows.ui.composition/scalarnaturalmotionanimation_initialvalue.md new file mode 100644 index 0000000000..d71c5089b9 --- /dev/null +++ b/windows.ui.composition/scalarnaturalmotionanimation_initialvalue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.ScalarNaturalMotionAnimation.InitialValue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.ScalarNaturalMotionAnimation.InitialValue + +## -description + +Gets or sets a value that indicates where the animation starts. + +## -property-value + +A value that indicates where the animation starts. The default is **null**. If left **null**, the beginning value of the property being animated is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/scalarnaturalmotionanimation_initialvelocity.md b/windows.ui.composition/scalarnaturalmotionanimation_initialvelocity.md new file mode 100644 index 0000000000..2760204a69 --- /dev/null +++ b/windows.ui.composition/scalarnaturalmotionanimation_initialvelocity.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.ScalarNaturalMotionAnimation.InitialVelocity +-api-type: winrt property +--- + + + +# Windows.UI.Composition.ScalarNaturalMotionAnimation.InitialVelocity + +## -description + +Gets or sets the velocity that the animation starts with. + +## -property-value + +The velocity that the animation starts with. The default is 0. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/spotlight_innerconeintensity.md b/windows.ui.composition/spotlight_innerconeintensity.md index 1a51f84582..78d9fef184 100644 --- a/windows.ui.composition/spotlight_innerconeintensity.md +++ b/windows.ui.composition/spotlight_innerconeintensity.md @@ -1,18 +1,22 @@ ---- --api-id: P:Windows.UI.Composition.SpotLight.InnerConeIntensity --api-type: winrt property ---- - +--- +-api-id: P:Windows.UI.Composition.SpotLight.InnerConeIntensity +-api-type: winrt property +--- + -# Windows.UI.Composition.SpotLight.InnerConeIntensity - +# Windows.UI.Composition.SpotLight.InnerConeIntensity + ## -description +Gets or sets the intensity of the light in the spotlight's inner cone. + ## -property-value +The intensity of the light. + ## -remarks ## -see-also diff --git a/windows.ui.composition/spotlight_outerconeintensity.md b/windows.ui.composition/spotlight_outerconeintensity.md index d6fc1c660f..c485eec1c8 100644 --- a/windows.ui.composition/spotlight_outerconeintensity.md +++ b/windows.ui.composition/spotlight_outerconeintensity.md @@ -1,18 +1,22 @@ ---- --api-id: P:Windows.UI.Composition.SpotLight.OuterConeIntensity --api-type: winrt property ---- - +--- +-api-id: P:Windows.UI.Composition.SpotLight.OuterConeIntensity +-api-type: winrt property +--- + -# Windows.UI.Composition.SpotLight.OuterConeIntensity - +# Windows.UI.Composition.SpotLight.OuterConeIntensity + ## -description +Gets or sets the intensity of the light in the spotlight's outer cone. + ## -property-value +The intensity of the light. + ## -remarks ## -see-also diff --git a/windows.ui.composition/springscalarnaturalmotionanimation.md b/windows.ui.composition/springscalarnaturalmotionanimation.md new file mode 100644 index 0000000000..a909a1e51f --- /dev/null +++ b/windows.ui.composition/springscalarnaturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.SpringScalarNaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.SpringScalarNaturalMotionAnimation + +## -description + +A spring physics-based animation that targets any Scalar-based property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springscalarnaturalmotionanimation_dampingratio.md b/windows.ui.composition/springscalarnaturalmotionanimation_dampingratio.md new file mode 100644 index 0000000000..a24e329137 --- /dev/null +++ b/windows.ui.composition/springscalarnaturalmotionanimation_dampingratio.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.SpringScalarNaturalMotionAnimation.DampingRatio +-api-type: winrt property +--- + + + +# Windows.UI.Composition.SpringScalarNaturalMotionAnimation.DampingRatio + +## -description + +Gets or sets a value that indicates how much damping is applied to the spring. + +## -property-value + +A value that indicates how much damping is applied to the spring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springscalarnaturalmotionanimation_period.md b/windows.ui.composition/springscalarnaturalmotionanimation_period.md new file mode 100644 index 0000000000..67f5cb3e16 --- /dev/null +++ b/windows.ui.composition/springscalarnaturalmotionanimation_period.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.SpringScalarNaturalMotionAnimation.Period +-api-type: winrt property +--- + + + +# Windows.UI.Composition.SpringScalarNaturalMotionAnimation.Period + +## -description + +Gets or sets the time for the Spring to complete a single oscillation. + +## -property-value + +The time for the Spring to complete a single oscillation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springvector2naturalmotionanimation.md b/windows.ui.composition/springvector2naturalmotionanimation.md new file mode 100644 index 0000000000..e8cc0ec46e --- /dev/null +++ b/windows.ui.composition/springvector2naturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.SpringVector2NaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.SpringVector2NaturalMotionAnimation + +## -description + +A spring physics-based animation that targets any Vector2-based property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springvector2naturalmotionanimation_dampingratio.md b/windows.ui.composition/springvector2naturalmotionanimation_dampingratio.md new file mode 100644 index 0000000000..fba0abeb00 --- /dev/null +++ b/windows.ui.composition/springvector2naturalmotionanimation_dampingratio.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.SpringVector2NaturalMotionAnimation.DampingRatio +-api-type: winrt property +--- + + + +# Windows.UI.Composition.SpringVector2NaturalMotionAnimation.DampingRatio + +## -description + +Gets or sets a value that indicates how much damping is applied to the spring. + +## -property-value + +A value that indicates how much damping is applied to the spring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springvector2naturalmotionanimation_period.md b/windows.ui.composition/springvector2naturalmotionanimation_period.md new file mode 100644 index 0000000000..fae55a581f --- /dev/null +++ b/windows.ui.composition/springvector2naturalmotionanimation_period.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.SpringVector2NaturalMotionAnimation.Period +-api-type: winrt property +--- + + + +# Windows.UI.Composition.SpringVector2NaturalMotionAnimation.Period + +## -description + +Gets or sets the time for the Spring to complete a single oscillation. + +## -property-value + +The time for the Spring to complete a single oscillation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springvector3naturalmotionanimation.md b/windows.ui.composition/springvector3naturalmotionanimation.md new file mode 100644 index 0000000000..2d54122a99 --- /dev/null +++ b/windows.ui.composition/springvector3naturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.SpringVector3NaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.SpringVector3NaturalMotionAnimation + +## -description + +A spring physics-based animation that targets any Vector3-based property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springvector3naturalmotionanimation_dampingratio.md b/windows.ui.composition/springvector3naturalmotionanimation_dampingratio.md new file mode 100644 index 0000000000..85b6bec752 --- /dev/null +++ b/windows.ui.composition/springvector3naturalmotionanimation_dampingratio.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.SpringVector3NaturalMotionAnimation.DampingRatio +-api-type: winrt property +--- + + + +# Windows.UI.Composition.SpringVector3NaturalMotionAnimation.DampingRatio + +## -description + +Gets or sets a value that indicates how much damping is applied to the spring. + +## -property-value + +A value that indicates how much damping is applied to the spring. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/springvector3naturalmotionanimation_period.md b/windows.ui.composition/springvector3naturalmotionanimation_period.md new file mode 100644 index 0000000000..60ca1e2343 --- /dev/null +++ b/windows.ui.composition/springvector3naturalmotionanimation_period.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.SpringVector3NaturalMotionAnimation.Period +-api-type: winrt property +--- + + + +# Windows.UI.Composition.SpringVector3NaturalMotionAnimation.Period + +## -description + +Gets or sets the time for the Spring to complete a single oscillation. + +## -property-value + +The time for the Spring to complete a single oscillation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector2naturalmotionanimation.md b/windows.ui.composition/vector2naturalmotionanimation.md new file mode 100644 index 0000000000..0b509a623a --- /dev/null +++ b/windows.ui.composition/vector2naturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.Vector2NaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.Vector2NaturalMotionAnimation + +## -description + +The base Vector2 NaturalMotionAnimation used to target a Vector2 property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector2naturalmotionanimation_finalvalue.md b/windows.ui.composition/vector2naturalmotionanimation_finalvalue.md new file mode 100644 index 0000000000..be03e5a330 --- /dev/null +++ b/windows.ui.composition/vector2naturalmotionanimation_finalvalue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Vector2NaturalMotionAnimation.FinalValue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Vector2NaturalMotionAnimation.FinalValue + +## -description + +Gets or sets a value that indicates where the animation ends. + +## -property-value + +A value that indicates where the animation ends. The default is **null**. If left **null**, the ending value of the property being animated is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector2naturalmotionanimation_initialvalue.md b/windows.ui.composition/vector2naturalmotionanimation_initialvalue.md new file mode 100644 index 0000000000..e1f0a1843d --- /dev/null +++ b/windows.ui.composition/vector2naturalmotionanimation_initialvalue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Vector2NaturalMotionAnimation.InitialValue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Vector2NaturalMotionAnimation.InitialValue + +## -description + +Gets or sets a value that indicates where the animation starts. + +## -property-value + +A value that indicates where the animation starts. The default is **null**. If left **null**, the beginning value of the property being animated is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector2naturalmotionanimation_initialvelocity.md b/windows.ui.composition/vector2naturalmotionanimation_initialvelocity.md new file mode 100644 index 0000000000..189b768217 --- /dev/null +++ b/windows.ui.composition/vector2naturalmotionanimation_initialvelocity.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Vector2NaturalMotionAnimation.InitialVelocity +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Vector2NaturalMotionAnimation.InitialVelocity + +## -description + +Gets or sets the velocity that the animation starts with. + +## -property-value + +The velocity that the animation starts with. The default is 0. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector3naturalmotionanimation.md b/windows.ui.composition/vector3naturalmotionanimation.md new file mode 100644 index 0000000000..cecec19490 --- /dev/null +++ b/windows.ui.composition/vector3naturalmotionanimation.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.Vector3NaturalMotionAnimation +-api-type: winrt class +--- + + + +# Windows.UI.Composition.Vector3NaturalMotionAnimation + +## -description + +The base Vector3 NaturalMotionAnimation used to target a Vector3 property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector3naturalmotionanimation_finalvalue.md b/windows.ui.composition/vector3naturalmotionanimation_finalvalue.md new file mode 100644 index 0000000000..2437cc4ba4 --- /dev/null +++ b/windows.ui.composition/vector3naturalmotionanimation_finalvalue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Vector3NaturalMotionAnimation.FinalValue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Vector3NaturalMotionAnimation.FinalValue + +## -description + +Gets or sets a value that indicates where the animation ends. + +## -property-value + +A value that indicates where the animation ends. The default is **null**. If left **null**, the ending value of the property being animated is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector3naturalmotionanimation_initialvalue.md b/windows.ui.composition/vector3naturalmotionanimation_initialvalue.md new file mode 100644 index 0000000000..282417e867 --- /dev/null +++ b/windows.ui.composition/vector3naturalmotionanimation_initialvalue.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Vector3NaturalMotionAnimation.InitialValue +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Vector3NaturalMotionAnimation.InitialValue + +## -description + +Gets or sets a value that indicates where the animation starts. + +## -property-value + +A value that indicates where the animation starts. The default is **null**. If left **null**, the beginning value of the property being animated is used. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/vector3naturalmotionanimation_initialvelocity.md b/windows.ui.composition/vector3naturalmotionanimation_initialvelocity.md new file mode 100644 index 0000000000..1b1c482565 --- /dev/null +++ b/windows.ui.composition/vector3naturalmotionanimation_initialvelocity.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Vector3NaturalMotionAnimation.InitialVelocity +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Vector3NaturalMotionAnimation.InitialVelocity + +## -description + +Gets or sets the velocity that the animation starts with. + +## -property-value + +The velocity that the animation starts with. The default is 0. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/visual.md b/windows.ui.composition/visual.md index 3a2712fb1e..84e2e52d3e 100644 --- a/windows.ui.composition/visual.md +++ b/windows.ui.composition/visual.md @@ -10,7 +10,7 @@ public class Visual : Windows.UI.Composition.CompositionObject, Windows.UI.Compo # Windows.UI.Composition.Visual ## -description -The base object in visual tree. +The base visual object in the visual hierarchy. ## -remarks Visual objects compose and render serialized drawing content and form the basis of a retained mode visual system. The Visual class supports basic position and clipping and can have 2D and 3D transformations applied to them. Addition functionality like solid colors, images, and content with effects is provided through subclasses like [SpriteVisual](spritevisual.md), and by setting the [Brush](spritevisual_brush.md) property of the visual to CompositionBrush subclasses such as [CompositionColorBrush](compositioncolorbrush.md), [CompositionEffectBrush](compositioneffectbrush.md), and [CompositionSurfaceBrush](compositionsurfacebrush.md). diff --git a/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs.md b/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs.md new file mode 100644 index 0000000000..4a5c9862ee --- /dev/null +++ b/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Core.Preview.SystemNavigationCloseRequestedPreviewEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Core.Preview.SystemNavigationCloseRequestedPreviewEventArgs + +## -description + +Provides event data for the [SystemNavigationManagerPreview.CloseRequested](systemnavigationmanagerpreview_closerequested.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs_getdeferral_254836512.md b/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..346e586225 --- /dev/null +++ b/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs_getdeferral_254836512.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Core.Preview.SystemNavigationCloseRequestedPreviewEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.UI.Core.Preview.SystemNavigationCloseRequestedPreviewEventArgs.GetDeferral + +## -description + +Returns a [Deferral](../windows.foundation/deferral.md) object for the [CloseRequested](systemnavigationmanagerpreview_closerequested.md) event. + +## -returns + +A [Deferral](../windows.foundation/deferral.md) object for the [CloseRequested](systemnavigationmanagerpreview_closerequested.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs_handled.md b/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs_handled.md new file mode 100644 index 0000000000..aa6d617dbe --- /dev/null +++ b/windows.ui.core.preview/systemnavigationcloserequestedprevieweventargs_handled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Core.Preview.SystemNavigationCloseRequestedPreviewEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.UI.Core.Preview.SystemNavigationCloseRequestedPreviewEventArgs.Handled + +## -description + +Gets or sets a value that indicates whether the close request is handled by the app. + +## -property-value + +**true** if the app has handled the close request; otherwise, **false**. The default is **false**. + +## -remarks + +You can handle the close request to have your app perform another action, such as letting the user save data before closing. + +## -see-also + +## -examples + diff --git a/windows.ui.core.preview/systemnavigationmanagerpreview.md b/windows.ui.core.preview/systemnavigationmanagerpreview.md new file mode 100644 index 0000000000..f67e058d53 --- /dev/null +++ b/windows.ui.core.preview/systemnavigationmanagerpreview.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Core.Preview.SystemNavigationManagerPreview +-api-type: winrt class +--- + + + +# Windows.UI.Core.Preview.SystemNavigationManagerPreview + +## -description + +Provides a way for an app to respond to system provided close events. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core.preview/systemnavigationmanagerpreview_closerequested.md b/windows.ui.core.preview/systemnavigationmanagerpreview_closerequested.md new file mode 100644 index 0000000000..b4bbb5f4ad --- /dev/null +++ b/windows.ui.core.preview/systemnavigationmanagerpreview_closerequested.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.Core.Preview.SystemNavigationManagerPreview.CloseRequested +-api-type: winrt event +--- + + + +# Windows.UI.Core.Preview.SystemNavigationManagerPreview.CloseRequested + +## -description + +Occurs when the user invokes the system button for close (the 'x' button in the corner of the app's title bar). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core.preview/systemnavigationmanagerpreview_getforcurrentview_1363600702.md b/windows.ui.core.preview/systemnavigationmanagerpreview_getforcurrentview_1363600702.md new file mode 100644 index 0000000000..919bea4286 --- /dev/null +++ b/windows.ui.core.preview/systemnavigationmanagerpreview_getforcurrentview_1363600702.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Core.Preview.SystemNavigationManagerPreview.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.UI.Core.Preview.SystemNavigationManagerPreview.GetForCurrentView + +## -description + +Returns the SystemNavigationManagerPreview object associated with the current window. + +## -returns + +The SystemNavigationManagerPreview object associated with the current window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core.preview/windows_ui_core_preview.md b/windows.ui.core.preview/windows_ui_core_preview.md new file mode 100644 index 0000000000..1a24109537 --- /dev/null +++ b/windows.ui.core.preview/windows_ui_core_preview.md @@ -0,0 +1,21 @@ +--- +-api-id: N:Windows.UI.Core.Preview +-api-type: winrt namespace +--- + + + +# Windows.UI.Core.Preview + +## -description + +Provides preview APIs for various basic user interface window components. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/corecursortype.md b/windows.ui.core/corecursortype.md index c44fb2ab53..5c6890d47b 100644 --- a/windows.ui.core/corecursortype.md +++ b/windows.ui.core/corecursortype.md @@ -26,7 +26,7 @@ A custom cursor. The "hand" Windows cursor. ### -field Help:4 -The " +The left-upward (northwest) arrow Windows cursor with a question mark. ### -field IBeam:5 The "I"-shaped Windows cursor used for text selection. @@ -55,9 +55,18 @@ The up arrow Windows cursor. ### -field Wait:13 The cycling Windows "wait" cursor often used to indicate that an element or behavior is in a wait state and cannot respond at the time. +### -field Person:15 + +The "hand" Windows cursor with a person symbol. + +### -field Pin:14 + +The "hand" Windows cursor with a pin symbol. + ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also + diff --git a/windows.ui.core/corewindow_activationmode.md b/windows.ui.core/corewindow_activationmode.md new file mode 100644 index 0000000000..7440ad4457 --- /dev/null +++ b/windows.ui.core/corewindow_activationmode.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Core.CoreWindow.ActivationMode +-api-type: winrt property +--- + + + +# Windows.UI.Core.CoreWindow.ActivationMode + +## -description + +Gets a value that indicates the activation state of the window. + +## -property-value + +A value that indicates the activation state of the window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/corewindow_dispatcherqueue.md b/windows.ui.core/corewindow_dispatcherqueue.md index 942f7e23b2..fc45533d94 100644 --- a/windows.ui.core/corewindow_dispatcherqueue.md +++ b/windows.ui.core/corewindow_dispatcherqueue.md @@ -11,15 +11,14 @@ public DispatcherQueue DispatcherQueue { get; } ## -description -Gets the dispatcher queue for the window. +Gets the **DispatcherQueue** for the window. ## -property-value -The dispatcher queue for the window. +The **DispatcherQueue**. ## -remarks ## -see-also ## -examples - diff --git a/windows.ui.core/corewindowactivationmode.md b/windows.ui.core/corewindowactivationmode.md new file mode 100644 index 0000000000..6c8a25b845 --- /dev/null +++ b/windows.ui.core/corewindowactivationmode.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.UI.Core.CoreWindowActivationMode +-api-type: winrt enum +--- + + + +# Windows.UI.Core.CoreWindowActivationMode + +## -description + +Defines constants that specify the activation state of a window. + +## -enum-fields + +### -field None:0 + +No state is specified. + +### -field Deactivated:1 + +The window is deactivated. + +### -field ActivatedNotForeground:2 + +The window is activated, but not in the foreground. + +### -field ActivatedInForeground:3 + +The window is activated and in the foreground. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke.md b/windows.ui.input.inking.core/coreincrementalinkstroke.md new file mode 100644 index 0000000000..0edb56cd51 --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke + +## -description +Represents a single ink stroke that can be rendered incrementally, using individual [InkPoint](../windows.ui.input.inking/inkpoint.md) objects. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke_appendinkpoints_1328818154.md b/windows.ui.input.inking.core/coreincrementalinkstroke_appendinkpoints_1328818154.md new file mode 100644 index 0000000000..1c442ebf96 --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke_appendinkpoints_1328818154.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.AppendInkPoints(Windows.Foundation.Collections.IIterable{Windows.UI.Input.Inking.InkPoint}) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.AppendInkPoints + +## -description +Appends one or more [**InkPoint**](inkpoint.md) objects to the collection of [**InkPoint**](inkpoint.md) objects that compose the [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md). + +## -parameters +### -param inkPoints +The collection of [**InkPoint**](inkpoint.md) objects to append. + +## -returns +The bounding rectangle of the appended [**InkPoint**](inkpoint.md) objects. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke_boundingrect.md b/windows.ui.input.inking.core/coreincrementalinkstroke_boundingrect.md new file mode 100644 index 0000000000..16e996322b --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke_boundingrect.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.BoundingRect + +## -description +Gets the bounding rectangle of the [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md). + +## -property-value +The bounding rectangle of the [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke_coreincrementalinkstroke_838019319.md b/windows.ui.input.inking.core/coreincrementalinkstroke_coreincrementalinkstroke_838019319.md new file mode 100644 index 0000000000..31c65af525 --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke_coreincrementalinkstroke_838019319.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.#ctor(Windows.UI.Input.Inking.InkDrawingAttributes,Windows.Foundation.Numerics.Matrix3x2) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.CoreIncrementalInkStroke + +## -description +Initializes a new instance of the [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md) class. + +## -parameters +### -param drawingAttributes +The ink stroke attributes associated with the drawing of a [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md). + +### -param pointTransform +An affine transformation matrix to apply to the [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md) object. + +Both position and rotation are based on the top left corner of the stroke relative to the origin of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke_createinkstroke_1303818443.md b/windows.ui.input.inking.core/coreincrementalinkstroke_createinkstroke_1303818443.md new file mode 100644 index 0000000000..22d64e7df9 --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke_createinkstroke_1303818443.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.CreateInkStroke +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.CreateInkStroke + +## -description +Creates a new ink stroke. + +## -returns +The new ink stroke. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke_drawingattributes.md b/windows.ui.input.inking.core/coreincrementalinkstroke_drawingattributes.md new file mode 100644 index 0000000000..32ff46278e --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke_drawingattributes.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.DrawingAttributes +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.DrawingAttributes + +## -description +Gets the ink stroke attributes associated with the drawing of a [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md). + +## -property-value +The ink stroke attributes. + +## -remarks + +## -see-also + +## -examples \ No newline at end of file diff --git a/windows.ui.input.inking.core/coreincrementalinkstroke_pointtransform.md b/windows.ui.input.inking.core/coreincrementalinkstroke_pointtransform.md new file mode 100644 index 0000000000..a601409a8d --- /dev/null +++ b/windows.ui.input.inking.core/coreincrementalinkstroke_pointtransform.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.PointTransform +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Core.CoreIncrementalInkStroke.PointTransform + +## -description +Gets or sets an affine transformation matrix to apply to the [**CoreIncrementalInkStroke**](coreincrementalinkstroke.md) object. + +Both position and rotation are based on the top left corner of the stroke relative to the origin of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +## -property-value +The position and angle of the stroke as a 3*2 floating point matrix. + +The default position is the origin of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). The default rotation angle is 0 degrees. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreinkpresenterhost.md b/windows.ui.input.inking.core/coreinkpresenterhost.md new file mode 100644 index 0000000000..17ddf7db78 --- /dev/null +++ b/windows.ui.input.inking.core/coreinkpresenterhost.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Core.CoreInkPresenterHost +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Core.CoreInkPresenterHost + +## -description +Represents an object that hosts an InkPresenter without the need for an InkCanvas control. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreinkpresenterhost_coreinkpresenterhost_1221375020.md b/windows.ui.input.inking.core/coreinkpresenterhost_coreinkpresenterhost_1221375020.md new file mode 100644 index 0000000000..111d4e4d2d --- /dev/null +++ b/windows.ui.input.inking.core/coreinkpresenterhost_coreinkpresenterhost_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Core.CoreInkPresenterHost.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Core.CoreInkPresenterHost.CoreInkPresenterHost + +## -description +Initializes a new [CoreInkPresenterHost](coreinkpresenterhost.md) object that is used to manage an [**InkPresenter**](../windows.ui.input.inking/inkpresenter.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreinkpresenterhost_inkpresenter.md b/windows.ui.input.inking.core/coreinkpresenterhost_inkpresenter.md new file mode 100644 index 0000000000..79670266b7 --- /dev/null +++ b/windows.ui.input.inking.core/coreinkpresenterhost_inkpresenter.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Core.CoreInkPresenterHost.InkPresenter +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Core.CoreInkPresenterHost.InkPresenter + +## -description +Gets a reference to the [**InkPresenter**](../windows.ui.input.inking/inkpresenter.md) associatiated with this [CoreInkPresenterHost](coreinkpresenterhost.md). + +## -property-value +The [**InkPresenter**](../windows.ui.input.inking/inkpresenter.md) associatiated with this [CoreInkPresenterHost](coreinkpresenterhost.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/coreinkpresenterhost_rootvisual.md b/windows.ui.input.inking.core/coreinkpresenterhost_rootvisual.md new file mode 100644 index 0000000000..91970372f1 --- /dev/null +++ b/windows.ui.input.inking.core/coreinkpresenterhost_rootvisual.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Core.CoreInkPresenterHost.RootVisual +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Core.CoreInkPresenterHost.RootVisual + +## -description +Gets or sets the root visual container that the CoreInkPresenterHost draws to. + +## -property-value +A node in the composition visual tree that can have children. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.core/windows_ui_input_inking_core.md b/windows.ui.input.inking.core/windows_ui_input_inking_core.md index 8e6fd85a54..8d7c8351bc 100644 --- a/windows.ui.input.inking.core/windows_ui_input_inking_core.md +++ b/windows.ui.input.inking.core/windows_ui_input_inking_core.md @@ -8,16 +8,16 @@ ## -description Overrides default [InkPresenter](../windows.ui.input.inking/inkpresenter.md) run-time behavior to provide advanced input, processing, and management support for Windows Ink apps. +The [Windows.UI.Input.Inking.Core](windows_ui_input_inking_core.md) APIs enable you to: ++ Handle ink stroke events and pointer events before standard [InkPresenter](../windows.ui.input.inking/inkpresenter.md) events, which occur after ink strokes have been rendered. ++ Intercept raw pointer data and suppress, or cancel, ink rendering at any point along a stroke. This can be useful when protecting existing ink strokes or providing custom gesture support, such as press and hold, without creating ink artifacts. ++ Control the rendering path of an ink stroke. This can be useful for auto-correcting a user's stroke or masking areas of the drawing surface. ++ Draw ink strokes incrementally using individual [InkPoint](../windows.ui.input.inking/inkpoint.md) objects. + > [!IMPORTANT] > [Windows.UI.Input.Inking.Core](windows_ui_input_inking_core.md) processing occurs on the ink background thread. For this reason, ensure any custom processing of ink input is as lightweight as possible to avoid degraded performance and to keep your app as responsive as possible. ## -remarks -Standard [InkPresenter](../windows.ui.input.inking/inkpresenter.md) events occur after ink strokes have been rendered. - -The [Windows.UI.Input.Inking.Core](windows_ui_input_inking_core.md) API enable you to: -+ Intercept raw pointer data and suppress, or cancel, ink rendering at any point along a stroke. This can be useful when protecting existing ink strokes or providing custom gesture support, such as press and hold, without creating ink artifacts. -+ Control the rendering path of an ink stroke. This can be useful for auto-correcting a user's stroke or masking areas of the drawing surface. - ## -examples diff --git a/windows.ui.input.inking/inkstrokecontainer_inkstrokecontainer_1221375020.md b/windows.ui.input.inking/inkstrokecontainer_inkstrokecontainer_1221375020.md index 2502635254..8b8b9109e0 100644 --- a/windows.ui.input.inking/inkstrokecontainer_inkstrokecontainer_1221375020.md +++ b/windows.ui.input.inking/inkstrokecontainer_inkstrokecontainer_1221375020.md @@ -11,7 +11,7 @@ public InkStrokeContainer() # Windows.UI.Input.Inking.InkStrokeContainer.InkStrokeContainer ## -description -Creates a new [InkStrokeContainer](inkstrokecontainer.md) object that is used to manage [InkStroke](inkstroke.md) objects. +Initializes a new [InkStrokeContainer](inkstrokecontainer.md) object that is used to manage [InkStroke](inkstroke.md) objects. ## -remarks diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo.md new file mode 100644 index 0000000000..63d7d4b2f9 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo +-api-type: winrt class +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo + +## -description +Represents programmatically generated gamepad input. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_buttons.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_buttons.md new file mode 100644 index 0000000000..519578f3cf --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_buttons.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.Buttons +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.Buttons + +## -description +Gets or sets the the gamepad buttons used for input injection. + +## -property-value +One or more gamepad buttons used for input injection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_injectedinputgamepadinfo_1221375020.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_injectedinputgamepadinfo_1221375020.md new file mode 100644 index 0000000000..3f69ca07d8 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_injectedinputgamepadinfo_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.InjectedInputGamepadInfo + +## -description +Creates a new [InjectedInputGamepadInfo](injectedinputgamepadinfo.md) object that is used to specify the gamepad input to inject. + +## -remarks + +## -see-also +- [InjectedInputGamepadInfo(GamepadReading reading)](injectedinputgamepadinfo_injectedinputgamepadinfo_1221375020.md) + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_injectedinputgamepadinfo_1846648144.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_injectedinputgamepadinfo_1846648144.md new file mode 100644 index 0000000000..92013c0e72 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_injectedinputgamepadinfo_1846648144.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.#ctor(Windows.Gaming.Input.GamepadReading) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.InjectedInputGamepadInfo + +## -description +Creates a new [InjectedInputGamepadInfo](injectedinputgamepadinfo.md) object that is used to specify the gamepad input to inject based on the current state of the gamepad. + +## -parameters +### -param reading +The current state of the gamepad. + +> [!NOTE] +> The [**Timestamp**](https://docs.microsoft.com/uwp/api/windows.gaming.input.gamepadreading?branch=rs3#Windows_Gaming_Input_GamepadReading_Timestamp) value is replaced with the current time of input injection. + +## -remarks + +## -see-also +- [InjectedInputGamepadInfo()](injectedinputgamepadinfo_injectedinputgamepadinfo_1221375020.md) + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_leftthumbstickx.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_leftthumbstickx.md new file mode 100644 index 0000000000..7e41876ae0 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_leftthumbstickx.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.LeftThumbstickX +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.LeftThumbstickX + +## -description +Gets or sets the position of the left stick on the X-axis. + +## -property-value +A value between -1.0 (pressed to the left) and 1.0 (pressed to the right). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_leftthumbsticky.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_leftthumbsticky.md new file mode 100644 index 0000000000..551386e19c --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_leftthumbsticky.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.LeftThumbstickY +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.LeftThumbstickY + +## -description +Gets or sets the position of the left stick on the Y-axis. + +## -property-value +A value between -1.0 (pressed towards the user) and 1.0 (pressed away from the user). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_lefttrigger.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_lefttrigger.md new file mode 100644 index 0000000000..46617c9623 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_lefttrigger.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.LeftTrigger +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.LeftTrigger + +## -description +Gets or sets the position of the left trigger. + +## -property-value +A value between 0.0 (not depressed) and 1.0 (fully depressed). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_rightthumbstickx.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_rightthumbstickx.md new file mode 100644 index 0000000000..06a3ab728d --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_rightthumbstickx.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.RightThumbstickX +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.RightThumbstickX + +## -description +Gets or sets the position of the right stick on the X-axis. + +## -property-value +A value between -1.0 (pressed to the left) and 1.0 (pressed to the right). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_rightthumbsticky.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_rightthumbsticky.md new file mode 100644 index 0000000000..4e1849583b --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_rightthumbsticky.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.RightThumbstickY +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.RightThumbstickY + +## -description +Gets or sets the position of the right stick on the Y-axis. + +## -property-value +A value between -1.0 (pressed towards the user) and 1.0 (pressed away from the user). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputgamepadinfo_righttrigger.md b/windows.ui.input.preview.injection/injectedinputgamepadinfo_righttrigger.md new file mode 100644 index 0000000000..73367bfd74 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputgamepadinfo_righttrigger.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.RightTrigger +-api-type: winrt property +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo.RightTrigger + +## -description +Gets or sets the position of the right trigger. + +## -property-value +A value between 0.0 (not depressed) and 1.0 (fully depressed). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/inputinjector_initializegamepadinjection_1113833135.md b/windows.ui.input.preview.injection/inputinjector_initializegamepadinjection_1113833135.md new file mode 100644 index 0000000000..4100109e8e --- /dev/null +++ b/windows.ui.input.preview.injection/inputinjector_initializegamepadinjection_1113833135.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InputInjector.InitializeGamepadInjection +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InputInjector.InitializeGamepadInjection + +## -description +Initializes a virtual gamepad device that can synthesize input events and provide corresponding input data to your app. + +## -remarks +Calling this method is analogous to connecting a physical gamepad, which also triggers a [**GamepadAdded**](https://docs.microsoft.com/uwp/api/windows.gaming.input.gamepad#Windows_Gaming_Input_Gamepad_GamepadAdded) event. + +A physical gamepad is assigned a persistent unique ID (see [**NonRoamableId**](..\windows.gaming.input\rawgamecontroller_nonroamableid.md)) that does not change when the device is connected and disconnected. Similarly, a virtual gamepad created with [**InitializeGamepadInjection**](inputinjector_initializegamepadinjection_1113833135.md) is also assigned a unique ID that persists across calls to [UninitializeGamepadInjection](inputinjector_initializegamepadinjection_1113833135.md) and [**InitializeGamepadInjection**](inputinjector_initializegamepadinjection_1113833135.md) for the same [InputInjector](inputinjector.md) instance. + +## -examples + +## -see-also +- [UninitializeGamepadInjection](inputinjector_uninitializegamepadinjection_370962456.md) + + diff --git a/windows.ui.input.preview.injection/inputinjector_initializepeninjection_260722924.md b/windows.ui.input.preview.injection/inputinjector_initializepeninjection_260722924.md index 2fa07aa1d6..a87a7ef250 100644 --- a/windows.ui.input.preview.injection/inputinjector_initializepeninjection_260722924.md +++ b/windows.ui.input.preview.injection/inputinjector_initializepeninjection_260722924.md @@ -10,7 +10,7 @@ public void InitializePenInjection(Windows.UI.Input.Preview.Injection.InjectedIn # Windows.UI.Input.Preview.Injection.InputInjector.InitializePenInjection ## -description -Initializes the virtual pen device for sending the input data. +Initializes a virtual pen device that can synthesize input events and provide corresponding input data to your app. ## -parameters ### -param visualMode @@ -21,3 +21,4 @@ The visual feedback mode for pen input injection. ## -examples ## -see-also +- [UninitializePenInjection](inputinjector_uninitializepeninjection_664142813.md) diff --git a/windows.ui.input.preview.injection/inputinjector_initializetouchinjection_1509714255.md b/windows.ui.input.preview.injection/inputinjector_initializetouchinjection_1509714255.md index 4b5329f53c..f293e7837a 100644 --- a/windows.ui.input.preview.injection/inputinjector_initializetouchinjection_1509714255.md +++ b/windows.ui.input.preview.injection/inputinjector_initializetouchinjection_1509714255.md @@ -10,7 +10,7 @@ public void InitializeTouchInjection(Windows.UI.Input.Preview.Injection.Injected # Windows.UI.Input.Preview.Injection.InputInjector.InitializeTouchInjection ## -description -Initializes the virtual touch device for sending the input data. +Initializes a virtual touch device that can synthesize input events and provide corresponding input data to your app. ## -parameters ### -param visualMode @@ -21,3 +21,4 @@ The visual feedback mode for touch input injection. ## -examples ## -see-also +- [UninitializeTouchInjection](inputinjector_uninitializetouchinjection_1885359186.md) diff --git a/windows.ui.input.preview.injection/inputinjector_injectgamepadinput_439627777.md b/windows.ui.input.preview.injection/inputinjector_injectgamepadinput_439627777.md new file mode 100644 index 0000000000..dbb9248ef8 --- /dev/null +++ b/windows.ui.input.preview.injection/inputinjector_injectgamepadinput_439627777.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InputInjector.InjectGamepadInput(Windows.UI.Input.Preview.Injection.InjectedInputGamepadInfo) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InputInjector.InjectGamepadInput + +## -description +Sends programmatically generated gamepad input to the system. + +## -parameters +### -param input +The gamepad input specified by [InjectedInputGamepadInfo](injectedinputgamepadinfo.md). + +## -remarks + +## -examples + +## -see-also + diff --git a/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md b/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md index 170e2fcaec..5c9e23d576 100644 --- a/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md +++ b/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md @@ -10,7 +10,7 @@ public InputInjector InputInjector.TryCreate() # Windows.UI.Input.Preview.Injection.InputInjector.TryCreate ## -description -Creates a new instance of the [InputInjector](inputinjector.md) class. +Attempts to create a new instance of the [InputInjector](inputinjector.md) class. ## -parameters diff --git a/windows.ui.input.preview.injection/inputinjector_trycreateforappbroadcastonly_1904430574.md b/windows.ui.input.preview.injection/inputinjector_trycreateforappbroadcastonly_1904430574.md new file mode 100644 index 0000000000..145884aee3 --- /dev/null +++ b/windows.ui.input.preview.injection/inputinjector_trycreateforappbroadcastonly_1904430574.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InputInjector.TryCreateForAppBroadcastOnly +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InputInjector.TryCreateForAppBroadcastOnly + +## -description +Attempts to create a new instance of the [InputInjector](inputinjector.md) class. + +> [!NOTE] +> This method differs from [TryCreate](inputinjector_trycreate_508033141.md) in that input injection is restricted to the process that is actively being captured for broadcast using an [App​Broadcast​Services](https://docs.microsoft.com/en-us/uwp/api/windows.media.capture.appbroadcastservices) object. Injected input is silently dropped when there is no such active process. + +## -returns +If successful, returns a new instance of the [InputInjector](inputinjector.md) class. Otherwise, returns null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/inputinjector_uninitializegamepadinjection_370962456.md b/windows.ui.input.preview.injection/inputinjector_uninitializegamepadinjection_370962456.md new file mode 100644 index 0000000000..40b6e54a57 --- /dev/null +++ b/windows.ui.input.preview.injection/inputinjector_uninitializegamepadinjection_370962456.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InputInjector.UninitializeGamepadInjection +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InputInjector.UninitializeGamepadInjection + +## -description +Shuts down the virtual gamepad device created with [InitializeGamepadInjection](inputinjector_initializegamepadinjection_1113833135.md). + +## -remarks +Calling this method is analogous to disconnecting a physical gamepad, which also triggers a [**GamepadRemoved**](https://docs.microsoft.com/uwp/api/windows.gaming.input.gamepad#Windows_Gaming_Input_Gamepad_GamepadRemoved) event. + +A physical gamepad is assigned a persistent unique ID (see [**NonRoamableId**](..\windows.gaming.input\rawgamecontroller_nonroamableid.md)) that does not change when the device is connected and disconnected. Similarly, a virtual gamepad created with [**InitializeGamepadInjection**](inputinjector_initializegamepadinjection_1113833135.md) is also assigned a unique ID that persists across calls to [UninitializeGamepadInjection](inputinjector_initializegamepadinjection_1113833135.md) and [**InitializeGamepadInjection**](inputinjector_initializegamepadinjection_1113833135.md) for the same [InputInjector](inputinjector.md) instance. + +## -examples + +## -see-also +- [InitializeGamepadInjection](inputinjector_initializegamepadinjection_1113833135.md) + diff --git a/windows.ui.input.preview.injection/inputinjector_uninitializepeninjection_664142813.md b/windows.ui.input.preview.injection/inputinjector_uninitializepeninjection_664142813.md index 56062dd08b..bbab427c37 100644 --- a/windows.ui.input.preview.injection/inputinjector_uninitializepeninjection_664142813.md +++ b/windows.ui.input.preview.injection/inputinjector_uninitializepeninjection_664142813.md @@ -10,7 +10,7 @@ public void UninitializePenInjection() # Windows.UI.Input.Preview.Injection.InputInjector.UninitializePenInjection ## -description -Shuts down the virtual pen device sending the input data. +Shuts down the virtual pen device created with [InitializePenInjection](inputinjector_initializepeninjection_260722924.md). ## -remarks diff --git a/windows.ui.input.preview.injection/inputinjector_uninitializetouchinjection_1885359186.md b/windows.ui.input.preview.injection/inputinjector_uninitializetouchinjection_1885359186.md index bfa93b96f2..2a7a9c061a 100644 --- a/windows.ui.input.preview.injection/inputinjector_uninitializetouchinjection_1885359186.md +++ b/windows.ui.input.preview.injection/inputinjector_uninitializetouchinjection_1885359186.md @@ -10,7 +10,7 @@ public void UninitializeTouchInjection() # Windows.UI.Input.Preview.Injection.InputInjector.UninitializeTouchInjection ## -description -Shuts down the virtual touch device sending the input data. +Shuts down the virtual touch device created with [InitializeTouchInjection](inputinjector_initializetouchinjection_1509714255.md). ## -remarks diff --git a/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md b/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md index 1e5a14f96c..fd7338718c 100644 --- a/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md +++ b/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md @@ -6,7 +6,7 @@ # Windows.UI.Input.Preview.Injection ## -description -Provides support for programmatically generating and automating input from a variety of devices such as keyboard, mouse, touch, and pen. +Provides support for programmatically generating and automating input from a variety of devices such as keyboard, mouse, touch, pen, and gamepad. ## -remarks diff --git a/windows.ui.input/radialcontroller_createforcurrentview_1186319000.md b/windows.ui.input/radialcontroller_createforcurrentview_1186319000.md index 20737064a1..7f429391f0 100644 --- a/windows.ui.input/radialcontroller_createforcurrentview_1186319000.md +++ b/windows.ui.input/radialcontroller_createforcurrentview_1186319000.md @@ -16,6 +16,7 @@ Instantiates a [RadialController](radialcontroller.md) object for the wheel devi The [RadialController](radialcontroller.md) object to bind to the active application. ## -remarks +We recommend creating the [RadialController](radialcontroller.md) object in your app's OnPageLoaded event handler. ## -examples diff --git a/windows.ui.input/radialcontroller_menu.md b/windows.ui.input/radialcontroller_menu.md index 62e8b1b18c..5ae1e7851e 100644 --- a/windows.ui.input/radialcontroller_menu.md +++ b/windows.ui.input/radialcontroller_menu.md @@ -16,6 +16,7 @@ Gets a reference to the menu associated with the [RadialController](radialcontro The integrated menu of contextual app commands associated with the [RadialController](radialcontroller.md) object. ## -remarks +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. ## -examples diff --git a/windows.ui.input/radialcontrollerconfiguration_appcontroller.md b/windows.ui.input/radialcontrollerconfiguration_appcontroller.md new file mode 100644 index 0000000000..8e0910bfbf --- /dev/null +++ b/windows.ui.input/radialcontrollerconfiguration_appcontroller.md @@ -0,0 +1,30 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerConfiguration.AppController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerConfiguration.AppController + +## -description +Gets or sets whether the [**RadialController**](radialcontroller.md) object is bound to the main application process rather than a specific app view (or top-level window). + +If [**AppController**](radialcontrollerconfiguration_appcontroller.md) is set, that radial controller (and menu) is used for the top-level window and all views in the application process (overriding any individual view controllers you have defined). + +> [!NOTE] +> You must also set [IsAppControllerEnabled](radialcontrollerconfiguration_isappcontrollerenabled.md) to **true**. + +## -property-value +The [**RadialController**](radialcontroller.md) object to bind to the active application. + +## -remarks +We recommend creating an app controller in the [Loaded](https://docs.microsoft.com/uwp/api/windows.ui.xaml.frameworkelement#Windows_UI_Xaml_FrameworkElement_Loaded) handler of your app's main page (or equivalent). + +## -examples + +## -see-also +- [IsAppControllerEnabled](radialcontrollerconfiguration_isappcontrollerenabled.md) + diff --git a/windows.ui.input/radialcontrollerconfiguration_isappcontrollerenabled.md b/windows.ui.input/radialcontrollerconfiguration_isappcontrollerenabled.md new file mode 100644 index 0000000000..4fd7a402ac --- /dev/null +++ b/windows.ui.input/radialcontrollerconfiguration_isappcontrollerenabled.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerConfiguration.IsAppControllerEnabled +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerConfiguration.IsAppControllerEnabled + +## -description +Gets or sets whether the [**RadialController**](radialcontroller.md) object is enabled as an [**AppController**](radialcontrollerconfiguration_appcontroller.md) and controller events can be handled by your app. + +## -property-value +**true** if enabled. Otherwise, **false**. The default is **false**. + +## -remarks +If [**AppController**](radialcontrollerconfiguration_appcontroller.md) is set, that radial controller (and menu) is used for all top-level windows in the application process (all individual view controllers are overridden). + +We recommend creating an app controller in the [Loaded](https://docs.microsoft.com/uwp/api/windows.ui.xaml.frameworkelement#Windows_UI_Xaml_FrameworkElement_Loaded) handler of your app's main page (or equivalent). + + +## -examples + +## -see-also +- [AppController](radialcontrollerconfiguration_appcontroller.md) + diff --git a/windows.ui.input/radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md b/windows.ui.input/radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md index a40d695408..3ddba531c0 100644 --- a/windows.ui.input/radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md +++ b/windows.ui.input/radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md @@ -13,6 +13,7 @@ public void ResetToDefaultMenuItems() Restores the [RadialController](radialcontroller.md) menu to the default configuration. ## -remarks +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. ## -examples diff --git a/windows.ui.input/radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md b/windows.ui.input/radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md index dc41e66cf1..23d5e39f7b 100644 --- a/windows.ui.input/radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md +++ b/windows.ui.input/radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md @@ -20,6 +20,7 @@ Specifies which built-in tools are shown on the [RadialController](radialcontrol The default set of commands ([RadialControllerSystemMenuItemKind](radialcontrollersystemmenuitemkind.md)) available on a [RadialController](radialcontroller.md) menu. ## -remarks +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. ## -examples diff --git a/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md b/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md index c72887ef02..7c6bd4bd29 100644 --- a/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md +++ b/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md @@ -20,6 +20,7 @@ The built-in tool to select and activate. **true** if the tool can be selected; otherwise **false**. ## -remarks +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. ## -examples diff --git a/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md index 06fd883b1c..ed25ac4c20 100644 --- a/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md +++ b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md @@ -29,6 +29,8 @@ The custom tool. ## -remarks Use this method overload when you referencing a font already installed on the system. Otherwise, use [CreateFromFontGlyph(String displayText, String glyph, String fontFamily, Uri fontUri)](radialcontrollermenuitem_createfromfontglyph_679326837.md). +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. + [UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: + **Text** diff --git a/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md index 421c420000..176889550a 100644 --- a/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md +++ b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md @@ -32,6 +32,8 @@ The custom tool. ## -remarks When using this method overload to reference a font glyph installed with your app's appx package, your app might display a broken image when deployed from Visual Studio. In this case, you should first create an app package (**Project->Store->CreateAppPackage**) and then deploy. +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. + [UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: + **Text** diff --git a/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md b/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md index 81cd234e9f..1bfc42e920 100644 --- a/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md +++ b/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md @@ -23,6 +23,8 @@ The custom icon to display for the custom tool. The custom tool. ## -remarks +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. + [UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: **Text** diff --git a/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md b/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md index 6c1b7bc19c..61509d313b 100644 --- a/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md +++ b/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md @@ -23,6 +23,8 @@ The system icon to display for the custom tool. The custom tool. ## -remarks +[RadialController](radialcontroller.md) menu operations, including [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon_1665769620.md), [CreateFromIcon](radialcontrollermenuitem_createfromicon_2066467533.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_679326837.md), [CreateFromFontGlyph](radialcontrollermenuitem_createfromfontglyph_63723173.md), [ResetToDefaultMenuItems](radialcontrollerconfiguration_resettodefaultmenuitems_461236227.md), [SetDefaultMenuItems](radialcontrollerconfiguration_setdefaultmenuitems_1318008085.md), and [TrySelectDefaultMenuItem](radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md), should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread. + [UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: **Text** diff --git a/windows.ui.shell/adaptivecardbuilder.md b/windows.ui.shell/adaptivecardbuilder.md new file mode 100644 index 0000000000..2d8b7a681e --- /dev/null +++ b/windows.ui.shell/adaptivecardbuilder.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Shell.AdaptiveCardBuilder +-api-type: winrt class +--- + + + +# Windows.UI.Shell.AdaptiveCardBuilder + +## -description +Builds Adaptive Cards that can be used in Windows. + +## -remarks + +## -see-also + +[IAdaptiveCard](iadaptivecard.md) diff --git a/windows.ui.shell/adaptivecardbuilder_createadaptivecardfromjson_2145854883.md b/windows.ui.shell/adaptivecardbuilder_createadaptivecardfromjson_2145854883.md new file mode 100644 index 0000000000..66162ceeb5 --- /dev/null +++ b/windows.ui.shell/adaptivecardbuilder_createadaptivecardfromjson_2145854883.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Shell.AdaptiveCardBuilder.CreateAdaptiveCardFromJson(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Shell.AdaptiveCardBuilder.CreateAdaptiveCardFromJson + +## -description +Creates a new instance of [IAdaptiveCard](iadaptivecard.md) using the specified Adaptive Card JSON. For more information, see [Get Started with Adaptive Cards](https://adaptivecards.io/documentation/#create-GettingStarted). + +## -parameters +### -param value +A String representation of the JSON that describes the Adaptive Card to create. + +## -returns +An IAdaptiveCard object that represents the described Adaptive Card. + +## -remarks + +## -see-also + diff --git a/windows.ui.shell/iadaptivecard.md b/windows.ui.shell/iadaptivecard.md new file mode 100644 index 0000000000..59873ce45a --- /dev/null +++ b/windows.ui.shell/iadaptivecard.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Shell.IAdaptiveCard +-api-type: winrt interface +--- + + + +# Windows.UI.Shell.IAdaptiveCard + +## -description +An Adaptive Card that can be used in Windows. + +## -remarks +Adaptive Cards are a cross-platform framework for custom and interactive chat bot cards. [Learn more about the framework and view associated samples.](https://adaptivecards.io) + +## -see-also + +[AdaptiveCardbuilder](adaptivecardbuilder.md) diff --git a/windows.ui.shell/iadaptivecard_tojson_1289546151.md b/windows.ui.shell/iadaptivecard_tojson_1289546151.md new file mode 100644 index 0000000000..ad524be58d --- /dev/null +++ b/windows.ui.shell/iadaptivecard_tojson_1289546151.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Shell.IAdaptiveCard.ToJson +-api-type: winrt method +--- + + + +# Windows.UI.Shell.IAdaptiveCard.ToJson + +## -description +Returns the JSON that represents this Adaptive Card. + +## -returns +A String that contains the JSON representation of the Adaptive Card. + +## -remarks + +## -see-also + + diff --git a/windows.ui.shell/iadaptivecardbuilderstatics.md b/windows.ui.shell/iadaptivecardbuilderstatics.md new file mode 100644 index 0000000000..080563e8f5 --- /dev/null +++ b/windows.ui.shell/iadaptivecardbuilderstatics.md @@ -0,0 +1,18 @@ +--- +-api-id: T:Windows.UI.Shell.IAdaptiveCardBuilderStatics +-api-type: winrt interface +--- + + + +# Windows.UI.Shell.IAdaptiveCardBuilderStatics + +## -description +Provides access to methods that build Adaptive Cards for use on Windows. + +## -remarks + +## -see-also + diff --git a/windows.ui.shell/iadaptivecardbuilderstatics_createadaptivecardfromjson_2145854883.md b/windows.ui.shell/iadaptivecardbuilderstatics_createadaptivecardfromjson_2145854883.md new file mode 100644 index 0000000000..c27e87a94f --- /dev/null +++ b/windows.ui.shell/iadaptivecardbuilderstatics_createadaptivecardfromjson_2145854883.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Shell.IAdaptiveCardBuilderStatics.CreateAdaptiveCardFromJson(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Shell.IAdaptiveCardBuilderStatics.CreateAdaptiveCardFromJson + +## -description +Creates a new instance of [IAdaptiveCard](iadaptivecard.md) using the specified Adaptive Card JSON. For more information, see [Get Started with Adaptive Cards](https://adaptivecards.io/documentation/#create-GettingStarted). + +## -parameters +### -param value +A String representation of the JSON that describes the Adaptive Card to create. + +## -returns +An IAdapativeCard object that represents the described Adaptive Card. + +## -remarks + +## -see-also + + diff --git a/windows.ui.shell/taskbarmanager.md b/windows.ui.shell/taskbarmanager.md new file mode 100644 index 0000000000..029328c447 --- /dev/null +++ b/windows.ui.shell/taskbarmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Shell.TaskbarManager +-api-type: winrt class +--- + + + +# Windows.UI.Shell.TaskbarManager + +## -description +Provides methods for pinning applications to the taskbar. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.shell/taskbarmanager_getdefault_846721868.md b/windows.ui.shell/taskbarmanager_getdefault_846721868.md new file mode 100644 index 0000000000..a16c8ee624 --- /dev/null +++ b/windows.ui.shell/taskbarmanager_getdefault_846721868.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Shell.TaskbarManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.UI.Shell.TaskbarManager.GetDefault + +## -description +Returns the [TaskbarManager](taskbarmanager.md) object active in the current process. + +## -returns +The active TaskbarManager object. + +## -remarks + +## -see-also + + diff --git a/windows.ui.shell/taskbarmanager_isapplistentrypinnedasync_1856884762.md b/windows.ui.shell/taskbarmanager_isapplistentrypinnedasync_1856884762.md new file mode 100644 index 0000000000..b9b05bfa67 --- /dev/null +++ b/windows.ui.shell/taskbarmanager_isapplistentrypinnedasync_1856884762.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Shell.TaskbarManager.IsAppListEntryPinnedAsync(Windows.ApplicationModel.Core.AppListEntry) +-api-type: winrt method +--- + + + +# Windows.UI.Shell.TaskbarManager.IsAppListEntryPinnedAsync + +## -description +Checks if the specified application is already pinned to the taskbar. + +## -parameters +### -param appListEntry +An [AppListEntry](https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Core.AppListEntry) corresponding to the application to check. + +## -returns +A boolean representing whether the specified application is pinned to the taskbar. + +## -remarks + +## -see-also + diff --git a/windows.ui.shell/taskbarmanager_iscurrentapppinnedasync_514180730.md b/windows.ui.shell/taskbarmanager_iscurrentapppinnedasync_514180730.md new file mode 100644 index 0000000000..ac16a32ace --- /dev/null +++ b/windows.ui.shell/taskbarmanager_iscurrentapppinnedasync_514180730.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Shell.TaskbarManager.IsCurrentAppPinnedAsync +-api-type: winrt method +--- + + + +# Windows.UI.Shell.TaskbarManager.IsCurrentAppPinnedAsync + +## -description +Checks if the currently active application is already pinned to the taskbar. + +## -returns +A boolean representing whether the current application is pinned to the taskbar. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.shell/taskbarmanager_ispinningallowed.md b/windows.ui.shell/taskbarmanager_ispinningallowed.md new file mode 100644 index 0000000000..1276b8b445 --- /dev/null +++ b/windows.ui.shell/taskbarmanager_ispinningallowed.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Shell.TaskbarManager.IsPinningAllowed +-api-type: winrt property +--- + + + +# Windows.UI.Shell.TaskbarManager.IsPinningAllowed + +## -description +Gets whether pinning to the taskbar is allowed. + +## -property-value +A boolean indicating whether pinning to the taskbar is allowed. + +## -remarks +Pinning to taskbar can be disabled through group policy, and is not available on some device families. + +## -see-also diff --git a/windows.ui.shell/taskbarmanager_issupported.md b/windows.ui.shell/taskbarmanager_issupported.md new file mode 100644 index 0000000000..57c6caa5f3 --- /dev/null +++ b/windows.ui.shell/taskbarmanager_issupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Shell.TaskbarManager.IsSupported +-api-type: winrt property +--- + + + +# Windows.UI.Shell.TaskbarManager.IsSupported + +## -description +Gets whether the taskbar is present on the current device. + +## -property-value +A boolean indicating if the taskbar is present. This will return false on devices where no taskbar is present. + +## -remarks +Currently, the taskbar is only present on the Desktop device family. + +## -see-also + diff --git a/windows.ui.shell/taskbarmanager_requestpinapplistentryasync_1970417862.md b/windows.ui.shell/taskbarmanager_requestpinapplistentryasync_1970417862.md new file mode 100644 index 0000000000..0df4ffc9ad --- /dev/null +++ b/windows.ui.shell/taskbarmanager_requestpinapplistentryasync_1970417862.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Shell.TaskbarManager.RequestPinAppListEntryAsync(Windows.ApplicationModel.Core.AppListEntry) +-api-type: winrt method +--- + + + +# Windows.UI.Shell.TaskbarManager.RequestPinAppListEntryAsync + +## -description +Requests that the specified application be pinned to the taskbar. + +## -parameters +### -param appListEntry +An [AppListEntry](https://docs.microsoft.com/uwp/api/Windows.ApplicationModel.Core.AppListEntry) corresponding to the application to pin to the taskbar. + +## -returns +A boolean representing whether the application was successfully pinned to the takbar. If the app was already pinned, this will immediately return true. + +## -remarks +Calling this method will display a dialog asking the user to confirm that they want to pin the app. If the user selects "no", this method will return false. + +## -see-also \ No newline at end of file diff --git a/windows.ui.shell/taskbarmanager_requestpincurrentappasync_96379057.md b/windows.ui.shell/taskbarmanager_requestpincurrentappasync_96379057.md new file mode 100644 index 0000000000..af370af0fb --- /dev/null +++ b/windows.ui.shell/taskbarmanager_requestpincurrentappasync_96379057.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Shell.TaskbarManager.RequestPinCurrentAppAsync +-api-type: winrt method +--- + + + +# Windows.UI.Shell.TaskbarManager.RequestPinCurrentAppAsync + +## -description +Requests that the currently active application be pinned to the taskbar. + +## -returns +A boolean representing whether the application was successfully pinned to the takbar. If the app was already pinned, this will immediately return true. + +## -remarks +Calling this method will display a dialog asking the user to confirm that they want to pin the app. If the user selects "no", this method will return false. + +## -see-also + +## -examples + diff --git a/windows.ui.shell/windows_ui_shell.md b/windows.ui.shell/windows_ui_shell.md new file mode 100644 index 0000000000..fca3abcdd8 --- /dev/null +++ b/windows.ui.shell/windows_ui_shell.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.UI.Shell +-api-type: winrt namespace +--- + + + +# Windows.UI.Shell + +## -description +Provides support for connecting apps with native elements of the Windows UI through the Windows Shell. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text.core/coretextinputscope.md b/windows.ui.text.core/coretextinputscope.md index fde063e277..83defe20d4 100644 --- a/windows.ui.text.core/coretextinputscope.md +++ b/windows.ui.text.core/coretextinputscope.md @@ -92,13 +92,16 @@ Expected input is the numeric day portion of a calendar date. Expected input is the year portion of a calendar date. ### -field DateMonthName:26 -Expected input is the name of the month portion of a calendar date. +Expected input is the alphabetic name of the month from a calendar date. ### -field DateDayName:27 -Expected input is the name of the day in a calendar date. +Expected input is the alphabetic name of the day from a calendar date. + +### -field Digits:28 +Expected input includes positive whole numbers, constrained to 0-9. ### -field Number:29 -Expected input is the digits 0-9. +Expected input includes the digits 0-9, decimal separators, place separators, and negative sign. The exact characters used for decimal separators, place separators, and negative sign, depend on the user’s regional settings. ### -field SingleCharacter:30 Expected input is a single ANSI character, codepage 1252. @@ -188,10 +191,10 @@ Expected input is chat strings. Expected input is a name or a telephone number. ### -field EmailUserNameOrAddress:60 -Expected input is an email user name (<accountname>) or full email address (<accountname>@<host>). +Expected input is an email user name (\) or full email address (\@\). ### -field Private:61 -Expected input is private text. Advises input processors that the text should not be stored nor logged. +Expected input is private data. Advises input processors that the text should not be stored nor logged. ### -field Maps:62 Expected input is from the device's Maps layout; does not include typing intelligence. @@ -199,16 +202,23 @@ Expected input is from the device's Maps layout; does not include typing intelli ### -field PasswordNumeric:63 Expected input is a numeric password, or PIN. +### -field PinNumeric:64 +Expected input is an numeric password, or PIN. Typically constrained to 5-6 digits. + +### -field PinAlphanumeric:65 +Expected input is an alphanumeric password, or PIN. Typically constrained to 5-6 characters. + ### -field FormulaNumber:67 Expected input is a mathematical formula. Advises input processors to show the number page. ### -field ChatWithoutEmoji:68 Expected input does not include emoji. Advises input processors to not display the emoji key. - ## -remarks ## -examples ## -see-also -[Windows.UI.Text.Core](windows_ui_text_core.md), [Use input scope to change the touch keyboard](http://msdn.microsoft.com/library/6e5f55d7-24d6-47cc-b457-b6231ede2a71) \ No newline at end of file +[Windows.UI.Text.Core](windows_ui_text_core.md), [Use input scope to change the touch keyboard](http://msdn.microsoft.com/library/6e5f55d7-24d6-47cc-b457-b6231ede2a71) + + diff --git a/windows.ui.viewmanagement.core/coreinputview.md b/windows.ui.viewmanagement.core/coreinputview.md new file mode 100644 index 0000000000..d8f482e8cf --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputview.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.UI.ViewManagement.Core.CoreInputView +-api-type: winrt class +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputView + +## -description +Enables an app to receive notifications when a docked, undocked, moveable, or transitory input pane (and associated UI) is moved, displayed, or hidden, and to determine which portion of the app's window is obscured by the pane. + +With this info, your app can adjust and reflow it's UI to account for any occlusion. + +The CoreInputView APIs support the following types of input panes. +- Docked Soft Input Panel (SIP) like the **Touch keyboard and handwriting panel** – typically, your app UI reflows +- Floating toolbar or SIP – typically, your app UI does not reflow +- Overlay panels such as IME candidate windows – typically, your app UI does not reflow for the edit control, but does reflow for the text/search suggestions + +## -remarks +The input pane appears when the user performs an action that requires them to provide information, such as entering a text field. + +By default, Windows handles input pane events and repositions content so that users can see the control with focus. If you set [CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/coretexteditcontext_inputpanedisplaypolicy.md) to **Manual** in your app, you are responsible for showing and hiding the input pane using [TryShowPrimaryView](coreinputview_tryshowprimaryview_1925215151.md) and [TryHidePrimaryView](coreinputview_tryhideprimaryview_908065025.md). Use this class to override the default behavior and customize the input pane. + +Call [GetForCurrentView](coreinputview_getforcurrentview_1363600702.md) to get a [CoreInputView](coreinputview.md) object. + +After you register to receive input pane notifications, the system calls your event delegate whenever the pane is shown or hidden for the window that was visible when you called the [GetForCurrentView](coreinputview_getforcurrentview_1363600702.md) method. + +> [!NOTE] +> This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see [Threading and Marshaling (C++/CX)](http://go.microsoft.com/fwlink/p/?linkid=258275). + +## -see-also +- [CoreInputViewOcclusion](coreinputviewocclusion.md) + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputview_getcoreinputviewocclusions_391530112.md b/windows.ui.viewmanagement.core/coreinputview_getcoreinputviewocclusions_391530112.md new file mode 100644 index 0000000000..ac7d031378 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputview_getcoreinputviewocclusions_391530112.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.ViewManagement.Core.CoreInputView.GetCoreInputViewOcclusions +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputView.GetCoreInputViewOcclusions + +## -description +Gets a reference to each input pane currently occluding the app. + +## -property-value +A [CoreInputViewOcclusion](coreinputviewocclusion.md) collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputview_getforcurrentview_1363600702.md b/windows.ui.viewmanagement.core/coreinputview_getforcurrentview_1363600702.md new file mode 100644 index 0000000000..c46728a077 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputview_getforcurrentview_1363600702.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.ViewManagement.Core.CoreInputView.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputView.GetForCurrentView + +## -description +Retrieves the [CoreInputView](coreinputview.md) object associated with the current window. + +## -returns +The [CoreInputView](coreinputview.md) object associated with the current window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputview_occlusionschanged.md b/windows.ui.viewmanagement.core/coreinputview_occlusionschanged.md new file mode 100644 index 0000000000..0e1636c2cd --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputview_occlusionschanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.ViewManagement.Core.CoreInputView.OcclusionsChanged +-api-type: winrt event +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputView.OcclusionsChanged + +## -description +Occurs when one or more [CoreInputViewOcclusion](coreinputviewocclusion.md) objects change their position or occluding area. + +## -remarks + +## -see-also +- [CoreInputViewOcclusionsChangedEventArgs](coreinputviewocclusionschangedeventargs.md) + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputview_tryhideprimaryview_908065025.md b/windows.ui.viewmanagement.core/coreinputview_tryhideprimaryview_908065025.md new file mode 100644 index 0000000000..34facad80c --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputview_tryhideprimaryview_908065025.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.ViewManagement.Core.CoreInputView.TryHidePrimaryView +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputView.TryHidePrimaryView + +## -description +Tries to hide the [InputPane](inputpane.md), if it is visible. + +## -returns +**true** if the request to show the [CoreInputView](coreinputview.md) pane was accepted; otherwise **false**. + +If this method is called from an app that is not in foreground, the request is rejected and **false** is returned. + +## -remarks +If you set [CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/coretexteditcontext_inputpanedisplaypolicy.md) to **Manual** in your app, you are responsible for showing and hiding the input pane using [TryShowPrimaryView](coreinputview_tryshowprimaryview_1925215151.md) and [TryHidePrimaryView](coreinputview_tryhideprimaryview_908065025.md). + +## -see-also +- [TryShowPrimaryView](coreinputview_tryshowprimaryview_1925215151.md) + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputview_tryshowprimaryview_1925215151.md b/windows.ui.viewmanagement.core/coreinputview_tryshowprimaryview_1925215151.md new file mode 100644 index 0000000000..bbe4a4f408 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputview_tryshowprimaryview_1925215151.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.ViewManagement.Core.CoreInputView.TryShowPrimaryView +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputView.TryShowPrimaryView + +## -description +Tries to show the [CoreInputView](coreinputview.md) pane, if it is hidden. + +This method is a "best effort" and guarantees only that the user has a way to interact with the focused control. For a docked a Soft Input Panel (SIP) like the **Touch keyboard and handwriting panel**, the pane is shown only if a hardware keyboard is not available. + +## -returns +**true** if the request to show the [CoreInputView](coreinputview.md) pane was accepted; otherwise **false**. + +If this method is called from an app that is not in foreground, the request is rejected and **false** is returned. + +## -remarks +If you set [CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/coretexteditcontext_inputpanedisplaypolicy.md) to **Manual** in your app, you are responsible for showing and hiding the input pane using [TryShowPrimaryView](coreinputview_tryshowprimaryview_1925215151.md) and [TryHidePrimaryView](coreinputview_tryhideprimaryview_908065025.md). + +## -see-also +- [TryHidePrimaryView](coreinputview_tryhideprimaryview_908065025.md) + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusion.md b/windows.ui.viewmanagement.core/coreinputviewocclusion.md new file mode 100644 index 0000000000..52db5b5168 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusion.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.ViewManagement.Core.CoreInputViewOcclusion +-api-type: winrt class +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusion + +## -description +Represents a single [CoreInputView](coreinputview.md) pane currently occluding the app. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusion_occludingrect.md b/windows.ui.viewmanagement.core/coreinputviewocclusion_occludingrect.md new file mode 100644 index 0000000000..c7727365e4 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusion_occludingrect.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.ViewManagement.Core.CoreInputViewOcclusion.OccludingRect +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusion.OccludingRect + +## -description +Gets the bounding rect of the occluding input pane (and associated UI). + +## -property-value +The rectangle, in client coordinates, representing the region of the app window hidden behind the pane. Specified in device-independent pixel (DIP). + +A *top* value of "0" indicates that the app window is not obstructed by the pane. The pane might still be visible. + +A *height* value of "0", and *width* value equal to the width of the pane, indicates that the pane is floating, but not obstructing the app window. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusion_occlusionkind.md b/windows.ui.viewmanagement.core/coreinputviewocclusion_occlusionkind.md new file mode 100644 index 0000000000..d0543756da --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusion_occlusionkind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.ViewManagement.Core.CoreInputViewOcclusion.OcclusionKind +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusion.OcclusionKind + +## -description +The [CoreInputViewOcclusionKind](coreinputviewocclusionkind.md) of the occluding input pane (and associated UI). + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusionkind.md b/windows.ui.viewmanagement.core/coreinputviewocclusionkind.md new file mode 100644 index 0000000000..84234a5fbe --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusionkind.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.ViewManagement.Core.CoreInputViewOcclusionKind +-api-type: winrt enum +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusionKind + +## -description +Specifies the types of input panes supported by the [CoreInputViewOcclusion](coreoccludinginputview.md) object. + +## -enum-fields +### -field Docked:0 +Docked panes such as a Soft Input Panel (SIP) like the **Touch keyboard and handwriting panel**. + +### -field Floating:1 +Undocked panes such as a toolbar, or a Soft Input Panel (SIP) like the **Touch keyboard and handwriting panel**. + +### -field Overlay:2 +Floating panes such as an inline Ink or Input Method Editor (IME) candidate window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs.md b/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs.md new file mode 100644 index 0000000000..65c0b2f3b1 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.ViewManagement.Core.CoreInputViewOcclusionsChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusionsChangedEventArgs + +## -description +Contains event data for the [OcclusionsChanged](coreinputview_occlusionschanged.md) event. + +## -remarks +Occluding events can be handled by your app first. If your app doesn't handle the events, they bubble up to any framework that needs to handle the events. + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs_handled.md b/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs_handled.md new file mode 100644 index 0000000000..001424486f --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs_handled.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.ViewManagement.Core.CoreInputViewOcclusionsChangedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusionsChangedEventArgs.Handled + +## -description +Gets or sets a value that marks the event as handled. A **true** value for [Handled](coreinputviewocclusionschangedeventargs_handled.md) prevents most handlers along the event route from handling the same event again. + +## -property-value +**true** to mark the event handled. **false** to leave the event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**. + +## -remarks +Occluding events can be handled by your app first. If your app doesn't handle the events, they bubble up to any framework that needs to handle the events. + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs_occlusions.md b/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs_occlusions.md new file mode 100644 index 0000000000..12cc914090 --- /dev/null +++ b/windows.ui.viewmanagement.core/coreinputviewocclusionschangedeventargs_occlusions.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.ViewManagement.Core.CoreInputViewOcclusionsChangedEventArgs.Occlusions +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.Core.CoreInputViewOcclusionsChangedEventArgs.Occlusions + +## -description +Gets the collection of input panes (and associated UI) currently occluding the app. + +## -property-value +The [CoreInputViewOcclusion](coreinputviewocclusion.md) collection. + +## -remarks +Occluding events can be handled by your app first. If your app doesn't handle the events, they bubble up to any framework that needs to handle the events. + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement.core/windows_ui_viewmanagement_core.md b/windows.ui.viewmanagement.core/windows_ui_viewmanagement_core.md new file mode 100644 index 0000000000..2a97c0c241 --- /dev/null +++ b/windows.ui.viewmanagement.core/windows_ui_viewmanagement_core.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.UI.ViewManagement.Core +-api-type: winrt namespace +--- + + + +# Windows.UI.ViewManagement.Core + +## -description +Provides support for handling and managing [CoreInputView](coreinputview.md) objects associated with the active Universal Windows Platform (UWP) application. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/inputpane.md b/windows.ui.viewmanagement/inputpane.md index 3111a737b2..5291460978 100644 --- a/windows.ui.viewmanagement/inputpane.md +++ b/windows.ui.viewmanagement/inputpane.md @@ -10,11 +10,17 @@ public class InputPane : Windows.UI.ViewManagement.IInputPane, Windows.UI.ViewMa # Windows.UI.ViewManagement.InputPane ## -description -Enables an app to receive notifications when the input pane is about to be displayed or hidden, and to determine which portion of the application's window is obscured by the input pane. +Enables an app to receive notifications when the docked touch keyboard, or Soft Input Panel (SIP), is about to be displayed or hidden, and to determine which portion of the application's window is obscured by the input pane. + +> [!NOTE] +> The InputPane APIs provide accurate occlusion information for a docked panel only. For Windows 10 Creators Fall Update and newer, we reccomend using the following APIs to handle occlusion by docked, undocked, moveable, and transitory input panes such as Soft Input Panels (SIP), Input Method Editor (IME) candidate windows, floating toolbars, and so on. +> - [CoreInputView](..\windows.ui.viewmanagement.core\coreinputview.md) +> - [CoreInputViewOcclusion](..\windows.ui.viewmanagement.core\coreinputviewocclusion.md) +> - [CoreInputViewOcclusionKind](..\windows.ui.viewmanagement.core\coreinputviewocclusionkind.md) ## -remarks -The input pane appears when the user performs an action that requires them to enter information, such as selecting a text entry field. By default, Windows handles the input pane events and repositions content so that users can see where they are typing. If you set[CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/coretexteditcontext_inputpanedisplaypolicy.md) to **Manual** in your app, you are responsible for showing and hiding the input pane using TryShow and TryHide. Use this class to override the default behavior and customize the input pane. +The input pane appears when the user performs an action that requires them to enter information, such as selecting a text entry field. By default, Windows handles the input pane events and repositions content so that users can see where they are typing. If you set [CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/coretexteditcontext_inputpanedisplaypolicy.md) to **Manual** in your app, you are responsible for showing and hiding the input pane using TryShow and TryHide. Use this class to override the default behavior and customize the input pane. In some cases, overlay UI such as an [InputPane](inputpane.md) is not fully supported. This includes: diff --git a/windows.ui.viewmanagement/inputpane_hiding.md b/windows.ui.viewmanagement/inputpane_hiding.md index f317e5d2cc..dcc910c132 100644 --- a/windows.ui.viewmanagement/inputpane_hiding.md +++ b/windows.ui.viewmanagement/inputpane_hiding.md @@ -24,4 +24,5 @@ You should minimize the amount of work you do while the input pane is being hidd ## -examples ## -see-also -[InputPaneVisibilityEventArgs](inputpanevisibilityeventargs.md) \ No newline at end of file +- [InputPaneVisibilityEventArgs](inputpanevisibilityeventargs.md) +- [TryHide](inputpane_tryhide_42550069.md) \ No newline at end of file diff --git a/windows.ui.viewmanagement/inputpane_showing.md b/windows.ui.viewmanagement/inputpane_showing.md index 551b6c2765..3e297471f8 100644 --- a/windows.ui.viewmanagement/inputpane_showing.md +++ b/windows.ui.viewmanagement/inputpane_showing.md @@ -24,4 +24,5 @@ You should minimize the amount of work you do while the input pane is being show ## -examples ## -see-also -[InputPaneVisibilityEventArgs](inputpanevisibilityeventargs.md) \ No newline at end of file +- [InputPaneVisibilityEventArgs](inputpanevisibilityeventargs.md) +- [TryShow](inputpane_tryshow_1077566544.md) diff --git a/windows.ui.viewmanagement/inputpane_tryhide_42550069.md b/windows.ui.viewmanagement/inputpane_tryhide_42550069.md index cfbc06f61c..88eba7a570 100644 --- a/windows.ui.viewmanagement/inputpane_tryhide_42550069.md +++ b/windows.ui.viewmanagement/inputpane_tryhide_42550069.md @@ -10,10 +10,12 @@ public bool TryHide() # Windows.UI.ViewManagement.InputPane.TryHide ## -description -Hides the [InputPane](inputpane.md) if it is showing. +Tries to hide the [InputPane](inputpane.md), if it is visible. ## -returns -**true** if the [InputPane](inputpane.md) was hidden successfully; otherwise **false**. +**true** if the request to hide the [InputPane](inputpane.md) was accepted; otherwise **false**. + +If this method is called from an app that is not in foreground, the request is rejected and **false** is returned. ## -remarks @@ -22,3 +24,5 @@ If you set [CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/ ## -examples ## -see-also +- [TryShow](inputpane_tryshow_1077566544.md) +- [Hiding](inputpane_hiding.md) \ No newline at end of file diff --git a/windows.ui.viewmanagement/inputpane_tryshow_1077566544.md b/windows.ui.viewmanagement/inputpane_tryshow_1077566544.md index 40146e7956..db1cc6ab59 100644 --- a/windows.ui.viewmanagement/inputpane_tryshow_1077566544.md +++ b/windows.ui.viewmanagement/inputpane_tryshow_1077566544.md @@ -10,10 +10,14 @@ public bool TryShow() # Windows.UI.ViewManagement.InputPane.TryShow ## -description -Shows the [InputPane](inputpane.md) if it is hidden. +Tries to show the [InputPane](inputpane.md), if it is hidden. + +This method is a "best effort" and guarantees only that the user has a way to enter text in the focused control. The touch keyboard, or Soft Input Panel (SIP), is shown only if a hardware keyboard is not available. ## -returns -**true** if the [InputPane](inputpane.md) was shown successfully; otherwise **false**. +**true** if the request to show the [InputPane](inputpane.md) was accepted; otherwise **false**. + +If this method is called from an app that is not in foreground, the request is rejected and **false** is returned. ## -remarks @@ -22,3 +26,5 @@ If you set [CoreTextEditContext.InputPaneDisplayPolicy](../windows.ui.text.core/ ## -examples ## -see-also +[TryHide](inputpane_tryhide_42550069.md) +[Showing](inputpane_showing.md) \ No newline at end of file diff --git a/windows.ui.webui/webuiapplication_requestrestartasync_172604043.md b/windows.ui.webui/webuiapplication_requestrestartasync_172604043.md new file mode 100644 index 0000000000..0613ec034d --- /dev/null +++ b/windows.ui.webui/webuiapplication_requestrestartasync_172604043.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.WebUI.WebUIApplication.RequestRestartAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.WebUI.WebUIApplication.RequestRestartAsync + +## -description + +## -parameters +### -param launchArguments + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiapplication_requestrestartforuserasync_1889038893.md b/windows.ui.webui/webuiapplication_requestrestartforuserasync_1889038893.md new file mode 100644 index 0000000000..e4582df886 --- /dev/null +++ b/windows.ui.webui/webuiapplication_requestrestartforuserasync_1889038893.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.WebUI.WebUIApplication.RequestRestartForUserAsync(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.WebUI.WebUIApplication.RequestRestartForUserAsync + +## -description + +## -parameters +### -param user + +### -param launchArguments + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs.md b/windows.ui.webui/webuicommandlineactivatedeventargs.md new file mode 100644 index 0000000000..c2b270cc6f --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs_activatedoperation.md b/windows.ui.webui/webuicommandlineactivatedeventargs_activatedoperation.md new file mode 100644 index 0000000000..51eef0a502 --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs_activatedoperation.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.ActivatedOperation +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.ActivatedOperation + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs_kind.md b/windows.ui.webui/webuicommandlineactivatedeventargs_kind.md new file mode 100644 index 0000000000..a862b0c883 --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs_kind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.Kind + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs_operation.md b/windows.ui.webui/webuicommandlineactivatedeventargs_operation.md new file mode 100644 index 0000000000..71b5eec986 --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs_operation.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.Operation +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.Operation + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs_previousexecutionstate.md b/windows.ui.webui/webuicommandlineactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..63c9bafde2 --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.PreviousExecutionState + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs_splashscreen.md b/windows.ui.webui/webuicommandlineactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..b0c1922819 --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs_splashscreen.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.SplashScreen + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicommandlineactivatedeventargs_user.md b/windows.ui.webui/webuicommandlineactivatedeventargs_user.md new file mode 100644 index 0000000000..ba47914d7f --- /dev/null +++ b/windows.ui.webui/webuicommandlineactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUICommandLineActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuistartuptaskactivatedeventargs.md b/windows.ui.webui/webuistartuptaskactivatedeventargs.md new file mode 100644 index 0000000000..56a029626e --- /dev/null +++ b/windows.ui.webui/webuistartuptaskactivatedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuistartuptaskactivatedeventargs_kind.md b/windows.ui.webui/webuistartuptaskactivatedeventargs_kind.md new file mode 100644 index 0000000000..bf6c224784 --- /dev/null +++ b/windows.ui.webui/webuistartuptaskactivatedeventargs_kind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.Kind + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuistartuptaskactivatedeventargs_previousexecutionstate.md b/windows.ui.webui/webuistartuptaskactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..3ff4eededb --- /dev/null +++ b/windows.ui.webui/webuistartuptaskactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.PreviousExecutionState + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuistartuptaskactivatedeventargs_splashscreen.md b/windows.ui.webui/webuistartuptaskactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..69fc297ec1 --- /dev/null +++ b/windows.ui.webui/webuistartuptaskactivatedeventargs_splashscreen.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.SplashScreen + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuistartuptaskactivatedeventargs_taskid.md b/windows.ui.webui/webuistartuptaskactivatedeventargs_taskid.md new file mode 100644 index 0000000000..e5a4f9f986 --- /dev/null +++ b/windows.ui.webui/webuistartuptaskactivatedeventargs_taskid.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.TaskId +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.TaskId + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuistartuptaskactivatedeventargs_user.md b/windows.ui.webui/webuistartuptaskactivatedeventargs_user.md new file mode 100644 index 0000000000..1c653c04f7 --- /dev/null +++ b/windows.ui.webui/webuistartuptaskactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIStartupTaskActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/automationnotificationkind.md b/windows.ui.xaml.automation.peers/automationnotificationkind.md new file mode 100644 index 0000000000..189af8af4c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationnotificationkind.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.AutomationNotificationKind +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationNotificationKind + +## -description +Indicates the type of notification when calling [RaiseNotificationEvent](automationpeer_raisenotificationevent_1452378292.md) + +## -enum-fields +### -field ItemAdded:0 +The current element container has had something added to it that should be presented to the user. + +### -field ItemRemoved:1 +The current element has had something removed from inside it that should be presented to the user. + +### -field ActionCompleted:2 +The current element has a notification that an action was completed. + +### -field ActionAborted:3 +The current element has a notification that an action was abandoned. + +### -field Other:4 +The current element has a notification not an add, remove, completed, or aborted action. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.automation.peers/automationnotificationprocessing.md b/windows.ui.xaml.automation.peers/automationnotificationprocessing.md new file mode 100644 index 0000000000..aff9a949e8 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationnotificationprocessing.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.AutomationNotificationProcessing +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationNotificationProcessing + +## -description +Specifies the order in which to process a notification. + +## -enum-fields +### -field ImportantAll:0 +These notifications should be presented to the user as soon as possible. All of the notifications from this source should be delivered to the user. + +> [!WARNING] +> Use this in a limited capacity as this style of message could cause a flooding for information to the end user due to the nature of the request to deliver all of the notifications. + +### -field ImportantMostRecent:1 +These notifications should be presented to the user as soon as possible. The most recent notifications from this source should be delivered to the user because the most recent notification supersedes all of the other notifications. + +### -field All:2 +These notifications should be presented to the user when possible. All of the notifications from this source should be delivered to the user. + +### -field MostRecent:3 +These notifications should be presented to the user when possible. Interrupt the current notification for this one. + +### -field CurrentThenMostRecent:4 +These notifications should be presented to the user when possible. Don’t interrupt the current notification for this one. If new notifications come in from the same source while the current notification is being presented, then keep the most recent and ignore the rest until the current processing is completed. Then use the most recent message as the current message. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/automationpeer_raisenotificationevent_1452378292.md b/windows.ui.xaml.automation.peers/automationpeer_raisenotificationevent_1452378292.md new file mode 100644 index 0000000000..2e37bf8c85 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_raisenotificationevent_1452378292.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseNotificationEvent(Windows.UI.Xaml.Automation.Peers.AutomationNotificationKind,Windows.UI.Xaml.Automation.Peers.AutomationNotificationProcessing,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseNotificationEvent + +## -description +Initiates a notification event. + +## -parameters +### -param notificationKind +Specifies the type of the notification. + +### -param notificationProcessing +Specifies the order in which to process the notification. + +### -param displayString +A display string describing the event. + +### -param activityId +A GUID that identifies the activity. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/colorpickersliderautomationpeer.md b/windows.ui.xaml.automation.peers/colorpickersliderautomationpeer.md new file mode 100644 index 0000000000..f4b96b44f2 --- /dev/null +++ b/windows.ui.xaml.automation.peers/colorpickersliderautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.ColorPickerSliderAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.ColorPickerSliderAutomationPeer + +## -description +Exposes **[ColorPickerSlider](../windows.ui.xaml.controls.primitives/colorpickerslider.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/colorpickersliderautomationpeer_colorpickersliderautomationpeer_2133038225.md b/windows.ui.xaml.automation.peers/colorpickersliderautomationpeer_colorpickersliderautomationpeer_2133038225.md new file mode 100644 index 0000000000..6a14576e55 --- /dev/null +++ b/windows.ui.xaml.automation.peers/colorpickersliderautomationpeer_colorpickersliderautomationpeer_2133038225.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.ColorPickerSliderAutomationPeer.#ctor(Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.ColorPickerSliderAutomationPeer.ColorPickerSliderAutomationPeer + +## -description +Initializes a new instance of the **ColorPickerSliderAutomationPeer** class. + +## -parameters +### -param owner +The **[ColorPickerSlider](../windows.ui.xaml.controls.primitives/colorpickerslider.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/colorspectrumautomationpeer.md b/windows.ui.xaml.automation.peers/colorspectrumautomationpeer.md new file mode 100644 index 0000000000..09c290dd0b --- /dev/null +++ b/windows.ui.xaml.automation.peers/colorspectrumautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.ColorSpectrumAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.ColorSpectrumAutomationPeer + +## -description +Exposes **[ColorSpectrum](../windows.ui.xaml.controls.primitives/colorspectrum.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/colorspectrumautomationpeer_colorspectrumautomationpeer_2048086689.md b/windows.ui.xaml.automation.peers/colorspectrumautomationpeer_colorspectrumautomationpeer_2048086689.md new file mode 100644 index 0000000000..af1c103884 --- /dev/null +++ b/windows.ui.xaml.automation.peers/colorspectrumautomationpeer_colorspectrumautomationpeer_2048086689.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.ColorSpectrumAutomationPeer.#ctor(Windows.UI.Xaml.Controls.Primitives.ColorSpectrum) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.ColorSpectrumAutomationPeer.ColorSpectrumAutomationPeer + +## -description +Initializes a new instance of the **ColorSpectrumAutomationPeer** class. + +## -parameters +### -param owner +The **[ColorSpectrum](../windows.ui.xaml.controls.primitives/colorspectrum.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/navigationviewitemautomationpeer.md b/windows.ui.xaml.automation.peers/navigationviewitemautomationpeer.md new file mode 100644 index 0000000000..b8d6ced160 --- /dev/null +++ b/windows.ui.xaml.automation.peers/navigationviewitemautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.NavigationViewItemAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.NavigationViewItemAutomationPeer + +## -description +Exposes **[NavigationViewItem](../windows.ui.xaml.controls/navigationviewitem.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/navigationviewitemautomationpeer_navigationviewitemautomationpeer_1227129675.md b/windows.ui.xaml.automation.peers/navigationviewitemautomationpeer_navigationviewitemautomationpeer_1227129675.md new file mode 100644 index 0000000000..52938e5e69 --- /dev/null +++ b/windows.ui.xaml.automation.peers/navigationviewitemautomationpeer_navigationviewitemautomationpeer_1227129675.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.NavigationViewItemAutomationPeer.#ctor(Windows.UI.Xaml.Controls.NavigationViewItem) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.NavigationViewItemAutomationPeer.NavigationViewItemAutomationPeer + +## -description +Initializes a new instance of the **NavigationViewItemAutomationPeer** class. + +## -parameters +### -param owner +The **[NavigationViewItem](../windows.ui.xaml.controls/navigationviewitem.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/personpictureautomationpeer.md b/windows.ui.xaml.automation.peers/personpictureautomationpeer.md new file mode 100644 index 0000000000..ed0e93adc9 --- /dev/null +++ b/windows.ui.xaml.automation.peers/personpictureautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.PersonPictureAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.PersonPictureAutomationPeer + +## -description +Exposes **[PersonPicture](../windows.ui.xaml.controls/personpicture.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/personpictureautomationpeer_personpictureautomationpeer_1121885410.md b/windows.ui.xaml.automation.peers/personpictureautomationpeer_personpictureautomationpeer_1121885410.md new file mode 100644 index 0000000000..94f7595b47 --- /dev/null +++ b/windows.ui.xaml.automation.peers/personpictureautomationpeer_personpictureautomationpeer_1121885410.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.PersonPictureAutomationPeer.#ctor(Windows.UI.Xaml.Controls.PersonPicture) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.PersonPictureAutomationPeer.PersonPictureAutomationPeer + +## -description +Initializes a new instance of the **PersonPictureAutomationPeer** class. + +## -parameters +### -param owner +The **[PersonPicture](../windows.ui.xaml.controls/personpicture.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/ratingcontrolautomationpeer.md b/windows.ui.xaml.automation.peers/ratingcontrolautomationpeer.md new file mode 100644 index 0000000000..7d842f96fd --- /dev/null +++ b/windows.ui.xaml.automation.peers/ratingcontrolautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.RatingControlAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.RatingControlAutomationPeer + +## -description +Exposes **[RatingControl](../windows.ui.xaml.controls/ratingcontrol.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/ratingcontrolautomationpeer_ratingcontrolautomationpeer_40962199.md b/windows.ui.xaml.automation.peers/ratingcontrolautomationpeer_ratingcontrolautomationpeer_40962199.md new file mode 100644 index 0000000000..37fbe29e65 --- /dev/null +++ b/windows.ui.xaml.automation.peers/ratingcontrolautomationpeer_ratingcontrolautomationpeer_40962199.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.RatingControlAutomationPeer.#ctor(Windows.UI.Xaml.Controls.RatingControl) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.RatingControlAutomationPeer.RatingControlAutomationPeer + +## -description +Initializes a new instance of the **RatingControlAutomationPeer** class. + +## -parameters +### -param owner +The **[RatingControl](../windows.ui.xaml.controls/ratingcontrol.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/treeviewitemautomationpeer.md b/windows.ui.xaml.automation.peers/treeviewitemautomationpeer.md new file mode 100644 index 0000000000..497c10b845 --- /dev/null +++ b/windows.ui.xaml.automation.peers/treeviewitemautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.TreeViewItemAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.TreeViewItemAutomationPeer + +## -description +Exposes **[TreeViewItem](../windows.ui.xaml.controls/treeviewitem.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/treeviewitemautomationpeer_treeviewitemautomationpeer_1987001131.md b/windows.ui.xaml.automation.peers/treeviewitemautomationpeer_treeviewitemautomationpeer_1987001131.md new file mode 100644 index 0000000000..7cc9e37647 --- /dev/null +++ b/windows.ui.xaml.automation.peers/treeviewitemautomationpeer_treeviewitemautomationpeer_1987001131.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.TreeViewItemAutomationPeer.#ctor(Windows.UI.Xaml.Controls.TreeViewItem) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.TreeViewItemAutomationPeer.TreeViewItemAutomationPeer + +## -description +Initializes a new instance of the **TreeViewItemAutomationPeer** class. + +## -parameters +### -param owner +The **[TreeViewItem](../windows.ui.xaml.controls/treeviewitem.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/treeviewlistautomationpeer.md b/windows.ui.xaml.automation.peers/treeviewlistautomationpeer.md new file mode 100644 index 0000000000..17c8ef62af --- /dev/null +++ b/windows.ui.xaml.automation.peers/treeviewlistautomationpeer.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.TreeViewListAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.TreeViewListAutomationPeer + +## -description +Exposes **[TreeViewList](../windows.ui.xaml.controls/treeviewlist.md)** types to Microsoft UI Automation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/treeviewlistautomationpeer_treeviewlistautomationpeer_958065987.md b/windows.ui.xaml.automation.peers/treeviewlistautomationpeer_treeviewlistautomationpeer_958065987.md new file mode 100644 index 0000000000..e76df53b30 --- /dev/null +++ b/windows.ui.xaml.automation.peers/treeviewlistautomationpeer_treeviewlistautomationpeer_958065987.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.TreeViewListAutomationPeer.#ctor(Windows.UI.Xaml.Controls.TreeViewList) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.TreeViewListAutomationPeer.TreeViewListAutomationPeer + +## -description +Initializes a new instance of the **TreeViewListAutomationPeer** class. + +## -parameters +### -param owner +The **[TreeViewList](../windows.ui.xaml.controls/treeviewlist.md)** control instance to create the peer for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md b/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md index f3db450274..6f68d73fed 100644 --- a/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md +++ b/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md @@ -11,8 +11,8 @@ public void MapControl.GetLocationFromOffset(Point offset, AltitudeReferenceSyst ## -description Converts a point on the map to a geographic location by using the specified altitude reference system. - -__Note__: Map controls do not support the Geoid altitude reference system. +> [!NOTE] +This method is deprecated. Use the [TryGetLocationFromOffset](mapcontrol_trygetlocationfromoffset_418557555.md) method instead. ## -params @@ -20,7 +20,7 @@ __Note__: Map controls do not support the Geoid altitude reference system. A point on the map to convert to a geographic location. ## -param desiredReferenceSystem -The altitude reference system of the geographic point. Map controls do not support the Geoid altitude reference system. A value of **Unspecified** for the altitude reference system has the same effect as using the default [GetLocationFromOffset(Windows.Foundation.Point offset, Windows.Devices.Geolocation.Geopoint location)](mapcontrol_getlocationfromoffset_1345615754.md) overload. +The altitude reference system of the geographic point. A value of **Unspecified** for the altitude reference system has the same effect as using the default [GetLocationFromOffset(Windows.Foundation.Point offset, Windows.Devices.Geolocation.Geopoint location)](mapcontrol_getlocationfromoffset_1345615754.md) overload. ## -param location When this method returns, contains the corresponding geographic location. @@ -30,7 +30,7 @@ This method provides an instance of a [Geopoint](../windows.devices.geolocation/ This method will throw an exception if the point is invalid. > [!NOTE] -> An [AltitudeReferenceSystem](../windows.devices.geolocation/altitudereferencesystem.md) of **Geoid** and **Ellipsoid** might not be supported. +> An [AltitudeReferenceSystem](../windows.devices.geolocation/altitudereferencesystem.md) of **Ellipsoid** might not be supported. ## -see-also [Display maps with 2D, 3D, and Streetside views](http://msdn.microsoft.com/library/3839e00b-2c1e-4627-a45f-6dda98d7077f). diff --git a/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1345615754.md b/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1345615754.md index 71a666e82b..71e55acd90 100644 --- a/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1345615754.md +++ b/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1345615754.md @@ -11,6 +11,8 @@ public void GetLocationFromOffset(Windows.Foundation.Point offset, Windows.Devic ## -description Converts a point on the map to a geographic location. +> [!NOTE] +This method is deprecated. Use the [TryGetLocationFromOffset](mapcontrol_trygetlocationfromoffset_77980665.md) method instead. ## -parameters ### -param offset @@ -22,6 +24,7 @@ When this method returns, contains the corresponding geographic location. ## -remarks This method will throw an exception if the point is invalid. + ## -examples ## -see-also diff --git a/windows.ui.xaml.controls.maps/mapcontrol_layers.md b/windows.ui.xaml.controls.maps/mapcontrol_layers.md new file mode 100644 index 0000000000..8dc7f78d8b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_layers.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.Layers +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.Layers + +## -description +Gets the collection of [MapLayer](maplayer.md) objects that are children of the [MapControl](mapcontrol.md). + +## -property-value +The collection of [MapLayer](maplayer.md) objects that are children of the [MapControl](mapcontrol.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_layersproperty.md b/windows.ui.xaml.controls.maps/mapcontrol_layersproperty.md new file mode 100644 index 0000000000..dd8ce0ac7a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_layersproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.LayersProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.LayersProperty + +## -description +Identifies the [Layers](mapcontrol_layers.md) dependency property. + +## -property-value +The [Layers](mapcontrol_layers.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_mapelements.md b/windows.ui.xaml.controls.maps/mapcontrol_mapelements.md index 5abd9c549f..dbbf3d2031 100644 --- a/windows.ui.xaml.controls.maps/mapcontrol_mapelements.md +++ b/windows.ui.xaml.controls.maps/mapcontrol_mapelements.md @@ -16,6 +16,9 @@ Gets the collection of [MapElement](mapelement.md) objects that are children of The collection of [MapElement](mapelement.md) objects that are children of the [MapControl](mapcontrol.md). ## -remarks +>[!Note] +In the Windows 10 Fall Creators Update, we recommend that you add [MapElement](mapelement.md) objects to a [MapElementsLayer](mapelementslayer.md) instead of adding them to the [MapElements](mapcontrol_mapelements.md) collection. + Display pushpins, images, and shapes on the [MapControl](mapcontrol.md) by adding them to its [MapElements](mapcontrol_mapelements.md) collection. @@ -28,4 +31,4 @@ For more info, see [Display maps with 2D, 3D, and Streetside views](http://msdn. ## -examples ## -see-also -[Display maps with 2D, 3D, and Streetside views](http://msdn.microsoft.com/library/3839e00b-2c1e-4627-a45f-6dda98d7077f) \ No newline at end of file +[Display maps with 2D, 3D, and Streetside views](http://msdn.microsoft.com/library/3839e00b-2c1e-4627-a45f-6dda98d7077f) diff --git a/windows.ui.xaml.controls.maps/mapcontrol_trygetlocationfromoffset_418557555.md b/windows.ui.xaml.controls.maps/mapcontrol_trygetlocationfromoffset_418557555.md new file mode 100644 index 0000000000..7e5367f263 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_trygetlocationfromoffset_418557555.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.TryGetLocationFromOffset(Windows.Foundation.Point,Windows.Devices.Geolocation.AltitudeReferenceSystem,Windows.Devices.Geolocation.Geopoint@) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.TryGetLocationFromOffset + +## -description +Converts a point on the map to a geographic location by using the specified altitude reference system. + +## -params + +## -param offset +A point on the map to convert to a geographic location. + +## -param desiredReferenceSystem +The altitude reference system of the geographic point. A value of **Unspecified** for the altitude reference system has the same effect as using the default [TryGetLocationFromOffset(Windows.Foundation.Point offset, Windows.Devices.Geolocation.Geopoint location)](mapcontrol_trygetlocationfromoffset_77980665.md) overload. + +## -param location +When this method returns, contains the corresponding geographic location. + +## -returns +Returns **true** if the location is invalid; otherwise, **false**. + +## -remarks +Use this method instead of the [GetLocationFromOffset](mapcontrol_getlocationfromoffset_1281571330.md) method. The [GetLocationFromOffset](mapcontrol_getlocationfromoffset_1281571330.md) method has been deprecated. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_trygetlocationfromoffset_77980665.md b/windows.ui.xaml.controls.maps/mapcontrol_trygetlocationfromoffset_77980665.md new file mode 100644 index 0000000000..b0618e57d1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_trygetlocationfromoffset_77980665.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.TryGetLocationFromOffset(Windows.Foundation.Point,Windows.Devices.Geolocation.Geopoint@) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.TryGetLocationFromOffset + +## -description +Converts a point on the map to a geographic location. + +## -parameters +### -param offset +A point on the map to convert to a geographic location. + +### -param location +When this method returns, contains the corresponding geographic location. + +## -returns +Returns **true** if the location is invalid; otherwise, **false**. + +## -remarks +Use this method instead of the [GetLocationFromOffset](mapcontrol_getlocationfromoffset_1345615754.md) method. The [GetLocationFromOffset](mapcontrol_getlocationfromoffset_1345615754.md) method has been deprecated. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontroldatahelper_createmapcontrol_1579381210.md b/windows.ui.xaml.controls.maps/mapcontroldatahelper_createmapcontrol_1579381210.md new file mode 100644 index 0000000000..434fc5e821 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontroldatahelper_createmapcontrol_1579381210.md @@ -0,0 +1,57 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControlDataHelper.CreateMapControl(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControlDataHelper.CreateMapControl + +## -description +Creates a [MapControl](mapcontrol.md) in raster-mode. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about this API and the [Windows.Services.Maps.LocalSearch](../windows.services.maps.localsearch/windows_services_maps_localsearch.md) namespace, please work with your Microsoft Account Team representative. + +## -parameters +### -param rasterRenderMode +Specifies whether to create the [MapControl](mapcontrol.md) in raster-mode. + +## -returns +A [MapControl](mapcontrol.md) + +## -remarks +If you create a [MapControl](mapcontrol.md) in raster-mode, you can't change the map control into vector mode. + +## -see-also + +## -examples + +This example creates a [MapControl](mapcontrol.md) in raster-mode. + +```csharp +public void AddMapControl() +{ + var map = MapControlDataHelper.CreateMapControl(true); + + // Configure the map control and register for events + map.Center = new Geopoint(new BasicGeoposition() + { + Latitude = 47.604, + Longitude = -122.329 + }); + map.ZoomLevel = 12; + + map.PanInteractionMode = MapPanInteractionMode.Disabled; + map.RotateInteractionMode = MapInteractionMode.Disabled; + map.TiltInteractionMode = MapInteractionMode.Disabled; + map.ZoomInteractionMode = MapInteractionMode.Disabled; + + map.MapContextRequested += MapControl_MapContextRequested; + + MyParentGrid.Children.Add(map); +} + +``` diff --git a/windows.ui.xaml.controls.maps/mapelement3d.md b/windows.ui.xaml.controls.maps/mapelement3d.md new file mode 100644 index 0000000000..de68181647 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d.md @@ -0,0 +1,40 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapElement3D +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D + +## -description +Represents a 3D element displayed on a [MapControl](mapcontrol.md). + +## -remarks +To display the 3D object on a map control, add the [MapElement3D](mapelement3d.md) to the [MapElements](mapelementslayer_mapelements.md) collection of a [MapElementsLayer](mapelementslayer.md). Then, add the [MapElementsLayer](mapelementslayer.md) to the [Layers](mapcontrol_layers.md) collection of the map. + +## -see-also + +## -examples + +This example places a 3D element on the center of the map. + +```cs +map3dSphereStreamReference = RandomAccessStreamReference.CreateFromUri + (new Uri("ms-appx:///Assets/trainengine.3mf")); + + var myModel = await MapModel3D.CreateFrom3MFAsync(map3dSphereStreamReference, + MapModel3DShadingOption.Smooth); + + var my3DElement = new MapElement3D(); + my3DElement.Location = myMap.Center; + my3DElement.Model = myModel; + + var myLayer = new MapElementsLayer(); + myLayer.MapElements.Add(my3DElement); + + myMap.Layers.Add(myLayer); + +``` diff --git a/windows.ui.xaml.controls.maps/mapelement3d_heading.md b/windows.ui.xaml.controls.maps/mapelement3d_heading.md new file mode 100644 index 0000000000..c2553e7b6d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_heading.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.Heading +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.Heading + +## -description +Gets or sets the directional heading of the 3D map element in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. + +## -property-value +The directional heading of the map in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default value is 0. + +## -remarks +Heading values greater than 360 degrees are normalized to their equivalent 0-360 degree value. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_headingproperty.md b/windows.ui.xaml.controls.maps/mapelement3d_headingproperty.md new file mode 100644 index 0000000000..d02c1c8bed --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_headingproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.HeadingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.HeadingProperty + +## -description +Identifies the [Heading](mapelement3d_heading.md) dependency property. + +## -property-value +The [Heading](mapelement3d_heading.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_location.md b/windows.ui.xaml.controls.maps/mapelement3d_location.md new file mode 100644 index 0000000000..12311ff406 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_location.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.Location + +## -description +Gets or sets the geographic location of the [MapElement3D](mapelement3d.md) on the [MapControl](mapcontrol.md). . + +## -property-value +The geographic location of the [MapElement3D](mapelement3d.md) on the [MapControl](mapcontrol.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_locationproperty.md b/windows.ui.xaml.controls.maps/mapelement3d_locationproperty.md new file mode 100644 index 0000000000..dc120c7be0 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_locationproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.LocationProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.LocationProperty + +## -description +Identifies the [LocationProperty](mapelement3d_location.md) dependency property. + +## -property-value +The [LocationProperty](mapelement3d_location.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_mapelement3d_1221375020.md b/windows.ui.xaml.controls.maps/mapelement3d_mapelement3d_1221375020.md new file mode 100644 index 0000000000..3e08fd1e6d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_mapelement3d_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapElement3D.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.MapElement3D + +## -description +Creates a [MapElement3D](mapelement3d.md) instance. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_model.md b/windows.ui.xaml.controls.maps/mapelement3d_model.md new file mode 100644 index 0000000000..0f48de12a2 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_model.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.Model +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.Model + +## -description +Gets or sets the 3D model that represents a 3D object. + +## -property-value +the 3D model that represents a 3D object. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_pitch.md b/windows.ui.xaml.controls.maps/mapelement3d_pitch.md new file mode 100644 index 0000000000..3651baed4e --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_pitch.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.Pitch +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.Pitch + +## -description +Gets or sets a value that indicates by how many degrees you want the 3D map element to be tilted. A value of 0 is looking out at the horizon and a value of -90 is looking straight down. A value of 90 is looking straight up. The default value is 0. + +## -property-value +A value that indicates by how many degrees you want the 3D map element to be tilted. + +## -remarks + + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_pitchproperty.md b/windows.ui.xaml.controls.maps/mapelement3d_pitchproperty.md new file mode 100644 index 0000000000..2583d649ce --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_pitchproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.PitchProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.PitchProperty + +## -description +Identifies the [Pitch](mapelement3d_pitch.md) dependency property. + +## -property-value +The [Pitch](mapelement3d_pitch.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_roll.md b/windows.ui.xaml.controls.maps/mapelement3d_roll.md new file mode 100644 index 0000000000..6208dea294 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_roll.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.Roll +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.Roll + +## -description +Gets or sets the roll of the 3D map element in degrees, where -90 is tilting to the left and +90 is tilting to the right. + +## -property-value +The roll of the 3D map element in degrees, where -90 is tilting to the left and +90 is tilting to the right. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_rollproperty.md b/windows.ui.xaml.controls.maps/mapelement3d_rollproperty.md new file mode 100644 index 0000000000..5b6c32cb3b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_rollproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.RollProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.RollProperty + +## -description +Identifies the [Pitch](mapelement3d_pitch.md) dependency property. + +## -property-value +The [Pitch](mapelement3d_pitch.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_scale.md b/windows.ui.xaml.controls.maps/mapelement3d_scale.md new file mode 100644 index 0000000000..19c599c770 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_scale.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.Scale +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.Scale + +## -description +The scale to apply to the 3D map element. + +## -property-value +The scale to apply to the 3D map element. A value of Vector3 (1.0,1.0,1.0) is equivalent to 100%. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement3d_scaleproperty.md b/windows.ui.xaml.controls.maps/mapelement3d_scaleproperty.md new file mode 100644 index 0000000000..18a76af1e0 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement3d_scaleproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement3D.ScaleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement3D.ScaleProperty + +## -description +Identifies the [Roll](mapelement3d_roll.md) dependency property. + +## -property-value +The [Roll](mapelement3d_roll.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentry.md b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentry.md new file mode 100644 index 0000000000..f0159e2d4d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentry.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntry +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntry + +## -description +Gets or sets the name of a JavaScript Object Notation (JSON) entry in the map's style sheet. If the style sheet defines a style for that entry, that style is applied to this element. + +## -property-value +The name of a JavaScript Object Notation (JSON) entry in the map's style sheet. If the style sheet defines a style for that entry, that style is applied to this element. + +## -remarks +Set this property to a string or to any of the property values available in the [MapStyleSheetEntries](mapstylesheetentries.md) class. + +To learn more about entries in a map style sheet, see [Map style sheet reference](https://docs.microsoft.com/windows/uwp/maps-and-location/elements-of-map-style-sheet#version). + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentryproperty.md b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentryproperty.md new file mode 100644 index 0000000000..1bc69bd7cb --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentryproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntryProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntryProperty + +## -description +Identifies for the [MapStyleSheetEntry](mapelement_mapstylesheetentry.md) dependency property. + +## -property-value +Identifier for the [MapStyleSheetEntry](mapelement_mapstylesheetentry.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentrystate.md b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentrystate.md new file mode 100644 index 0000000000..2e93eae852 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentrystate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntryState +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntryState + +## -description +Gets or sets the name of entry state of this [MapElement](mapelement.md). If the style sheet defines a style for that state, that style is applied to this element. + +## -property-value +The name of the entry state of this [MapElement](mapelement.md). If the style sheet defines a style for that state, that style is applied to this element. + +## -remarks +Set this property to a string or to any of the property values available in the [MapStyleSheetEntryStates](mapstylesheetentrystates.md) class. + +To learn more about entries in a map style sheet, see [Map style sheet reference](https://docs.microsoft.com/windows/uwp/maps-and-location/elements-of-map-style-sheet#version). + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentrystateproperty.md b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentrystateproperty.md new file mode 100644 index 0000000000..56717a74bb --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement_mapstylesheetentrystateproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntryStateProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement.MapStyleSheetEntryStateProperty + +## -description +Identifies for the [MapStyleSheetEntryState](mapelement_mapstylesheetentrystate.md) dependency property. + +## -property-value +Identifier for the [MapStyleSheetEntryState](mapelement_mapstylesheetentrystate.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement_tag.md b/windows.ui.xaml.controls.maps/mapelement_tag.md new file mode 100644 index 0000000000..5985414348 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement_tag.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement.Tag +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement.Tag + +## -description +Gets or sets an arbitrary object value that can be used to store custom information about this object. + +## -property-value +An arbitrary object value that can be used to store custom information about this object. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelement_tagproperty.md b/windows.ui.xaml.controls.maps/mapelement_tagproperty.md new file mode 100644 index 0000000000..353d5fbfac --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelement_tagproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElement.TagProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElement.TagProperty + +## -description +Identifies the [Tag](mapelement_tag.md) dependency property. + +## -property-value +The [Tag](mapelement_tag.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer.md b/windows.ui.xaml.controls.maps/mapelementslayer.md new file mode 100644 index 0000000000..4bd5064875 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapElementsLayer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer + +## -description +Represents a collection of map elements to which you can bind data and manipulate independently of other map elements. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapcontextrequested.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapcontextrequested.md new file mode 100644 index 0000000000..dc903c8741 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapcontextrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapContextRequested +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapContextRequested + +## -description +Occurs when the user has completed a context input gesture on a map layer, such as a right-click. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapelementclick.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementclick.md new file mode 100644 index 0000000000..8bf7d04f73 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementclick.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementClick +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementClick + +## -description +Occurs when the user taps or clicks a [MapElement](mapelement.md) that has been add to the [MapElementsLayer](mapelementslayer.md). + +## -remarks +Touch, mouse, and pen/stylus interactions are received, processed, and managed as pointers. Any of these devices and their interactions can produce a [MapElementsClick](mapelementslayer_mapelementclick.md) event. An instance of [MapElementsLayerClickEventArgs](mapelementslayerclickeventargs_mapelementslayerclickeventargs_1221375020.md) provides data for this event. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapelementpointerentered.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementpointerentered.md new file mode 100644 index 0000000000..2c00461108 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementpointerentered.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementPointerEntered +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementPointerEntered + +## -description +Occurs when a pointer moves into the bounding area of a [MapElement](mapelement.md) on a [MapElementsLayer](mapelementslayer.md). + +## -remarks +Mouse interactions are received, processed, and managed as pointers. The [MapElementPointerEntered](mapelementslayer_mapelementpointerentered.md) event is triggered as the user moves their mouse over an element. An instance of [MapElementsLayerPointerEnteredEventArgs](mapelementslayerpointerenteredeventargs_mapelementslayerpointerenteredeventargs_1221375020.md) provides data for this event. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapelementpointerexited.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementpointerexited.md new file mode 100644 index 0000000000..c992e206c7 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementpointerexited.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementPointerExited +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementPointerExited + +## -description +Occurs when a pointer moves out of the bounding area of a [MapElement](mapelement.md) on a [MapElementsLayer](mapelementslayer.md). + +## -remarks +Mouse interactions are received, processed, and managed as pointers. The [MapElementPointerExited](mapelementslayer_mapelementpointerexited.md) event is triggered as the user moves their mouse out from over an element. An instance of [MapElementsLayerPointerExitedEventArgs](mapelementslayerpointerexitedeventargs_mapelementslayerpointerexitedeventargs_1221375020.md) provides data for this event. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapelements.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapelements.md new file mode 100644 index 0000000000..da953bb090 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapelements.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElements +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElements + +## -description +Gets the collection of [MapElement](mapelement.md) objects that are children of the [MapElementsLayer](mapelementslayer.md). + +## -property-value +The collection of [MapElement](mapelement.md) objects that are children of the [MapElementsLayer](mapelementslayer.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapelementslayer_1221375020.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementslayer_1221375020.md new file mode 100644 index 0000000000..c53adee40f --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementslayer_1221375020.md @@ -0,0 +1,18 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementsLayer + +## -description +Creates a [MapElementsLayer](mapelementslayer.md) instance. +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayer_mapelementsproperty.md b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementsproperty.md new file mode 100644 index 0000000000..303efd5b1e --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayer_mapelementsproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayer.MapElementsProperty + +## -description +Identifies the [MapElements](mapelementslayer_mapelements.md) dependency property. + +## -property-value +The [MapElements](mapelementslayer_mapelements.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs.md b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs.md new file mode 100644 index 0000000000..cf63477eb5 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs + +## -description +Provides data for the [MapElementClick](mapelementslayer_mapelementclick.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_location.md b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_location.md new file mode 100644 index 0000000000..3c8afd4501 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_location.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.Location + +## -description +Gets the geographic location that corresponds to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -property-value +The geographic location that corresponds to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_mapelements.md b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_mapelements.md new file mode 100644 index 0000000000..6e7d3f73da --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_mapelements.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.MapElements +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.MapElements + +## -description +Gets a list of map elements that correspond to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -property-value +A list of map elements that correspond to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_mapelementslayerclickeventargs_1221375020.md b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_mapelementslayerclickeventargs_1221375020.md new file mode 100644 index 0000000000..48b03c5b9a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_mapelementslayerclickeventargs_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.MapElementsLayerClickEventArgs + +## -description +Initializes a new instance of the [MapElementsLayerClickEventArgs](mapelementslayerclickeventargs.md) class. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_position.md b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_position.md new file mode 100644 index 0000000000..60c9ca5e75 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerclickeventargs_position.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerClickEventArgs.Position + +## -description +Gets the physical position on the [MapElementsLayer](mapelementslayer.md) where it received user input. + +## -property-value +The physical position on the [MapElementsLayer](mapelementslayer.md) where it received user input, in terms of X and Y coordinates. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs.md b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs.md new file mode 100644 index 0000000000..1d98fd1d67 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs + +## -description +Provides event data for the [MapContextRequested](mapelementslayer_mapcontextrequested.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_location.md b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_location.md new file mode 100644 index 0000000000..6e6fefd66e --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_location.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.Location + +## -description +Gets a geolocation on the map layer of a context input gesture, such as a right-click. + +## -property-value +The geolocation on the map layer of a context input gesture, such as a right-click. + +## -remarks +To get the x- and y-coordinate values that define the point on the map layer of a context input gesture, use the [Position](mapelementslayercontextrequestedeventargs_position.md) property. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_mapelements.md b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_mapelements.md new file mode 100644 index 0000000000..577967629d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_mapelements.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.MapElements +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.MapElements + +## -description +Gets a collection of [MapElement](mapcontrol_mapelements.md) objects at the point on the map layer specified by the [Location](mapelementslayercontextrequestedeventargs_location.md) property. + +## -property-value +A collection of [MapElement](mapcontrol_mapelements.md) objects at the point on the map layer specified by the [Location](mapelementslayercontextrequestedeventargs_location.md) property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_mapelementslayercontextrequestedeventargs_1221375020.md b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_mapelementslayercontextrequestedeventargs_1221375020.md new file mode 100644 index 0000000000..82ab360edf --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_mapelementslayercontextrequestedeventargs_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.MapElementsLayerContextRequestedEventArgs + +## -description +Initializes a new instance of the [MapElementsLayerContextRequestedEventArgs](mapelementslayercontextrequestedeventargs.md) class. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_position.md b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_position.md new file mode 100644 index 0000000000..2b8294779b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayercontextrequestedeventargs_position.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerContextRequestedEventArgs.Position + +## -description +Gets the x- and y-coordinate values that define the point on the map layer of a context input gesture, such as a right-click. + +## -property-value +The x- and y-coordinate values that define the point on the map layer of a context input gesture, such as a right-click. + +## -remarks +To get the geolocation point on the map layer of a context input gesture, use the [Location](mapelementslayercontextrequestedeventargs_location.md) property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs.md new file mode 100644 index 0000000000..65c392ce68 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs + +## -description +Provides data for the [MapElementPointerEntered](mapelementslayer_mapelementpointerentered.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_location.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_location.md new file mode 100644 index 0000000000..a523f35471 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_location.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.Location + +## -description +Gets the geographic location that corresponds to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -property-value +The geographic location that corresponds to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_mapelement.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_mapelement.md new file mode 100644 index 0000000000..1de6711c63 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_mapelement.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.MapElement +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.MapElement + +## -description +Gets the map element that correspond to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -property-value +The map element that correspond to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_mapelementslayerpointerenteredeventargs_1221375020.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_mapelementslayerpointerenteredeventargs_1221375020.md new file mode 100644 index 0000000000..8204c3ffab --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_mapelementslayerpointerenteredeventargs_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.MapElementsLayerPointerEnteredEventArgs + +## -description +Initializes a new instance of the [MapElementsLayerPointerEnteredEventArgs](mapelementslayerpointerenteredeventargs.md) class. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_position.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_position.md new file mode 100644 index 0000000000..5d21c5563c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerenteredeventargs_position.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerEnteredEventArgs.Position + +## -description +Gets the physical position on the [MapElementsLayer](mapelementslayer.md) where it received user input. + +## -property-value +The physical position on the [MapElementsLayer](mapelementslayer.md) where it received user input, in terms of X and Y coordinates. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs.md new file mode 100644 index 0000000000..3508db55ec --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs + +## -description +Provides data for the [MapElementPointerExited](mapelementslayer_mapelementpointerexited.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_location.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_location.md new file mode 100644 index 0000000000..579ab6a3af --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_location.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.Location + +## -description +Gets the geographic location that corresponds to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -property-value +The geographic location that corresponds to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_mapelement.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_mapelement.md new file mode 100644 index 0000000000..765ac5d8da --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_mapelement.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.MapElement +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.MapElement + +## -description +Gets the map element that correspond to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -property-value +The map element that correspond to where the [MapElementsLayer](mapelementslayer.md) received user input. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_mapelementslayerpointerexitedeventargs_1221375020.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_mapelementslayerpointerexitedeventargs_1221375020.md new file mode 100644 index 0000000000..e01290fc97 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_mapelementslayerpointerexitedeventargs_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.MapElementsLayerPointerExitedEventArgs + +## -description +Initializes a new instance of the [MapElementsLayerPointerExitedEventArgs](mapelementslayerpointerexitedeventargs.md) class. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_position.md b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_position.md new file mode 100644 index 0000000000..cb0dc96d59 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapelementslayerpointerexitedeventargs_position.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapElementsLayerPointerExitedEventArgs.Position + +## -description +Gets the physical position on the [MapElementsLayer](mapelementslayer.md) where it received user input. + +## -property-value +The physical position on the [MapElementsLayer](mapelementslayer.md) where it received user input, in terms of X and Y coordinates. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer.md b/windows.ui.xaml.controls.maps/maplayer.md new file mode 100644 index 0000000000..7d2934abcb --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapLayer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer + +## -description +Represents a collection of map data to which you can bind data and manipulate independently of other map types of map data. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_maplayer_1221375020.md b/windows.ui.xaml.controls.maps/maplayer_maplayer_1221375020.md new file mode 100644 index 0000000000..8855a4f47d --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_maplayer_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapLayer.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.MapLayer + +## -description +Creates a [MapLayer](maplayer.md) instance. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_maptabindex.md b/windows.ui.xaml.controls.maps/maplayer_maptabindex.md new file mode 100644 index 0000000000..604fbbd43b --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_maptabindex.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapLayer.MapTabIndex +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.MapTabIndex + +## -description +Gets or sets a value that determines the order in which objects of the [MapLayer](maplayer.md) receive focus when the user navigates through those elements by pressing the Tab key. + +## -property-value +A value that determines the order of logical navigation across elements in a [MapLayer](maplayer.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_maptabindexproperty.md b/windows.ui.xaml.controls.maps/maplayer_maptabindexproperty.md new file mode 100644 index 0000000000..7068d34021 --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_maptabindexproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapLayer.MapTabIndexProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.MapTabIndexProperty + +## -description +Identifies the [MapTagIndex](maplayer_maptabindex.md) dependency property. + +## -property-value +The [MapTagIndex](maplayer_maptabindex.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_visible.md b/windows.ui.xaml.controls.maps/maplayer_visible.md new file mode 100644 index 0000000000..fc346edabd --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_visible.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapLayer.Visible +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.Visible + +## -description +Gets or sets a value that indicates whether the [MapLayer](maplayer.md) is visible on the [MapControl](mapcontrol.md). + +## -property-value +**true** if the [MapLayer](maplayer.md) is visible on the [MapControl](mapcontrol.md); otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_visibleproperty.md b/windows.ui.xaml.controls.maps/maplayer_visibleproperty.md new file mode 100644 index 0000000000..4b0aed6c07 --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_visibleproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapLayer.VisibleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.VisibleProperty + +## -description +Identifies the [Visible](maplayer_visible.md) dependency property. + +## -property-value +The [Visible](maplayer_visible.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_zindex.md b/windows.ui.xaml.controls.maps/maplayer_zindex.md new file mode 100644 index 0000000000..fa387a9626 --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_zindex.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapLayer.ZIndex +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.ZIndex + +## -description +Gets or sets the z-index of the [MapLayer](maplayer.md). A [MapLayer](maplayer.md) with a higher z-index is displayed on top of a [MapLayer](maplayer.md) with a lower z-index. + +## -property-value +The z-index of the [MapLayer](maplayer.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/maplayer_zindexproperty.md b/windows.ui.xaml.controls.maps/maplayer_zindexproperty.md new file mode 100644 index 0000000000..c9e484cbfe --- /dev/null +++ b/windows.ui.xaml.controls.maps/maplayer_zindexproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapLayer.ZIndexProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapLayer.ZIndexProperty + +## -description +Identifies the [ZIndex](maplayer_zindex.md) dependency property. + +## -property-value +The [ZIndex](maplayer_zindex.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapmodel3d.md b/windows.ui.xaml.controls.maps/mapmodel3d.md new file mode 100644 index 0000000000..a4aff9f10a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapmodel3d.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapModel3D +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapModel3D + +## -description +Represents a 3D object to show on a map. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapmodel3d_createfrom3mfasync_225706088.md b/windows.ui.xaml.controls.maps/mapmodel3d_createfrom3mfasync_225706088.md new file mode 100644 index 0000000000..fd451dc12f --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapmodel3d_createfrom3mfasync_225706088.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapModel3D.CreateFrom3MFAsync(Windows.Storage.Streams.IRandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapModel3D.CreateFrom3MFAsync + +## -description +Creates an instance of a [MapModel3D](mapmodel3d.md) by importing a 3D object from a [3D Manufacturing Format (3MF)](http://3mf.io/specification/) file. + +## -parameters +### -param source +A [3D Manufacturing Format (3MF) file](http://3mf.io/specification/) file that describes a 3D object. + +## -returns +A 3D model object. + +## -remarks +Set the [Model](mapelement3d_model.md) property of the [MapElement3D](mapelement3d.md) to this object. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapmodel3d_createfrom3mfasync_285786742.md b/windows.ui.xaml.controls.maps/mapmodel3d_createfrom3mfasync_285786742.md new file mode 100644 index 0000000000..f802bb81f5 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapmodel3d_createfrom3mfasync_285786742.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapModel3D.CreateFrom3MFAsync(Windows.Storage.Streams.IRandomAccessStreamReference,Windows.UI.Xaml.Controls.Maps.MapModel3DShadingOption) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapModel3D.CreateFrom3MFAsync + +## -description +Creates an instance of a [MapModel3D](mapmodel3d.md) by importing a 3D object from a [3D Manufacturing Format (3MF)](http://3mf.io/specification/) file. + +## -parameters +### -param source +A [3D Manufacturing Format (3MF) file](http://3mf.io/specification/) file that describes a 3D object. + +### -param shadingOption +The type of shading that you would like to appear for the object. + +## -returns +A 3D model object. + +## -remarks +Set the [Model](mapelement3d_model.md) property of the [MapElement3D](mapelement3d.md) to this object. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapmodel3d_mapmodel3d_1221375020.md b/windows.ui.xaml.controls.maps/mapmodel3d_mapmodel3d_1221375020.md new file mode 100644 index 0000000000..9d4fd9cf48 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapmodel3d_mapmodel3d_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapModel3D.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapModel3D.MapModel3D + +## -description +Creates an instance of a [MapElement3D](mapelement3d.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapmodel3dshadingoption.md b/windows.ui.xaml.controls.maps/mapmodel3dshadingoption.md new file mode 100644 index 0000000000..3d222057ff --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapmodel3dshadingoption.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapModel3DShadingOption +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapModel3DShadingOption + +## -description +Specifies the type of shading that you want to appear for 3D objects. + +## -enum-fields +### -field Smooth:2 +Smooth shading. + +### -field Flat:1 +Flat shading. + +### -field Default:0 +The vertex normals of the imported 3D model or flat shading if that data is not available. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries.md b/windows.ui.xaml.controls.maps/mapstylesheetentries.md new file mode 100644 index 0000000000..bd8db30e9a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries + +## -description +Provides the names of JavaScript Object Notation (JSON) supported style entries in the map style sheet. + +## -remarks +You can set the [MapStyleSheetEntry](mapelement_mapstylesheetentry.md) property of a [MapElement](mapelement.md) to any of these entry names. If the map's style sheet defines a style for that entry name, the style is applied to the [MapElement](mapelement.md). + +To learn more about entries in a map style sheet, see [Map style sheet reference](https://docs.microsoft.com/windows/uwp/maps-and-location/elements-of-map-style-sheet#version). + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_admindistrict.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_admindistrict.md new file mode 100644 index 0000000000..adb8c68007 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_admindistrict.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.AdminDistrict +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.AdminDistrict + +## -description +Gets the JSON entry name that represents admin1, states, provinces, etc. + +## -property-value +The JSON entry name that represents admin1, states, provinces, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_admindistrictcapital.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_admindistrictcapital.md new file mode 100644 index 0000000000..411a5967fe --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_admindistrictcapital.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.AdminDistrictCapital +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.AdminDistrictCapital + +## -description +Gets the JSON entry name for icons that represent the capital of a state or province. + +## -property-value +The JSON entry name for icons that represent the capital of a state or province. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_airport.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_airport.md new file mode 100644 index 0000000000..9f76d2d22f --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_airport.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Airport +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Airport + +## -description +Gets the JSON entry name that represents areas that encompass an airport. + +## -property-value +The JSON entry name that represents areas that encompass an airport. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_area.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_area.md new file mode 100644 index 0000000000..ee7666bfa1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_area.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Area +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Area + +## -description +Gets the JSON entry name that represents areas of land use. + +## -property-value +The JSON entry name that represents areas of land use. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_arterialroad.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_arterialroad.md new file mode 100644 index 0000000000..1f23b01747 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_arterialroad.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.ArterialRoad +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.ArterialRoad + +## -description +Gets the JSON entry name for lines that represent main roads with heavy traffic. + +## -property-value +The JSON entry name for lines that represent main roads with heavy traffic. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_building.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_building.md new file mode 100644 index 0000000000..6c732b9383 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_building.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Building +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Building + +## -description +Gets the JSON entry name that represents a building. + +## -property-value +The JSON entry name that represents a building. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_business.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_business.md new file mode 100644 index 0000000000..e41a7f6087 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_business.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Business +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Business + +## -description +Gets the JSON entry name that represents restaurants, hospitals, schools, etc. + +## -property-value +The JSON entry name that represents restaurants, hospitals, schools, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_capital.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_capital.md new file mode 100644 index 0000000000..76b887cfeb --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_capital.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Capital +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Capital + +## -description +Gets the JSON entry name for icons that represent the capital of a populated place. + +## -property-value +The JSON entry name for icons that represent the capital of a populated place. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_cemetery.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_cemetery.md new file mode 100644 index 0000000000..ed62aa7967 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_cemetery.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Cemetery +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Cemetery + +## -description +Gets the JSON entry name that represents areas of cemeteries. + +## -property-value +The JSON entry name that represents areas of cemeteries. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_continent.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_continent.md new file mode 100644 index 0000000000..4cd99597ce --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_continent.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Continent +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Continent + +## -description +Gets the JSON entry name that represents areas of entire continents. + +## -property-value +The JSON entry name that represents areas of entire continents. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_controlledaccesshighway.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_controlledaccesshighway.md new file mode 100644 index 0000000000..44b841699c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_controlledaccesshighway.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.ControlledAccessHighway +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.ControlledAccessHighway + +## -description +Gets the JSON entry name for lines that represent highways with restricted access. + +## -property-value +The JSON entry name for lines that represent highways with restricted access. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_countryregion.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_countryregion.md new file mode 100644 index 0000000000..8d1c01a270 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_countryregion.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.CountryRegion +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.CountryRegion + +## -description +Gets the JSON entry name that represents a country. + +## -property-value +The JSON entry name that represents a country. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_countryregioncapital.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_countryregioncapital.md new file mode 100644 index 0000000000..2cadb0f8e9 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_countryregioncapital.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.CountryRegionCapital +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.CountryRegionCapital + +## -description +Gets the JSON entry name for icons that represent the capital of a country or region. + +## -property-value +The JSON entry name for icons that represent the capital of a country or region. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_district.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_district.md new file mode 100644 index 0000000000..c65cf89713 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_district.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.District +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.District + +## -description +Gets the JSON entry name that represents admin2, counties, etc. + +## -property-value +The JSON entry name that represents admin2, counties, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_drivingroute.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_drivingroute.md new file mode 100644 index 0000000000..6360bd750a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_drivingroute.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.DrivingRoute +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.DrivingRoute + +## -description +Gets the JSON entry name that represents a driving route. + +## -property-value +The JSON entry name that represents a driving route. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_education.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_education.md new file mode 100644 index 0000000000..375f55b8f6 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_education.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Education +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Education + +## -description +Gets the JSON entry name that represents areas of schools. + +## -property-value +The JSON entry name that represents areas of schools. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_educationbuilding.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_educationbuilding.md new file mode 100644 index 0000000000..75eced8803 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_educationbuilding.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.EducationBuilding +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.EducationBuilding + +## -description +Gets the JSON entry name that represents an educational building such as a school. + +## -property-value +The JSON entry name that represents an educational building such as a school. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_foodpoint.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_foodpoint.md new file mode 100644 index 0000000000..8c0f93713e --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_foodpoint.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.FoodPoint +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.FoodPoint + +## -description +Gets the JSON entry name that represents restaurants, cafés, etc. + +## -property-value +The JSON entry name that represents restaurants, cafés, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_forest.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_forest.md new file mode 100644 index 0000000000..f622f7ba07 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_forest.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Forest +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Forest + +## -description +Gets the JSON entry name that represents area of forest land. + +## -property-value +The JSON entry name that represents area of forest land. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_golfcourse.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_golfcourse.md new file mode 100644 index 0000000000..62dcfd5d5b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_golfcourse.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.GolfCourse +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.GolfCourse + +## -description +Gets the JSON entry name that represents areas of golf courses. + +## -property-value +The JSON entry name that represents areas of golf courses. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_highspeedramp.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_highspeedramp.md new file mode 100644 index 0000000000..445ae82cb1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_highspeedramp.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.HighSpeedRamp +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.HighSpeedRamp + +## -description +Gets the JSON entry name for lines that represent ramps. These ramps typically appear alongside of controlled access highways. + +## -property-value +The JSON entry name for lines that represent ramps. These ramps typically appear alongside of controlled access highways. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_highway.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_highway.md new file mode 100644 index 0000000000..aa73b2b685 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_highway.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Highway +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Highway + +## -description +Gets the JSON entry name for lines that represent highways. + +## -property-value +The JSON entry name for lines that represent highways. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_indigenouspeoplesreserve.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_indigenouspeoplesreserve.md new file mode 100644 index 0000000000..80367fd930 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_indigenouspeoplesreserve.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.IndigenousPeoplesReserve +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.IndigenousPeoplesReserve + +## -description +Gets the JSON entry name that represents areas of Indian reservations. + +## -property-value +The JSON entry name that represents areas of Indian reservations. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_island.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_island.md new file mode 100644 index 0000000000..252941d60b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_island.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Island +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Island + +## -description +Gets the JSON entry name that represents labels in island areas. + +## -property-value +The JSON entry name that represents labels in island areas. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_majorroad.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_majorroad.md new file mode 100644 index 0000000000..3bfe714833 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_majorroad.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.MajorRoad +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.MajorRoad + +## -description +Gets the JSON entry name for lines that represent main roads. + +## -property-value +The JSON entry name for lines that represent main roads. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_medical.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_medical.md new file mode 100644 index 0000000000..d082eb37c4 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_medical.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Medical +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Medical + +## -description +Gets the JSON entry name that represents areas of land that are used for medical purposes (For example: a hospital campus). + +## -property-value +The JSON entry name that represents areas of land that are used for medical purposes (For example: a hospital campus). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_medicalbuilding.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_medicalbuilding.md new file mode 100644 index 0000000000..79769f921c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_medicalbuilding.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.MedicalBuilding +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.MedicalBuilding + +## -description +Gets the JSON entry name that represents buildings that are used for medical purposes (For example: a hospital). + +## -property-value +The JSON entry name that represents buildings that are used for medical purposes (For example: a hospital). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_military.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_military.md new file mode 100644 index 0000000000..217857cf9a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_military.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Military +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Military + +## -description +Gets the JSON entry name that represents areas of military bases. + +## -property-value +The JSON entry name that represents areas of military bases. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_naturalpoint.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_naturalpoint.md new file mode 100644 index 0000000000..931dff21db --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_naturalpoint.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.NaturalPoint +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.NaturalPoint + +## -description +Gets the JSON entry name for icons that represent natural landmarks such as a volcano peak or waterfall. + +## -property-value +The JSON entry name for icons that represent natural landmarks such as a volcano peak or waterfall. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_nautical.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_nautical.md new file mode 100644 index 0000000000..0380262f59 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_nautical.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Nautical +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Nautical + +## -description +Gets the JSON entry name that represents areas of land that are used for nautical purposes. + +## -property-value +The JSON entry name that represents areas of land that are used for nautical purposes. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_neighborhood.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_neighborhood.md new file mode 100644 index 0000000000..3d544a84ab --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_neighborhood.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Neighborhood +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Neighborhood + +## -description +Gets the JSON entry name that represents labels in areas defined as neighborhoods. + +## -property-value +The JSON entry name that represents labels in areas defined as neighborhoods. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_park.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_park.md new file mode 100644 index 0000000000..54a9605971 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_park.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Park +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Park + +## -description +Gets the JSON entry name that represents park areas. + +## -property-value +The JSON entry name that represents park areas. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_peak.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_peak.md new file mode 100644 index 0000000000..7029596497 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_peak.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Peak +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Peak + +## -description +Gets the JSON entry name for icons that represent mountain peaks. + +## -property-value +The JSON entry name for icons that represent mountain peaks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_playingfield.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_playingfield.md new file mode 100644 index 0000000000..3dd1401b76 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_playingfield.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.PlayingField +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.PlayingField + +## -description +Gets the JSON entry name that represents extracted pitches such as a baseball field or tennis court. + +## -property-value +The JSON entry name that represents extracted pitches such as a baseball field or tennis court. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_point.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_point.md new file mode 100644 index 0000000000..fd6adec4ed --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_point.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Point +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Point + +## -description +Gets the JSON entry name that represents all point features that are rendered with an icon of some sort. + +## -property-value +The JSON entry name that represents all point features that are rendered with an icon of some sort. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_pointofinterest.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_pointofinterest.md new file mode 100644 index 0000000000..4032ab155c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_pointofinterest.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.PointOfInterest +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.PointOfInterest + +## -description +Gets the JSON entry name that represents restaurants, hospitals, schools, marinas, ski areas, etc. + +## -property-value +The JSON entry name that represents restaurants, hospitals, schools, marinas, ski areas, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_political.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_political.md new file mode 100644 index 0000000000..888832d3f0 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_political.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Political +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Political + +## -description +Gets the JSON entry name for political regions such as countries, regions and states. + +## -property-value +The JSON entry name for political regions such as countries, regions and states. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_populatedplace.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_populatedplace.md new file mode 100644 index 0000000000..d3d2cceae7 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_populatedplace.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.PopulatedPlace +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.PopulatedPlace + +## -description +Gets the JSON entry name for icons that represent the size of populated place (For example: a city or town). + +## -property-value +The JSON entry name for icons that represent the size of populated place (For example: a city or town). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_railway.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_railway.md new file mode 100644 index 0000000000..dc452f7165 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_railway.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Railway +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Railway + +## -description +Gets the JSON entry name that represents railway lines. + +## -property-value +The JSON entry name that represents railway lines. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_ramp.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_ramp.md new file mode 100644 index 0000000000..a7f3c26a3d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_ramp.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Ramp +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Ramp + +## -description +Gets the JSON entry name that represents lines that represent the entrance and exit of a highway. + +## -property-value +The JSON entry name that represents lines that represent the entrance and exit of a highway. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_reserve.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_reserve.md new file mode 100644 index 0000000000..e7b70b2478 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_reserve.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Reserve +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Reserve + +## -description +Gets the JSON entry name that represents areas of nature reserves. + +## -property-value +The JSON entry name that represents areas of nature reserves. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_river.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_river.md new file mode 100644 index 0000000000..8e11897bfb --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_river.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.River +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.River + +## -description +Gets the JSON entry name that represents rivers, streams, or other water passages. + +## -property-value +the JSON entry name that represents rivers, streams, or other water passages. + +## -remarks +This might be a line or polygon and might connect to non-river water bodies. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_road.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_road.md new file mode 100644 index 0000000000..c089155068 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_road.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Road +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Road + +## -description +Gets the JSON entry name for lines that represent all roads. + +## -property-value +The JSON entry name for lines that represent all roads. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_roadexit.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_roadexit.md new file mode 100644 index 0000000000..da985ceadc --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_roadexit.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.RoadExit +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.RoadExit + +## -description +Gets the JSON entry name for icons that represent exits, typically from a controlled access highway. + +## -property-value +The JSON entry name for icons that represent exits, typically from a controlled access highway. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_roadshield.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_roadshield.md new file mode 100644 index 0000000000..25cd211f7b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_roadshield.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.RoadShield +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.RoadShield + +## -description +Gets the JSON entry name for signs that represent the compact name for a road. (For example: I-5). + +## -property-value +The JSON entry name for signs that represent the compact name for a road. (For example: I-5). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_routeline.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_routeline.md new file mode 100644 index 0000000000..9a8e03f31c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_routeline.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.RouteLine +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.RouteLine + +## -description +Gets the JSON entry name that represents the styling for all route lines. + +## -property-value +The JSON entry name that represents the styling for all route lines. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_runway.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_runway.md new file mode 100644 index 0000000000..e53a7f77c1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_runway.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Runway +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Runway + +## -description +Gets the JSON entry name that represents land areas that are covered by a runway. + +## -property-value +The JSON entry name that represents land areas that are covered by a runway. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_sand.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_sand.md new file mode 100644 index 0000000000..59740e9b92 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_sand.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Sand +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Sand + +## -description +Gets the JSON entry name that represents sandy areas like beaches. + +## -property-value +The JSON entry name that represents sandy areas like beaches. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_shoppingcenter.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_shoppingcenter.md new file mode 100644 index 0000000000..6e47a11fe5 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_shoppingcenter.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.ShoppingCenter +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.ShoppingCenter + +## -description +Gets the JSON entry name that represents areas of ground allocated for malls or other shopping centers. + +## -property-value +The JSON entry name that represents areas of ground allocated for malls or other shopping centers. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_stadium.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_stadium.md new file mode 100644 index 0000000000..709b383893 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_stadium.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Stadium +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Stadium + +## -description +Gets the JSON entry name that represents area of a stadium. + +## -property-value +The JSON entry name that represents area of a stadium. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_street.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_street.md new file mode 100644 index 0000000000..8451dd4e02 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_street.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Street +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Street + +## -description +Gets the JSON entry name for lines that represent streets. + +## -property-value +The JSON entry name for lines that represent streets. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_structure.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_structure.md new file mode 100644 index 0000000000..783b6ed227 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_structure.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Structure +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Structure + +## -description +Gets the JSON entry name that represents building and other building-like structures. + +## -property-value +The JSON entry name that represents building and other building-like structures. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_tollroad.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_tollroad.md new file mode 100644 index 0000000000..950a6e2f74 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_tollroad.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.TollRoad +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.TollRoad + +## -description +Gets the JSON entry name that represents roads that cost money to use. + +## -property-value +The JSON entry name that represents roads that cost money to use. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_trail.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_trail.md new file mode 100644 index 0000000000..d91e9bb6ce --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_trail.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Trail +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Trail + +## -description +Gets the JSON entry name that represents walking trails through parks or hiking trails. + +## -property-value +The JSON entry name that represents walking trails through parks or hiking trails. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_transit.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_transit.md new file mode 100644 index 0000000000..f53ed24217 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_transit.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Transit +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Transit + +## -description +Gets the JSON entry name for icons that represent bus stops, train stops, airports, etc. + +## -property-value +The JSON entry name for icons that represent bus stops, train stops, airports, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_transitbuilding.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_transitbuilding.md new file mode 100644 index 0000000000..f04a6b25ec --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_transitbuilding.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.TransitBuilding +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.TransitBuilding + +## -description +Gets the JSON entry name that represents a transit building such as a bus station. + +## -property-value +The JSON entry name that represents a transit building such as a bus station. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_transportation.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_transportation.md new file mode 100644 index 0000000000..63d736c006 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_transportation.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Transportation +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Transportation + +## -description +Gets the JSON entry name that represents lines that are part of the transportation network (For example: roads, trains, and ferries). + +## -property-value +The JSON entry name that represents lines that are part of the transportation network (For example: roads, trains, and ferries). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_unpavedstreet.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_unpavedstreet.md new file mode 100644 index 0000000000..521e07777e --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_unpavedstreet.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.UnpavedStreet +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.UnpavedStreet + +## -description +Gets the JSON entry name for lines that represent unpaved streets. + +## -property-value +The JSON entry name for lines that represent unpaved streets. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_vegetation.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_vegetation.md new file mode 100644 index 0000000000..07675eff9c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_vegetation.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Vegetation +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Vegetation + +## -description +Gets the JSON entry name that represents forests, grassy areas, etc. + +## -property-value +The JSON entry name that represents forests, grassy areas, etc. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_volcanicpeak.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_volcanicpeak.md new file mode 100644 index 0000000000..18456305a2 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_volcanicpeak.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.VolcanicPeak +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.VolcanicPeak + +## -description +Gets the JSON entry name for icons that represent volcano peaks. + +## -property-value +The JSON entry name for icons that represent volcano peaks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_walkingroute.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_walkingroute.md new file mode 100644 index 0000000000..1c0795422d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_walkingroute.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.WalkingRoute +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.WalkingRoute + +## -description +Gets the JSON entry name that represents a walking route. + +## -property-value +The JSON entry name that represents a walking route. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_water.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_water.md new file mode 100644 index 0000000000..68b259e27d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_water.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Water +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.Water + +## -description +Gets the JSON entry name that represents anything that looks like water. This includes oceans and streams. + +## -property-value +The JSON entry name that represents anything that looks like water. This includes oceans and streams. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_waterpoint.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_waterpoint.md new file mode 100644 index 0000000000..c0c983beca --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_waterpoint.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.WaterPoint +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.WaterPoint + +## -description +Gets the JSON entry name for icons that represent water feature locations such as a waterfall. + +## -property-value +The JSON entry name for icons that represent water feature locations such as a waterfall. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentries_waterroute.md b/windows.ui.xaml.controls.maps/mapstylesheetentries_waterroute.md new file mode 100644 index 0000000000..7d2f4100a6 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentries_waterroute.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.WaterRoute +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntries.WaterRoute + +## -description +Gets the JSON entry name that represents ferry route lines. + +## -property-value +The JSON entry name that represents ferry route lines. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentrystates.md b/windows.ui.xaml.controls.maps/mapstylesheetentrystates.md new file mode 100644 index 0000000000..f1d2414cb2 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentrystates.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates + +## -description +Provides the names of the supported style entry states of a map style sheet. These states map to state-specific styles defined in the map's style sheet. + +## -remarks +You can set the [MapStyleSheetEntryState](mapelement_mapstylesheetentrystate.md) property of a [MapElement](mapelement.md) to any of these states. If the map's style sheet defines a style for that state, the style is applied to the [MapElement](mapelement.md). + +To learn more about entries in a map style sheet, see [Map style sheet reference](https://docs.microsoft.com/windows/uwp/maps-and-location/elements-of-map-style-sheet#version). + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentrystates_disabled.md b/windows.ui.xaml.controls.maps/mapstylesheetentrystates_disabled.md new file mode 100644 index 0000000000..88e7619017 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentrystates_disabled.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates.Disabled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates.Disabled + +## -description +Gets the name for the disabled visual state of the [MapElement](mapelement.md). + +## -property-value +The name for the disabled visual state of the [MapElement](mapelement.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentrystates_hover.md b/windows.ui.xaml.controls.maps/mapstylesheetentrystates_hover.md new file mode 100644 index 0000000000..1064b247ce --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentrystates_hover.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates.Hover +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates.Hover + +## -description +Gets the name for the hover visual state of the [MapElement](mapelement.md). + +## -property-value +The name for the hover visual state of the [MapElement](mapelement.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheetentrystates_selected.md b/windows.ui.xaml.controls.maps/mapstylesheetentrystates_selected.md new file mode 100644 index 0000000000..af4a5d8d51 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheetentrystates_selected.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates.Selected +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheetEntryStates.Selected + +## -description +Gets the name for the selected visual state of the [MapElement](mapelement.md). + +## -property-value +The name for the selected visual state of the [MapElement](mapelement.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.primitives/colorpickerslider.md b/windows.ui.xaml.controls.primitives/colorpickerslider.md new file mode 100644 index 0000000000..6488e8c96c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorpickerslider.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider + +## -description + +Represents a slider in a [ColorPicker](../windows.ui.xaml.controls/colorpicker.md) control. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorpickerslider_colorchannel.md b/windows.ui.xaml.controls.primitives/colorpickerslider_colorchannel.md new file mode 100644 index 0000000000..fb71a3ef45 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorpickerslider_colorchannel.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider.ColorChannel +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider.ColorChannel + +## -description + +Gets or sets a value that indicates which color channel the slider modifies. + +## -property-value + +A value of the enumeration that indicates which color channel the slider modifies. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorpickerslider_colorchannelproperty.md b/windows.ui.xaml.controls.primitives/colorpickerslider_colorchannelproperty.md new file mode 100644 index 0000000000..5809492c60 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorpickerslider_colorchannelproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider.ColorChannelProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider.ColorChannelProperty + +## -description + +Identifies the ColorChannel dependency property. + +## -property-value + +The identifier for the ColorChannel dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorpickerslider_colorpickerslider_1221375020.md b/windows.ui.xaml.controls.primitives/colorpickerslider_colorpickerslider_1221375020.md new file mode 100644 index 0000000000..1edeb92724 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorpickerslider_colorpickerslider_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorPickerSlider.ColorPickerSlider + +## -description + +Initializes a new instance of the ColorPickerSlider class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum.md b/windows.ui.xaml.controls.primitives/colorspectrum.md new file mode 100644 index 0000000000..918c4763e5 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum + +## -description + +Represents a control that lets a user choose a color from a visual spectrum. + +## -remarks + +ColorSpectrum is a component of the [ColorPicker](../windows.ui.xaml.controls/colorpicker.md) control. Use ColorPicker for a complete color picking experience. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_color.md b/windows.ui.xaml.controls.primitives/colorspectrum_color.md new file mode 100644 index 0000000000..b10223d618 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_color.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.Color +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.Color + +## -description + +Gets or sets the current color value. + +## -property-value + +The current color value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_colorchanged.md b/windows.ui.xaml.controls.primitives/colorspectrum_colorchanged.md new file mode 100644 index 0000000000..79207b95ee --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_colorchanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ColorChanged +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ColorChanged + +## -description + +Occurs when the Color property has changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_colorproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_colorproperty.md new file mode 100644 index 0000000000..9648c3be97 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_colorproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ColorProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ColorProperty + +## -description + +Identifies the Color dependency property. + +## -property-value + +The identifier for the Color dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_colorspectrum_1221375020.md b/windows.ui.xaml.controls.primitives/colorspectrum_colorspectrum_1221375020.md new file mode 100644 index 0000000000..b4ed1e5759 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_colorspectrum_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ColorSpectrum + +## -description + +Initializes a new instance of the ColorSpectrum class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_components.md b/windows.ui.xaml.controls.primitives/colorspectrum_components.md new file mode 100644 index 0000000000..edb8f57d1b --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_components.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.Components +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.Components + +## -description + +Gets or sets a value that indicates how the Hue-Saturation-Value (HSV) color components are mapped onto the [ColorSpectrum](colorspectrum.md). + +## -property-value + +A value of the enumeration. The default is **HueSaturation**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_componentsproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_componentsproperty.md new file mode 100644 index 0000000000..5d5eedfa25 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_componentsproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ComponentsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ComponentsProperty + +## -description + +Identifies the Components dependency property. + +## -property-value + +The identifier for the Components dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_hsvcolor.md b/windows.ui.xaml.controls.primitives/colorspectrum_hsvcolor.md new file mode 100644 index 0000000000..592f3b767c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_hsvcolor.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.HsvColor +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.HsvColor + +## -description + +Gets or sets the current color value as a Vector4. + +## -property-value + +The current HSV color value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_hsvcolorproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_hsvcolorproperty.md new file mode 100644 index 0000000000..ccc983d3dc --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_hsvcolorproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.HsvColorProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.HsvColorProperty + +## -description + +Identifies the HsvColor dependency property. + +## -property-value + +The identifier for the HsvColor dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_maxhue.md b/windows.ui.xaml.controls.primitives/colorspectrum_maxhue.md new file mode 100644 index 0000000000..760349a74c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_maxhue.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxHue +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxHue + +## -description + +Gets or sets the maximum Hue value in the range 0-359. + +## -property-value + +The maximum Hue value in the range 0-359. The default is 359. + +## -remarks + +The valid range for Hue values is 0-359. Setting a value outside of this range will cause an exception. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_maxhueproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_maxhueproperty.md new file mode 100644 index 0000000000..d0f49947a1 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_maxhueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxHueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxHueProperty + +## -description + +Identifies the MaxHue dependency property. + +## -property-value + +The identifier for the MaxHue dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_maxsaturation.md b/windows.ui.xaml.controls.primitives/colorspectrum_maxsaturation.md new file mode 100644 index 0000000000..78fda8cc39 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_maxsaturation.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxSaturation +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxSaturation + +## -description + +Gets or sets the maximum Saturation value in the range 0-100. + +## -property-value + +The maximum Saturation value in the range 0-100. The default is 100. + +## -remarks + +The valid range for Saturation values is 0-100. Setting a value outside of this range will cause an exception. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_maxsaturationproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_maxsaturationproperty.md new file mode 100644 index 0000000000..23a7616e2c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_maxsaturationproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxSaturationProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxSaturationProperty + +## -description + +Identifies the MaxSaturation dependency property. + +## -property-value + +The identifier for the MaxSaturation dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_maxvalue.md b/windows.ui.xaml.controls.primitives/colorspectrum_maxvalue.md new file mode 100644 index 0000000000..295d392402 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_maxvalue.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxValue +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxValue + +## -description + +Gets or sets the maximum Value value in the range 0-100. + +## -property-value + +The maximum Value value in the range 0-100. The default is 100. + +## -remarks + +The valid range for Value values is 0-100. Setting a value outside of this range will cause an exception. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_maxvalueproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_maxvalueproperty.md new file mode 100644 index 0000000000..57aec662c6 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_maxvalueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxValueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MaxValueProperty + +## -description + +Identifies the MaxValue dependency property. + +## -property-value + +The identifier for the MaxValue dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_minhue.md b/windows.ui.xaml.controls.primitives/colorspectrum_minhue.md new file mode 100644 index 0000000000..de3db4dd93 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_minhue.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinHue +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinHue + +## -description + +Gets or sets the minimum Hue value in the range 0-359. + +## -property-value + +The minimum Hue value in the range 0-359. The default is 0. + +## -remarks + +The valid range for Hue values is 0-359. Setting a value outside of this range will cause an exception. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_minhueproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_minhueproperty.md new file mode 100644 index 0000000000..981dcf0b5d --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_minhueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinHueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinHueProperty + +## -description + +Identifies the MinHue dependency property. + +## -property-value + +The identifier for the MinHue dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_minsaturation.md b/windows.ui.xaml.controls.primitives/colorspectrum_minsaturation.md new file mode 100644 index 0000000000..fb886d255a --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_minsaturation.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinSaturation +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinSaturation + +## -description + +Gets or sets the minimum Saturation value in the range 0-100. + +## -property-value + +The minimum Saturation value in the range 0-100. The default is 100. + +## -remarks + +The valid range for Saturation values is 0-100. Setting a value outside of this range will cause an exception. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_minsaturationproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_minsaturationproperty.md new file mode 100644 index 0000000000..c9b791a339 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_minsaturationproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinSaturationProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinSaturationProperty + +## -description + +Identifies the MinSaturation dependency property. + +## -property-value + +The identifier for the MinSaturation dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_minvalue.md b/windows.ui.xaml.controls.primitives/colorspectrum_minvalue.md new file mode 100644 index 0000000000..9f3cc7e7b0 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_minvalue.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinValue +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinValue + +## -description + +Gets or sets the minimum Value value in the range 0-100. + +## -property-value + +The minimum Value value in the range 0-100. The default is 100. + +## -remarks + +The valid range for Value values is 0-100. Setting a value outside of this range will cause an exception. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_minvalueproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_minvalueproperty.md new file mode 100644 index 0000000000..a332aff8d4 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_minvalueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinValueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.MinValueProperty + +## -description + +Identifies the MinValue dependency property. + +## -property-value + +The identifier for the MinValue dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_shape.md b/windows.ui.xaml.controls.primitives/colorspectrum_shape.md new file mode 100644 index 0000000000..e61983b5cd --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_shape.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.Shape +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.Shape + +## -description + +Gets or sets a value that indicates whether the ColorSpectrum is shown as a square or a circle. + +## -property-value + +A value of the enumeration. The default is **Box**, which shows the spectrum as a square. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/colorspectrum_shapeproperty.md b/windows.ui.xaml.controls.primitives/colorspectrum_shapeproperty.md new file mode 100644 index 0000000000..8006f7bf28 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/colorspectrum_shapeproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ShapeProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ColorSpectrum.ShapeProperty + +## -description + +Identifies the Shape dependency property. + +## -property-value + +The identifier for the Shape dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/flyoutbase_onprocesskeyboardaccelerators_1771064317.md b/windows.ui.xaml.controls.primitives/flyoutbase_onprocesskeyboardaccelerators_1771064317.md new file mode 100644 index 0000000000..57edfcdc1e --- /dev/null +++ b/windows.ui.xaml.controls.primitives/flyoutbase_onprocesskeyboardaccelerators_1771064317.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.FlyoutBase.OnProcessKeyboardAccelerators(Windows.UI.Xaml.Input.ProcessKeyboardAcceleratorEventArgs) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.FlyoutBase.OnProcessKeyboardAccelerators + +## -description +Called just before a keyboard shortcut (accelerator) is processed in your app. Invoked whenever application code or internal processes call [ProcessKeyboardAccelerators](uielement_processkeyboardaccelerators.md). Override this method to influence the default accelerator handling. + +## -parameters +### -param args +The [ProcessKeyboardAcceleratorEventArgs](..\windows.ui.xaml.input\processkeyboardacceleratoreventargs.md). + +## -remarks + +## -see-also + +## -examples +[TryInvokeKeyboardAccelerator](flyoutbase_tryinvokekeyboardaccelerator_2058427461.md) + diff --git a/windows.ui.xaml.controls.primitives/flyoutbase_tryinvokekeyboardaccelerator_2058427461.md b/windows.ui.xaml.controls.primitives/flyoutbase_tryinvokekeyboardaccelerator_2058427461.md new file mode 100644 index 0000000000..6142f48b0c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/flyoutbase_tryinvokekeyboardaccelerator_2058427461.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.FlyoutBase.TryInvokeKeyboardAccelerator(Windows.UI.Xaml.Input.ProcessKeyboardAcceleratorEventArgs) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.FlyoutBase.TryInvokeKeyboardAccelerator + +## -description +Attempts to invoke a keyboard shortcut (accelerator). + +## -parameters +### -param args +The [ProcessKeyboardAcceleratorEventArgs](..\windows.ui.xaml.input\processkeyboardacceleratoreventargs.md). + +## -remarks +Call this method in the [**OnProcessKeyboardAccelerators**](flyoutbase_onprocesskeyboardaccelerators_1771064317.md) override when an accelerator is invoked and you want to influence the default accelerator handling. + +## -examples + +## -see-also +- [ProcessKeyboardAccelerators](uielement_processkeyboardaccelerators.md) + diff --git a/windows.ui.xaml.controls.primitives/layoutinformation_getavailablesize_1897442717.md b/windows.ui.xaml.controls.primitives/layoutinformation_getavailablesize_1897442717.md new file mode 100644 index 0000000000..787b6ad646 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/layoutinformation_getavailablesize_1897442717.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.LayoutInformation.GetAvailableSize(Windows.UI.Xaml.UIElement) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.LayoutInformation.GetAvailableSize + +## -description + +Returns the Size value that was most recently used to measure the specified element. + +## -parameters + +### -param element + +The element for which to return the most recent size. + +## -returns + +The Size given as an argument on the most recent call to measure this element, or a Size of 0,0 if the element has not been measured yet. + +## -remarks + +## -see-also + +[UIElement.Measure](../windows.ui.xaml/uielement_measure_1722732750.md) + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackground.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackground.md new file mode 100644 index 0000000000..02f5db231a --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackground.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackground +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackground + +## -description + +Gets or sets the brush used to render the background of the reveal effect. + +## -property-value + +The brush used to render the background of the reveal effect. + +## -remarks + +For more info, see [Reveal](https://docs.microsoft.com/windows/uwp/style/reveal). + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundproperty.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundproperty.md new file mode 100644 index 0000000000..6c57849334 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackgroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackgroundProperty + +## -description + +Identifies the RevealBackground dependency property. + +## -property-value + +The identifier for the RevealBackground dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundshowsabovecontent.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundshowsabovecontent.md new file mode 100644 index 0000000000..a3bec79b6b --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundshowsabovecontent.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackgroundShowsAboveContent +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackgroundShowsAboveContent + +## -description + +Gets or sets a value that indicates whether the reveal backgound is shown on top of the content. + +## -property-value + +**true** if the reveal backgound is shown on top of the content; otherwise, **false**. + +## -remarks + +For more info, see [Reveal](https://docs.microsoft.com/windows/uwp/style/reveal). + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundshowsabovecontentproperty.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundshowsabovecontentproperty.md new file mode 100644 index 0000000000..7325ecffcf --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealbackgroundshowsabovecontentproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackgroundShowsAboveContentProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBackgroundShowsAboveContentProperty + +## -description + +Identifies the RevealBackgroundShowsAboveContent dependency property. + +## -property-value + +The identifier for the RevealBackgroundShowsAboveContent dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderbrush.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderbrush.md new file mode 100644 index 0000000000..393768f091 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderbrush.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderBrush +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderBrush + +## -description + +Gets or sets the brush used to render the border of the reveal effect. + +## -property-value + +The brush used to render the border of the reveal effect. + +## -remarks + +For more info, see [Reveal](https://docs.microsoft.com/windows/uwp/style/reveal). + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderbrushproperty.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderbrushproperty.md new file mode 100644 index 0000000000..cb424a3238 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderbrushproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderBrushProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderBrushProperty + +## -description + +Identifies the RevealBorderBrush dependency property. + +## -property-value + +The identifier for the RevealBorderBrush dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderthickness.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderthickness.md new file mode 100644 index 0000000000..085d1c7e2c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderthickness.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderThickness +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderThickness + +## -description + +Gets or sets the thickness of the border of the reveal effect. + +## -property-value + +The thickness of the border of the reveal effect. + +## -remarks + +For more info, see [Reveal](https://docs.microsoft.com/windows/uwp/style/reveal). + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderthicknessproperty.md b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderthicknessproperty.md new file mode 100644 index 0000000000..89ec1b115e --- /dev/null +++ b/windows.ui.xaml.controls.primitives/listviewitempresenter_revealborderthicknessproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderThicknessProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ListViewItemPresenter.RevealBorderThicknessProperty + +## -description + +Identifies the RevealBorderThickness dependency property. + +## -property-value + +The identifier for the RevealBorderThickness dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/popup.md b/windows.ui.xaml.controls.primitives/popup.md index 2d89364d78..4d5f35077c 100644 --- a/windows.ui.xaml.controls.primitives/popup.md +++ b/windows.ui.xaml.controls.primitives/popup.md @@ -1,4 +1,3 @@ - --- -api-id: T:Windows.UI.Xaml.Controls.Primitives.Popup -api-type: winrt class diff --git a/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md b/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md index 3a9f63f727..61bf8bbac7 100644 --- a/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md +++ b/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md @@ -10,9 +10,17 @@ public bool ShowAsMonochrome { get; set; } # Windows.UI.Xaml.Controls.BitmapIcon.ShowAsMonochrome ## -description + Gets or sets a value that indicates whether the bitmap is shown in a single color. +## -xaml-syntax + +```xaml + +``` + ## -property-value + **true** to show the bitmap in a single color; **false** to show the bitmap in full color. The default is **true.** ## -remarks diff --git a/windows.ui.xaml.controls/bitmapiconsource.md b/windows.ui.xaml.controls/bitmapiconsource.md new file mode 100644 index 0000000000..55723a81ef --- /dev/null +++ b/windows.ui.xaml.controls/bitmapiconsource.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.BitmapIconSource +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.BitmapIconSource + +## -description + +Represents an icon source that uses a bitmap as its content. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +**BitmapIconSource** is similar to [BitmapIcon](bitmapicon.md). However, because it is not a [FrameworkElement](../windows.ui.xaml/frameworkelement.md), it can be shared. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/bitmapiconsource_bitmapiconsource_1221375020.md b/windows.ui.xaml.controls/bitmapiconsource_bitmapiconsource_1221375020.md new file mode 100644 index 0000000000..f62762244d --- /dev/null +++ b/windows.ui.xaml.controls/bitmapiconsource_bitmapiconsource_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.BitmapIconSource.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.BitmapIconSource.BitmapIconSource + +## -description + +Initializes a new instance of the BitmapIconSource class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/bitmapiconsource_showasmonochrome.md b/windows.ui.xaml.controls/bitmapiconsource_showasmonochrome.md new file mode 100644 index 0000000000..b83916b2fc --- /dev/null +++ b/windows.ui.xaml.controls/bitmapiconsource_showasmonochrome.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.BitmapIconSource.ShowAsMonochrome +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.BitmapIconSource.ShowAsMonochrome + +## -description + +Gets or sets a value that indicates whether the bitmap is shown in a single color. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** to show the bitmap in a single color; **false** to show the bitmap in full color. The default is **true.** + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/bitmapiconsource_showasmonochromeproperty.md b/windows.ui.xaml.controls/bitmapiconsource_showasmonochromeproperty.md new file mode 100644 index 0000000000..84234f67ab --- /dev/null +++ b/windows.ui.xaml.controls/bitmapiconsource_showasmonochromeproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.BitmapIconSource.ShowAsMonochromeProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.BitmapIconSource.ShowAsMonochromeProperty + +## -description + +Identifies the ShowAsMonochrome dependency property. + +## -property-value + +The identifier for the ShowAsMonochrome dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/bitmapiconsource_urisource.md b/windows.ui.xaml.controls/bitmapiconsource_urisource.md new file mode 100644 index 0000000000..3277fb1ea3 --- /dev/null +++ b/windows.ui.xaml.controls/bitmapiconsource_urisource.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.BitmapIconSource.UriSource +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.BitmapIconSource.UriSource + +## -description + +Gets or sets the Uniform Resource Identifier (URI) of the bitmap to use as the icon content. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The [Uri](../windows.foundation/uri.md) of the bitmap to use as the icon content. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/bitmapiconsource_urisourceproperty.md b/windows.ui.xaml.controls/bitmapiconsource_urisourceproperty.md new file mode 100644 index 0000000000..4d51d1e30a --- /dev/null +++ b/windows.ui.xaml.controls/bitmapiconsource_urisourceproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.BitmapIconSource.UriSourceProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.BitmapIconSource.UriSourceProperty + +## -description + +Identifies the UriSource dependency property. + +## -property-value + +The identifier for the UriSource dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/charactercasing.md b/windows.ui.xaml.controls/charactercasing.md new file mode 100644 index 0000000000..c647dfcb52 --- /dev/null +++ b/windows.ui.xaml.controls/charactercasing.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.CharacterCasing +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.CharacterCasing + +## -description + +Defines constants that specify how a control modifies the case of characters as they are typed. + +## -enum-fields + +### -field Upper:2 + +Characters are changed to uppercase. + +### -field Normal:0 + +The case of characters is left unchanged. + +### -field Lower:1 + +Characters are changed to lowercase. + +## -remarks + +## -see-also + +- [TextBox.CharacterCasing](textbox_charactercasing.md) +- [RichEditBox.CharacterCasing](richeditbox_charactercasing.md) + +## -examples + diff --git a/windows.ui.xaml.controls/colorpicker.md b/windows.ui.xaml.controls/colorpicker.md index c529ceab30..e363f4d03a 100644 --- a/windows.ui.xaml.controls/colorpicker.md +++ b/windows.ui.xaml.controls/colorpicker.md @@ -13,6 +13,12 @@ public class ColorPicker : Control, Control Represents a control that lets a user pick a color using a color spectrum, sliders, and text input. +## -xaml-syntax + +```xaml + +``` + ## -remarks ## -see-also diff --git a/windows.ui.xaml.controls/colorpicker_color.md b/windows.ui.xaml.controls/colorpicker_color.md index 390621f276..4b1069fd10 100644 --- a/windows.ui.xaml.controls/colorpicker_color.md +++ b/windows.ui.xaml.controls/colorpicker_color.md @@ -13,6 +13,17 @@ public Color Color { get; set; } Gets or sets the current color value. +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
colorString
colorStringThe Color expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+ + ## -property-value The current color value. diff --git a/windows.ui.xaml.controls/colorpicker_colorchanged.md b/windows.ui.xaml.controls/colorpicker_colorchanged.md index c43ff4a41c..de1f6e7b49 100644 --- a/windows.ui.xaml.controls/colorpicker_colorchanged.md +++ b/windows.ui.xaml.controls/colorpicker_colorchanged.md @@ -13,6 +13,12 @@ public event TypedEventHandler ColorChanged Occurs when the Color property has changed. +## -xaml-syntax + +```xaml + +``` + ## -remarks ## -see-also diff --git a/windows.ui.xaml.controls/colorpicker_colorspectrumcomponents.md b/windows.ui.xaml.controls/colorpicker_colorspectrumcomponents.md index a3639173e4..edfdccab47 100644 --- a/windows.ui.xaml.controls/colorpicker_colorspectrumcomponents.md +++ b/windows.ui.xaml.controls/colorpicker_colorspectrumcomponents.md @@ -13,6 +13,12 @@ public ColorSpectrumComponents ColorSpectrumComponents { get; set; } Gets or sets a value that indicates how the Hue-Saturation-Value (HSV) color components are mapped onto the [ColorSpectrum](colorspectrum.md). +## -xaml-syntax + +```xaml + +``` + ## -property-value A value of the enumeration. The default is **HueSaturation**. diff --git a/windows.ui.xaml.controls/colorpicker_colorspectrumshape.md b/windows.ui.xaml.controls/colorpicker_colorspectrumshape.md index 023c7e3645..31182892c0 100644 --- a/windows.ui.xaml.controls/colorpicker_colorspectrumshape.md +++ b/windows.ui.xaml.controls/colorpicker_colorspectrumshape.md @@ -13,6 +13,12 @@ public ColorSpectrumShape ColorSpectrumShape { get; set; } Gets or sets a value that indicates whether the ColorSpectrum is shown as a square or a circle. +## -xaml-syntax + +```xaml + +``` + ## -property-value A value of the enumeration. The default is **Box**, which shows the spectrum as a square. diff --git a/windows.ui.xaml.controls/colorpicker_isalphaenabled.md b/windows.ui.xaml.controls/colorpicker_isalphaenabled.md index 10463b0c44..6e4cc28022 100644 --- a/windows.ui.xaml.controls/colorpicker_isalphaenabled.md +++ b/windows.ui.xaml.controls/colorpicker_isalphaenabled.md @@ -13,6 +13,12 @@ public bool IsAlphaEnabled { get; set; } Gets or sets a value that indicates whether the alpha channel can be modified. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the alpha channel is enabled; otherwise, **false**. The default is **false**. diff --git a/windows.ui.xaml.controls/colorpicker_isalphaslidervisible.md b/windows.ui.xaml.controls/colorpicker_isalphaslidervisible.md index 0f9e5bfd47..eb13c13cc7 100644 --- a/windows.ui.xaml.controls/colorpicker_isalphaslidervisible.md +++ b/windows.ui.xaml.controls/colorpicker_isalphaslidervisible.md @@ -13,6 +13,12 @@ public bool IsAlphaSliderVisible { get; set; } Gets or sets a value that indicates whether the slider control for the alpha channel is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the alpha channel slider is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_isalphatextinputvisible.md b/windows.ui.xaml.controls/colorpicker_isalphatextinputvisible.md index 90325ed2cb..c6c6e6f781 100644 --- a/windows.ui.xaml.controls/colorpicker_isalphatextinputvisible.md +++ b/windows.ui.xaml.controls/colorpicker_isalphatextinputvisible.md @@ -13,6 +13,12 @@ public bool IsAlphaTextInputVisible { get; set; } Gets or sets a value that indicates whether the text input box for the alpha channel is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the alpha channel text input box is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_iscolorchanneltextinputvisible.md b/windows.ui.xaml.controls/colorpicker_iscolorchanneltextinputvisible.md index 2327ccb159..2a79b6ba03 100644 --- a/windows.ui.xaml.controls/colorpicker_iscolorchanneltextinputvisible.md +++ b/windows.ui.xaml.controls/colorpicker_iscolorchanneltextinputvisible.md @@ -13,6 +13,12 @@ public bool IsColorChannelTextInputVisible { get; set; } Gets or sets a value that indicates whether the text input boxes for the color channels are shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the color channel text input boxes are shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_iscolorpreviewvisible.md b/windows.ui.xaml.controls/colorpicker_iscolorpreviewvisible.md index f4d3e5391b..1ed4444581 100644 --- a/windows.ui.xaml.controls/colorpicker_iscolorpreviewvisible.md +++ b/windows.ui.xaml.controls/colorpicker_iscolorpreviewvisible.md @@ -13,6 +13,12 @@ public bool IsColorPreviewVisible { get; set; } Gets or sets a value that indicates whether the color preview bar is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the color preview bar is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_iscolorslidervisible.md b/windows.ui.xaml.controls/colorpicker_iscolorslidervisible.md index 79dd995067..00315d2d6b 100644 --- a/windows.ui.xaml.controls/colorpicker_iscolorslidervisible.md +++ b/windows.ui.xaml.controls/colorpicker_iscolorslidervisible.md @@ -13,6 +13,12 @@ public bool IsColorSliderVisible { get; set; } Gets or sets a value that indicates whether the slider control for the color value is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the color slider is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_iscolorspectrumvisible.md b/windows.ui.xaml.controls/colorpicker_iscolorspectrumvisible.md index b610551eb2..fe6392c775 100644 --- a/windows.ui.xaml.controls/colorpicker_iscolorspectrumvisible.md +++ b/windows.ui.xaml.controls/colorpicker_iscolorspectrumvisible.md @@ -13,6 +13,12 @@ public bool IsColorSpectrumVisible { get; set; } Gets or sets a value that indicates whether the color spectrum control is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the color spectrum is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_ishexinputvisible.md b/windows.ui.xaml.controls/colorpicker_ishexinputvisible.md index 0a5f29ae60..77daee26f5 100644 --- a/windows.ui.xaml.controls/colorpicker_ishexinputvisible.md +++ b/windows.ui.xaml.controls/colorpicker_ishexinputvisible.md @@ -13,6 +13,12 @@ public bool IsHexInputVisible { get; set; } Gets or sets a value that indicates whether the text input box for a HEX color value is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the HEX color text input box is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/colorpicker_ismorebuttonvisible.md b/windows.ui.xaml.controls/colorpicker_ismorebuttonvisible.md index 896031c465..2766962452 100644 --- a/windows.ui.xaml.controls/colorpicker_ismorebuttonvisible.md +++ b/windows.ui.xaml.controls/colorpicker_ismorebuttonvisible.md @@ -13,6 +13,12 @@ public bool IsMoreButtonVisible { get; set; } Gets or sets a value that indicates whether the 'more' button is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the 'more' button is shown; otherwise, **false**. The default is **false**. diff --git a/windows.ui.xaml.controls/colorpicker_maxhue.md b/windows.ui.xaml.controls/colorpicker_maxhue.md index 325ef0cff8..bbb95127d2 100644 --- a/windows.ui.xaml.controls/colorpicker_maxhue.md +++ b/windows.ui.xaml.controls/colorpicker_maxhue.md @@ -13,6 +13,12 @@ public int MaxHue { get; set; } Gets or sets the maximum Hue value in the range 0-359. +## -xaml-syntax + +```xaml + +``` + ## -property-value The maximum Hue value in the range 0-359. The default is 359. diff --git a/windows.ui.xaml.controls/colorpicker_maxsaturation.md b/windows.ui.xaml.controls/colorpicker_maxsaturation.md index c3d7244f7c..36102509fc 100644 --- a/windows.ui.xaml.controls/colorpicker_maxsaturation.md +++ b/windows.ui.xaml.controls/colorpicker_maxsaturation.md @@ -13,6 +13,12 @@ public int MaxSaturation { get; set; } Gets or sets the maximum Saturation value in the range 0-100. +## -xaml-syntax + +```xaml + +``` + ## -property-value The maximum Saturation value in the range 0-100. The default is 100. diff --git a/windows.ui.xaml.controls/colorpicker_maxvalue.md b/windows.ui.xaml.controls/colorpicker_maxvalue.md index 341e00d406..b93ad4a1f5 100644 --- a/windows.ui.xaml.controls/colorpicker_maxvalue.md +++ b/windows.ui.xaml.controls/colorpicker_maxvalue.md @@ -13,6 +13,12 @@ public int MaxValue { get; set; } Gets or sets the maximum Value value in the range 0-100. +## -xaml-syntax + +```xaml + +``` + ## -property-value The maximum Value value in the range 0-100. The default is 100. diff --git a/windows.ui.xaml.controls/colorpicker_minhue.md b/windows.ui.xaml.controls/colorpicker_minhue.md index 3c3a72886b..660416c13a 100644 --- a/windows.ui.xaml.controls/colorpicker_minhue.md +++ b/windows.ui.xaml.controls/colorpicker_minhue.md @@ -13,6 +13,12 @@ public int MinHue { get; set; } Gets or sets the minimum Hue value in the range 0-359. +## -xaml-syntax + +```xaml + +``` + ## -property-value The minimum Hue value in the range 0-359. The default is 0. diff --git a/windows.ui.xaml.controls/colorpicker_minsaturation.md b/windows.ui.xaml.controls/colorpicker_minsaturation.md index efbd133a7d..5e52ec907e 100644 --- a/windows.ui.xaml.controls/colorpicker_minsaturation.md +++ b/windows.ui.xaml.controls/colorpicker_minsaturation.md @@ -13,6 +13,12 @@ public int MinSaturation { get; set; } Gets or sets the minimum Saturation value in the range 0-100. +## -xaml-syntax + +```xaml + +``` + ## -property-value The minimum Saturation value in the range 0-100. The default is 100. diff --git a/windows.ui.xaml.controls/colorpicker_minvalue.md b/windows.ui.xaml.controls/colorpicker_minvalue.md index d48d923e64..221b2910d7 100644 --- a/windows.ui.xaml.controls/colorpicker_minvalue.md +++ b/windows.ui.xaml.controls/colorpicker_minvalue.md @@ -13,6 +13,12 @@ public int MinValue { get; set; } Gets or sets the minimum Value value in the range 0-100. +## -xaml-syntax + +```xaml + +``` + ## -property-value The minimum Value value in the range 0-100. The default is 100. diff --git a/windows.ui.xaml.controls/colorpicker_previouscolor.md b/windows.ui.xaml.controls/colorpicker_previouscolor.md index 463e001a11..105d1544a9 100644 --- a/windows.ui.xaml.controls/colorpicker_previouscolor.md +++ b/windows.ui.xaml.controls/colorpicker_previouscolor.md @@ -13,6 +13,17 @@ public IReference PreviousColor { get; set; } Gets or sets the previous color. +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
colorString
colorStringThe Color expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+ + ## -property-value The previous color. The default is **null**. diff --git a/windows.ui.xaml.controls/colorpickerhsvchannel.md b/windows.ui.xaml.controls/colorpickerhsvchannel.md new file mode 100644 index 0000000000..fc03969d3d --- /dev/null +++ b/windows.ui.xaml.controls/colorpickerhsvchannel.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.ColorPickerHsvChannel +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.ColorPickerHsvChannel + +## -description + +Defines contstants that specify which Hue-Saturation-Value-Alpha component a slider in a [ColorPicker](colorpicker.md) controls. + +## -enum-fields + +### -field Value:2 + +The slider controls the Value channel. + +### -field Saturation:1 + +The slider controls the Saturation channel. + +### -field Hue:0 + +The slider controls the Hue channel. + +### -field Alpha:3 + +The slider controls the Alpha channel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/combobox_placeholderforeground.md b/windows.ui.xaml.controls/combobox_placeholderforeground.md new file mode 100644 index 0000000000..aa65997cb0 --- /dev/null +++ b/windows.ui.xaml.controls/combobox_placeholderforeground.md @@ -0,0 +1,41 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ComboBox.PlaceholderForeground +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ComboBox.PlaceholderForeground + +## -description + +Gets or sets a brush that describes the color of placeholder text. + +## -xaml-syntax + +```xaml + +``` + +```xaml + +``` + +## -xaml-values + +
resourceName
resourceNameThe resource name (x:Key attribute value) of an existing XAML resource that defines a brush. This is the recommended way to specify Brush values in XAML if you have any intention of using the same colors or brushes in more than one part of your UI. See Remarks in Brush or ResourceDictionary and XAML resource references.
+
colorString
colorStringThe Color for a SolidColorBrush expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+
+ +## -property-value + +The brush that describes the color of placeholder text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/combobox_placeholderforegroundproperty.md b/windows.ui.xaml.controls/combobox_placeholderforegroundproperty.md new file mode 100644 index 0000000000..35567a9750 --- /dev/null +++ b/windows.ui.xaml.controls/combobox_placeholderforegroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ComboBox.PlaceholderForegroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ComboBox.PlaceholderForegroundProperty + +## -description + +Identifies the PlaceholderForeground dependency property. + +## -property-value + +The identifier for the PlaceholderForeground dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_showasync_1208475713.md b/windows.ui.xaml.controls/contentdialog_showasync_1208475713.md new file mode 100644 index 0000000000..4f6a279a07 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_showasync_1208475713.md @@ -0,0 +1,38 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ContentDialog.ShowAsync(Windows.UI.Xaml.Controls.ContentDialogPlacement) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.ShowAsync + +## -description + +Begins an asynchronous operation to show the dialog with the specified placement. + +## -parameters + +### -param placement + +A value that specifies whether the dialog is placed in the PopupRoot or in its parent's visual tree. + +## -returns + +An asynchronous operation showing the dialog. When complete, returns a [ContentDialogResult](contentdialogresult.md). + +## -remarks + +When you call this method with the **ContentDialogPlacement.Popup** parameter value, the dialog is rooted in the PopupRoot element of the XAML Window. This is the default behavior, and is equivilent to calling the [ShowAsync](contentdialog_showasync_1714076542.md) method with no parameters. + +When you call this method with the **ContentDialogPlacement.InPlace** parameter value: + +- If the dialog has a parent element, the dialog is rooted in the parent's visual tree. It's shown inline along with the parent’s other child elements, and participates in the parent container’s layout. +- If the dialog has no parent, the dialog falls back to the default behavior and is shown in the PopupRoot. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialogplacement.md b/windows.ui.xaml.controls/contentdialogplacement.md new file mode 100644 index 0000000000..32cb0ea156 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialogplacement.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.ContentDialogPlacement +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.ContentDialogPlacement + +## -description + +Defines constants that specify where in the XAML visual tree a ContentDialog is rooted. + +## -enum-fields +### -field Popup:0 + +The dialog is rooted in the PopupRoot element of the XAML Window. + +### -field InPlace:1 + +If the dialog has a parent element, the dialog is rooted in the parent's visual tree. Otherwise, it falls back to the **Popup** behavior. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/control_fontweight.md b/windows.ui.xaml.controls/control_fontweight.md index 0ac6eb159b..026e53b29f 100644 --- a/windows.ui.xaml.controls/control_fontweight.md +++ b/windows.ui.xaml.controls/control_fontweight.md @@ -19,7 +19,7 @@ Gets or sets the thickness of the specified font. ## -xaml-values -
fontWeightsPropertyName
fontWeightsPropertyNameA FontWeights member name, such as Light or Normal.
+
fontWeightMemberName
fontWeightMemberNameA FontWeights member name, such as Light or Normal.
## -property-value One of the values that specifies the thickness of the specified font. The default is [Normal](../windows.ui.text/fontweights_normal.md). diff --git a/windows.ui.xaml.controls/control_oncharacterreceived_931807470.md b/windows.ui.xaml.controls/control_oncharacterreceived_931807470.md new file mode 100644 index 0000000000..b2c7003271 --- /dev/null +++ b/windows.ui.xaml.controls/control_oncharacterreceived_931807470.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Control.OnCharacterReceived(Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Control.OnCharacterReceived + +## -description + +Called before the [CharacterReceived](../windows.ui.xaml/uielement_characterreceived.md) event occurs. + +## -parameters + +### -param e + +Event data for the event. + +## -remarks + +## -see-also + +[UIElement.CharacterReceived](../windows.ui.xaml/uielement_characterreceived.md), [Events and routed events overview](http://msdn.microsoft.com/library/34c219e8-3efb-45bc-8bbd-6fd937698832) + +## -examples diff --git a/windows.ui.xaml.controls/disabledformattingaccelerators.md b/windows.ui.xaml.controls/disabledformattingaccelerators.md new file mode 100644 index 0000000000..80dbd303dd --- /dev/null +++ b/windows.ui.xaml.controls/disabledformattingaccelerators.md @@ -0,0 +1,44 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.DisabledFormattingAccelerators +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.DisabledFormattingAccelerators + +## -description + +Defines constants that specify which keyboard shortcuts for formatting are disabled in a [RichEditBox](richeditbox.md). + +## -enum-fields +### -field Underline:4 + +The keyboard shortcut for underline (Ctrl+U) is disabled. + +### -field None:0 + +No keyboard shortcuts are disabled. + +### -field Italic:2 + +The keyboard shortcut for italic (Ctrl+I) is disabled. + +### -field Bold:1 + +The keyboard shortcut for bold (Ctrl+B) is disabled. + +### -field All:4294967295 + +All keyboard shortcuts are disabled. + +## -remarks + +## -see-also + +[RichEditBox.DisabledFormattingAccelerators](richeditbox_disabledformattingaccelerators.md) + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource.md b/windows.ui.xaml.controls/fonticonsource.md new file mode 100644 index 0000000000..9f386e2460 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.FontIconSource +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource + +## -description + +Represents an icon source that uses a glyph from the specified font. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontfamily.md b/windows.ui.xaml.controls/fonticonsource_fontfamily.md new file mode 100644 index 0000000000..fe70d800bb --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontfamily.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontFamily +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontFamily + +## -description + +Gets or sets the font used to display the icon glyph. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
fontFamilyValue
fontFamilyValueA string representation of a FontFamily value, possibly including fallback values or indexes within a font file, or a URI where the font family is packaged. For more information on the syntax, see FontFamily.
+
+ +## -property-value + +The font used to display the icon glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontfamilyproperty.md b/windows.ui.xaml.controls/fonticonsource_fontfamilyproperty.md new file mode 100644 index 0000000000..aec4ebe160 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontfamilyproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontFamilyProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontFamilyProperty + +## -description + +Gets the identifier for the FontFamily dependency property. + +## -property-value + +The identifier for the FontFamily dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fonticonsource_1221375020.md b/windows.ui.xaml.controls/fonticonsource_fonticonsource_1221375020.md new file mode 100644 index 0000000000..4f62908eff --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fonticonsource_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.FontIconSource.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontIconSource + +## -description + +Initializes a new instance of the FontIconSource class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontsize.md b/windows.ui.xaml.controls/fonticonsource_fontsize.md new file mode 100644 index 0000000000..22ba407bad --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontsize.md @@ -0,0 +1,33 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontSize +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontSize + +## -description + +Gets or sets the size of the icon glyph. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +A non-negative value that specifies the font size, measured in pixels. + +## -remarks + +The unit measure for [FontSize](control_fontsize.md) is pixels, measuring the line height of the characters in the font. The apparent size of text in the UI can vary based on the current scaling. If you want to use different [FontSize](control_fontsize.md) values for different scalings, you can do this using the resources system. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontsizeproperty.md b/windows.ui.xaml.controls/fonticonsource_fontsizeproperty.md new file mode 100644 index 0000000000..0ddaf1d3de --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontsizeproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontSizeProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontSizeProperty + +## -description + +Gets the identifier for the FontSize dependency property. + +## -property-value + +The identifier for the FontSize dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontstyle.md b/windows.ui.xaml.controls/fonticonsource_fontstyle.md new file mode 100644 index 0000000000..96731a665a --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontstyle.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontStyle +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontStyle + +## -description + +Gets or sets the font style for the icon glyph. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
fontStyleMemberName
fontStyleMemberName A FontStyle named constant, such as Italic.
+
+ +## -property-value + +A named constant of the enumeration that specifies the style in which the icon glyph is rendered. The default is **Normal**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontstyleproperty.md b/windows.ui.xaml.controls/fonticonsource_fontstyleproperty.md new file mode 100644 index 0000000000..480a659cca --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontstyleproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontStyleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontStyleProperty + +## -description + +Gets the identifier for the FontStyle dependency property. + +## -property-value + +The identifier for the FontStyle dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontweight.md b/windows.ui.xaml.controls/fonticonsource_fontweight.md new file mode 100644 index 0000000000..08b91689b8 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontweight.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontWeight +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontWeight + +## -description + +Gets or sets the thickness of the icon glyph. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
fontWeightsValue
fontWeightsValue A FontWeights property name, such as Light, Normal, or ExtraBold.
+
+ +## -property-value + +A value that specifies the thickness of the icon glyph. The default is **Normal**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_fontweightproperty.md b/windows.ui.xaml.controls/fonticonsource_fontweightproperty.md new file mode 100644 index 0000000000..3b17596138 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_fontweightproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.FontWeightProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.FontWeightProperty + +## -description + +Gets the identifier for the FontWeight dependency property. + +## -property-value + +The identifier for the FontWeight dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_glyph.md b/windows.ui.xaml.controls/fonticonsource_glyph.md new file mode 100644 index 0000000000..98f28b284f --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_glyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.Glyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.Glyph + +## -description + +Gets or sets the character code that identifies the icon glyph. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the icon glyph, such as "&#x00FF;".
+
+ +## -property-value + +The hexadecimal character code for the icon glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_glyphproperty.md b/windows.ui.xaml.controls/fonticonsource_glyphproperty.md new file mode 100644 index 0000000000..05306a41b5 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_glyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.GlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.GlyphProperty + +## -description + +Gets the identifier for the Glyph dependency property. + +## -property-value + +The identifier for the Glyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_istextscalefactorenabled.md b/windows.ui.xaml.controls/fonticonsource_istextscalefactorenabled.md new file mode 100644 index 0000000000..1391765752 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_istextscalefactorenabled.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.IsTextScaleFactorEnabled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.IsTextScaleFactorEnabled + +## -description + +Gets or sets a value that indicates whether automatic text enlargement, to reflect the system text size setting, is enabled. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** if automatic text enlargement is enabled; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_istextscalefactorenabledproperty.md b/windows.ui.xaml.controls/fonticonsource_istextscalefactorenabledproperty.md new file mode 100644 index 0000000000..00e0e853e2 --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_istextscalefactorenabledproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.IsTextScaleFactorEnabledProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.IsTextScaleFactorEnabledProperty + +## -description + +Gets the identifier for the IsTextScaleFactorEnabled dependency property. + +## -property-value + +The identifier for the IsTextScaleFactorEnabled dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_mirroredwhenrighttoleft.md b/windows.ui.xaml.controls/fonticonsource_mirroredwhenrighttoleft.md new file mode 100644 index 0000000000..1f5bcb938b --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_mirroredwhenrighttoleft.md @@ -0,0 +1,33 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.MirroredWhenRightToLeft +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.MirroredWhenRightToLeft + +## -description + +Gets or sets a value that indicates whether the icon is mirrored when its containing element's [FlowDirection](../windows.ui.xaml/frameworkelement_flowdirection.md) is **RightToLeft**. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** if the icon is mirrored when the [FlowDirection](../windows.ui.xaml/frameworkelement_flowdirection.md) is [FlowDirection.RightToLeft](../windows.ui.xaml/flowdirection.md); otherwise, **false**. The default is **false**. + +## -remarks + +You can set the [MirroredWhenRightToLeft](fonticon_mirroredwhenrighttoleft.md) property to have the glyph appear mirrored when its containing element's [FlowDirection](../windows.ui.xaml/frameworkelement_flowdirection.md) is [RightToLeft](../windows.ui.xaml/flowdirection.md). You typically use this property when a [FontIcon](fonticon.md) is used to display an icon as part of a control template and the icon needs to be mirrored along with the rest of the control. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/fonticonsource_mirroredwhenrighttoleftproperty.md b/windows.ui.xaml.controls/fonticonsource_mirroredwhenrighttoleftproperty.md new file mode 100644 index 0000000000..d31dee772f --- /dev/null +++ b/windows.ui.xaml.controls/fonticonsource_mirroredwhenrighttoleftproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.FontIconSource.MirroredWhenRightToLeftProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.FontIconSource.MirroredWhenRightToLeftProperty + +## -description + +Gets the identifier for the MirroredWhenRightToLeft dependency property. + +## -property-value + +The identifier for the MirroredWhenRightToLeft dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/grid_columnspacing.md b/windows.ui.xaml.controls/grid_columnspacing.md new file mode 100644 index 0000000000..adc3797f41 --- /dev/null +++ b/windows.ui.xaml.controls/grid_columnspacing.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Grid.ColumnSpacing +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Grid.ColumnSpacing + +## -description + +Gets or sets the distance (in pixels) between grid columns. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The distance (in pixels) between grid columns. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/grid_columnspacingproperty.md b/windows.ui.xaml.controls/grid_columnspacingproperty.md new file mode 100644 index 0000000000..5a7e5d95d1 --- /dev/null +++ b/windows.ui.xaml.controls/grid_columnspacingproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Grid.ColumnSpacingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Grid.ColumnSpacingProperty + +## -description + +Identifies the ColumnSpacing dependency property. + +## -property-value + +The identifier for the ColumnSpacing dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/grid_rowspacing.md b/windows.ui.xaml.controls/grid_rowspacing.md new file mode 100644 index 0000000000..4eb4af4ad3 --- /dev/null +++ b/windows.ui.xaml.controls/grid_rowspacing.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Grid.RowSpacing +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Grid.RowSpacing + +## -description + +Gets or sets the distance (in pixels) between grid rows. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The distance (in pixels) between grid rows. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/grid_rowspacingproperty.md b/windows.ui.xaml.controls/grid_rowspacingproperty.md new file mode 100644 index 0000000000..e917f3eeb9 --- /dev/null +++ b/windows.ui.xaml.controls/grid_rowspacingproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Grid.RowSpacingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Grid.RowSpacingProperty + +## -description + +Identifies the RowSpacing dependency property. + +## -property-value + +The identifier for the RowSpacing dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/iconsource.md b/windows.ui.xaml.controls/iconsource.md new file mode 100644 index 0000000000..4691f26326 --- /dev/null +++ b/windows.ui.xaml.controls/iconsource.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.IconSource +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.IconSource + +## -description + +Represents the base class for an icon source. + +## -remarks + +**IconSource** is similar to [IconElement](iconelement.md). However, because it is not a [FrameworkElement](../windows.ui.xaml/frameworkelement.md), it can be shared. + +### IconSource derived classes + +**IconSource** is the parent class for these classes: + ++ [BitmapIconSource](bitmapiconsource.md) ++ [FontIconSource](fonticonsource.md) ++ [PathIconSource](pathiconsource.md) ++ [SymbolIconSource](symboliconsource.md) + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/iconsource_foreground.md b/windows.ui.xaml.controls/iconsource_foreground.md new file mode 100644 index 0000000000..3f71431266 --- /dev/null +++ b/windows.ui.xaml.controls/iconsource_foreground.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.IconSource.Foreground +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.IconSource.Foreground + +## -description + +Gets or sets a brush that describes the foreground color. + +## -xaml-syntax +```xaml + +``` + +```xaml + +``` + +## -xaml-values + +
resourceName
resourceNameThe resource name (x:Key attribute value) of an existing XAML resource that defines a brush. This is the recommended way to specify Brush values in XAML if you have any intention of using the same colors or brushes in more than one part of your UI. See Remarks in Brush or ResourceDictionary and XAML resource references.
+
colorString
colorStringThe Color for a SolidColorBrush expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+
+ +## -property-value + +The brush that paints the foreground of the control. The default is **null**, (a null brush) which is evaluated as [Transparent](../windows.ui/colors_transparent.md) for rendering. However, this value is typically set by a default system resource at runtime, which is tied to the active theme and other settings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/iconsource_foregroundproperty.md b/windows.ui.xaml.controls/iconsource_foregroundproperty.md new file mode 100644 index 0000000000..320d220de9 --- /dev/null +++ b/windows.ui.xaml.controls/iconsource_foregroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.IconSource.ForegroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.IconSource.ForegroundProperty + +## -description + +Identifies the Foreground dependency property. + +## -property-value + +The identifier for the Foreground dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/istexttrimmedchangedeventargs.md b/windows.ui.xaml.controls/istexttrimmedchangedeventargs.md new file mode 100644 index 0000000000..88d033d89d --- /dev/null +++ b/windows.ui.xaml.controls/istexttrimmedchangedeventargs.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.IsTextTrimmedChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.IsTextTrimmedChangedEventArgs + +## -description + +Provides event data for the **IsTextTrimmedChanged** event. + +## -remarks + +## -see-also + +- [TextBlock.IsTextTrimmed](textblock_istexttrimmed.md) +- [TextBlock.IsTextTrimmedChanged](textblock_istexttrimmedchanged.md) +- [RichTextBlock.IsTextTrimmed](richtextblock_istexttrimmed.md) +- [RichTextBlock.IsTextTrimmedChanged](richtextblock_istexttrimmedchanged.md) +- [RichTextBlockOverflow.IsTextTrimmed](richtextblockoverflow_istexttrimmed.md) +- [RichTextBlockOverflow.IsTextTrimmedChanged](richtextblockoverflow_istexttrimmedchanged.md) + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_hide_1985563870.md b/windows.ui.xaml.controls/mediatransportcontrols_hide_1985563870.md new file mode 100644 index 0000000000..62c8c0cd73 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_hide_1985563870.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.MediaTransportControls.Hide +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.Hide + +## -description + +Hides the transport controls if they're shown. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_isrepeatbuttonvisible.md b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatbuttonvisible.md new file mode 100644 index 0000000000..0d0a4bc711 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatbuttonvisible.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatButtonVisible +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatButtonVisible + +## -description + +Gets or sets a value that indicates whether the repeat button is shown. + +## -xaml-syntax + +```xaml + +``` + + +## -property-value + +**true** to show the repeat button. **false** to hide the repeat button. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_isrepeatbuttonvisibleproperty.md b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatbuttonvisibleproperty.md new file mode 100644 index 0000000000..e152e6d5a4 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatbuttonvisibleproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatButtonVisibleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatButtonVisibleProperty + +## -description + +Identifies the IsRepeatButtonVisible dependency property. + +## -property-value + +The identifier for the IsRepeatButtonVisible dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_isrepeatenabled.md b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatenabled.md new file mode 100644 index 0000000000..69248ef858 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatenabled.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatEnabled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatEnabled + +## -description + +Gets or sets a value that indicates whether a user repeat the playback of the media. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** to allow the user to repeat the media; otherwise, **false**. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_isrepeatenabledproperty.md b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatenabledproperty.md new file mode 100644 index 0000000000..2eb8aa4952 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_isrepeatenabledproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatEnabledProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.IsRepeatEnabledProperty + +## -description + +Identifies the IsRepeatEnabled dependency property. + +## -property-value + +The identifier for the IsRepeatEnabled dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_show_392493604.md b/windows.ui.xaml.controls/mediatransportcontrols_show_392493604.md new file mode 100644 index 0000000000..00b2bb2026 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_show_392493604.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.MediaTransportControls.Show +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.Show + +## -description + +Shows the tranport controls if they're hidden. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_showandhideautomatically.md b/windows.ui.xaml.controls/mediatransportcontrols_showandhideautomatically.md new file mode 100644 index 0000000000..4a0a797846 --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_showandhideautomatically.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.MediaTransportControls.ShowAndHideAutomatically +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.ShowAndHideAutomatically + +## -description + +Gets or sets a value that indicates whether the controls are shown and hidden automatically. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** if the controls are shown and hidden automatically; otherwise, **false**. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/mediatransportcontrols_showandhideautomaticallyproperty.md b/windows.ui.xaml.controls/mediatransportcontrols_showandhideautomaticallyproperty.md new file mode 100644 index 0000000000..e7abf3e01d --- /dev/null +++ b/windows.ui.xaml.controls/mediatransportcontrols_showandhideautomaticallyproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.MediaTransportControls.ShowAndHideAutomaticallyProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.MediaTransportControls.ShowAndHideAutomaticallyProperty + +## -description + +Identifies the ShowAndHideAutomatically dependency property. + +## -property-value + +The identifier for the ShowAndHideAutomatically dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview.md b/windows.ui.xaml.controls/navigationview.md index e541757ad0..50b9c42960 100644 --- a/windows.ui.xaml.controls/navigationview.md +++ b/windows.ui.xaml.controls/navigationview.md @@ -13,6 +13,12 @@ public class NavigationView : ContentControl, ContentControl Represents a container that enables navigation of app content. It has a header, a view for the main content, and a menu pane for navigation commands. +## -xaml-syntax + +```xaml + +``` + ## -remarks ## -see-also diff --git a/windows.ui.xaml.controls/navigationview_alwaysshowheader.md b/windows.ui.xaml.controls/navigationview_alwaysshowheader.md index 2630f1ba1c..689e281f0a 100644 --- a/windows.ui.xaml.controls/navigationview_alwaysshowheader.md +++ b/windows.ui.xaml.controls/navigationview_alwaysshowheader.md @@ -13,6 +13,12 @@ public bool AlwaysShowHeader { get; set; } Gets or sets a value that indicates whether the header is always visible. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the header is always visible; otherwise, **false**. diff --git a/windows.ui.xaml.controls/navigationview_autosuggestbox.md b/windows.ui.xaml.controls/navigationview_autosuggestbox.md new file mode 100644 index 0000000000..353f2d3c17 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_autosuggestbox.md @@ -0,0 +1,44 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.AutoSuggestBox +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.AutoSuggestBox + +## -description + +Gets or sets an [AutoSuggestBox](autosuggestbox.md) to be displayed in the NavigationView. + +## -xaml-syntax + +```xaml + + + + + +``` + +```xaml + +``` + +## -xaml-values + +
resourceReferenceToAutoSuggestBox
resourceReferenceToAutoSuggestBoxA {StaticResource} markup extension reference to an existing AutoSuggestBox from a XAML resource dictionary.
+
+ +## -property-value + +An [AutoSuggestBox](autosuggestbox.md) box to be displayed in the NavigationView. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_autosuggestboxproperty.md b/windows.ui.xaml.controls/navigationview_autosuggestboxproperty.md new file mode 100644 index 0000000000..58f8bc9ce8 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_autosuggestboxproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.AutoSuggestBoxProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.AutoSuggestBoxProperty + +## -description + +Identifies the AutoSuggestBox dependency property. + +## -property-value + +The identifier for the AutoSuggestBox dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_compactmodethresholdwidth.md b/windows.ui.xaml.controls/navigationview_compactmodethresholdwidth.md index f2c83d8bcc..b56da205b5 100644 --- a/windows.ui.xaml.controls/navigationview_compactmodethresholdwidth.md +++ b/windows.ui.xaml.controls/navigationview_compactmodethresholdwidth.md @@ -13,6 +13,12 @@ public double CompactModeThresholdWidth { get; set; } Gets or sets the minimum window width at which the NavigationView enters Compact display mode. +## -xaml-syntax + +```xaml + +``` + ## -property-value The minimum window width at which the NavigationView enters Compact display mode. The default is 641 pixels. diff --git a/windows.ui.xaml.controls/navigationview_compactpanelength.md b/windows.ui.xaml.controls/navigationview_compactpanelength.md index f7565da28c..e4c9db166c 100644 --- a/windows.ui.xaml.controls/navigationview_compactpanelength.md +++ b/windows.ui.xaml.controls/navigationview_compactpanelength.md @@ -13,6 +13,12 @@ public double CompactPaneLength { get; set; } Gets or sets the width of the NavigationView pane in its compact display mode. +## -xaml-syntax + +```xaml + +``` + ## -property-value The width of the pane in its compact display mode. The default is 48 device-independent pixel (DIP). diff --git a/windows.ui.xaml.controls/navigationview_containerfrommenuitem_1018415680.md b/windows.ui.xaml.controls/navigationview_containerfrommenuitem_1018415680.md new file mode 100644 index 0000000000..9e0ed10760 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_containerfrommenuitem_1018415680.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationView.ContainerFromMenuItem(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.ContainerFromMenuItem + +## -description + +Returns the container corresponding to the specified menu item. + +## -parameters + +### -param item + +The menu item to retrieve the container for. + +## -returns + +A container that corresponds to the specified menu item, if the item has a container and exists in the collection; otherwise, **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_displaymode.md b/windows.ui.xaml.controls/navigationview_displaymode.md index 861dded80c..4b5c792e9c 100644 --- a/windows.ui.xaml.controls/navigationview_displaymode.md +++ b/windows.ui.xaml.controls/navigationview_displaymode.md @@ -13,6 +13,13 @@ public NavigationViewDisplayMode DisplayMode { get; } Gets of sets a value that specifies how the pane and content areas of a NavigationView are shown. + +## -xaml-syntax + +```xaml + +``` + ## -property-value A value of the enumeration that specifies how the pane and content areas of a NavigationView are shown. diff --git a/windows.ui.xaml.controls/navigationview_displaymodechanged.md b/windows.ui.xaml.controls/navigationview_displaymodechanged.md index bed2540471..3cb558aab3 100644 --- a/windows.ui.xaml.controls/navigationview_displaymodechanged.md +++ b/windows.ui.xaml.controls/navigationview_displaymodechanged.md @@ -13,6 +13,12 @@ public event TypedEventHandler DisplayModeChanged +``` + ## -remarks ## -see-also diff --git a/windows.ui.xaml.controls/navigationview_expandedmodethresholdwidth.md b/windows.ui.xaml.controls/navigationview_expandedmodethresholdwidth.md index 84902adaa2..96b73024b5 100644 --- a/windows.ui.xaml.controls/navigationview_expandedmodethresholdwidth.md +++ b/windows.ui.xaml.controls/navigationview_expandedmodethresholdwidth.md @@ -11,11 +11,17 @@ public double ExpandedModeThresholdWidth { get; set; } ## -description -Gets or sets the minimum window width at which the NavigationView enters Expanded display mode. +Gets or sets the minimum window width at which the NavigationView enters **Expanded** display mode. + +## -xaml-syntax + +```xaml + +``` ## -property-value -The minimum window width at which the NavigationView enters Expanded display mode. The default is 1008 pixels. +The minimum window width at which the NavigationView enters **Expanded** display mode. The default is 1008 pixels. ## -remarks diff --git a/windows.ui.xaml.controls/navigationview_header.md b/windows.ui.xaml.controls/navigationview_header.md index 979860420c..a70a026285 100644 --- a/windows.ui.xaml.controls/navigationview_header.md +++ b/windows.ui.xaml.controls/navigationview_header.md @@ -13,6 +13,26 @@ public object Header { get; set; } Gets or sets the header content. +## -xaml-syntax + +```xaml + +``` + +```xaml + + + headerObject + + +``` + +## -xaml-values + +
headerString
headerStringA text string that serves as header content.
+
headerObject
headerObjectAn single object element that serves as header content. Use discretion when using objects as header content; not all objects are suitable for use within the limited presentation surface that appears for headers.
+
+ ## -property-value The header content for the NavigationView. diff --git a/windows.ui.xaml.controls/navigationview_headertemplate.md b/windows.ui.xaml.controls/navigationview_headertemplate.md index 5525383438..633bd3d20a 100644 --- a/windows.ui.xaml.controls/navigationview_headertemplate.md +++ b/windows.ui.xaml.controls/navigationview_headertemplate.md @@ -13,6 +13,28 @@ public DataTemplate HeaderTemplate { get; set; } Gets or sets the DataTemplate used to display the control's header. +## -xaml-syntax + +```xaml + +``` + +```xaml + + + + dataTemplateDefinition + + + +``` + +## -xaml-values + +
resourceReferenceToDataTemplate
resourceReferenceToDataTemplateA resource reference to an existing DataTemplate from a resources collection. The resource reference must specify the desired DataTemplate by key through a {StaticResource} markup extension usage.
+
dataTemplateDefinition
dataTemplateDefinitionDefinition for the DataTemplate, including its root element container and parts within that present the data-based content.
+
+ ## -property-value The DataTemplate used to display the control's header. diff --git a/windows.ui.xaml.controls/navigationview_ispaneopen.md b/windows.ui.xaml.controls/navigationview_ispaneopen.md index a88c1f7b3f..ed59ce86cf 100644 --- a/windows.ui.xaml.controls/navigationview_ispaneopen.md +++ b/windows.ui.xaml.controls/navigationview_ispaneopen.md @@ -13,6 +13,12 @@ public bool IsPaneOpen { get; set; } Gets or sets a value that specifies whether the NavigationView pane is expanded to its full width. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the pane is expanded to its full width; otherwise, **false**. diff --git a/windows.ui.xaml.controls/navigationview_ispanetogglebuttonvisible.md b/windows.ui.xaml.controls/navigationview_ispanetogglebuttonvisible.md index 7dc5e0492a..4eac60fb6b 100644 --- a/windows.ui.xaml.controls/navigationview_ispanetogglebuttonvisible.md +++ b/windows.ui.xaml.controls/navigationview_ispanetogglebuttonvisible.md @@ -13,6 +13,12 @@ public bool IsPaneToggleButtonVisible { get; set; } Gets or sets a value that indicates whether the menu toggle button is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the menu button is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/navigationview_issettingsvisible.md b/windows.ui.xaml.controls/navigationview_issettingsvisible.md index 46063365f6..15c70f309f 100644 --- a/windows.ui.xaml.controls/navigationview_issettingsvisible.md +++ b/windows.ui.xaml.controls/navigationview_issettingsvisible.md @@ -13,6 +13,12 @@ public bool IsSettingsVisible { get; set; } Gets or sets a value that indicates whether the settings button is shown. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the settings button is shown; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/navigationview_iteminvoked.md b/windows.ui.xaml.controls/navigationview_iteminvoked.md new file mode 100644 index 0000000000..59931957fb --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_iteminvoked.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.NavigationView.ItemInvoked +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.ItemInvoked + +## -description + +Occurs when an item in the menu receives an interaction such a a click or tap. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemcontainerstyle.md b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyle.md new file mode 100644 index 0000000000..0fc73717bf --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyle.md @@ -0,0 +1,45 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyle +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyle + +## -description + +Gets or sets the style that is used when rendering the menu item containers. + +## -xaml-syntax + +```xaml + + + inlineStyle + + +``` + +```xaml + +``` + +## -xaml-values + +
inlineStyle
inlineStyleA single Style object element. That Style would typically have multiple setters that set properties on the item container type being targeted. (For ListBox, that type is ListBoxItem.)
+
resourceReferenceToStyle
resourceReferenceToStyleA {StaticResource} markup extension reference to an existing Style from a XAML resource dictionary.
+
+ +## -property-value + +The style applied to the item containers. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleproperty.md b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleproperty.md new file mode 100644 index 0000000000..7491e8c5ce --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyleProperty + +## -description + +Identifies the MenuItemContainerStyle dependency property. + +## -property-value + +The identifier for the MenuItemContainerStyle dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleselector.md b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleselector.md new file mode 100644 index 0000000000..2c7504cac1 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleselector.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyleSelector +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyleSelector + +## -description + +Gets or sets a reference to a custom [StyleSelector](styleselector.md) logic class. The [StyleSelector](styleselector.md) returns different [Style](../windows.ui.xaml/style.md) values to use for the item container based on characteristics of the object being displayed. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
styleSelectorReference
styleSelectorReferenceA reference to an existing StyleSelector. Typically this is a keyed resource, which you reference through a {StaticResource} markup extension usage.
+
+ +## -property-value + +A custom [StyleSelector](styleselector.md) logic class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleselectorproperty.md b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleselectorproperty.md new file mode 100644 index 0000000000..6a2561ae50 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemcontainerstyleselectorproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyleSelectorProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemContainerStyleSelectorProperty + +## -description + +Identifies the MenuItemContainerStyleSelector dependency property. + +## -property-value + +The identifier for the MenuItemContainerStyleSelector dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemfromcontainer_80886439.md b/windows.ui.xaml.controls/navigationview_menuitemfromcontainer_80886439.md new file mode 100644 index 0000000000..f0f8006a34 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemfromcontainer_80886439.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationView.MenuItemFromContainer(Windows.UI.Xaml.DependencyObject) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemFromContainer + +## -description + +Returns the item that corresponds to the specified, generated container. + +## -parameters + +### -param container + +The [DependencyObject](../windows.ui.xaml/dependencyobject.md) that corresponds to the item to be returned. + +## -returns + +The contained item, or the container if it does not contain an item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemssource.md b/windows.ui.xaml.controls/navigationview_menuitemssource.md new file mode 100644 index 0000000000..176dc4b431 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemssource.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemsSource +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemsSource + +## -description + +Gets or sets an object source used to generate the content of the NavigationView menu. + +## -xaml-syntax + +```xaml + +-or- + +``` + + +## -xaml-values + +
bindingDeclaration
bindingDeclarationA Binding declaration using a {Binding ....} markup extension. For more information, see {Binding} markup extension.
+
resourceReferenceToSource
resourceReferenceToSourceA resource reference to an existing iterable/enumerable items source from a resources collection. The resource reference must specify the desired items source by key.
+
+ +## -property-value + +The object that is used to generate the content of the NavigationView menu. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemssourceproperty.md b/windows.ui.xaml.controls/navigationview_menuitemssourceproperty.md new file mode 100644 index 0000000000..eeb2abf91e --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemssourceproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemsSourceProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemsSourceProperty + +## -description + +Identifies the MenuItemsSource dependency property. + +## -property-value + +The identifier for the MenuItemsSource dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemtemplate.md b/windows.ui.xaml.controls/navigationview_menuitemtemplate.md new file mode 100644 index 0000000000..8a11763b35 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemtemplate.md @@ -0,0 +1,46 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplate +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplate + +## -description + +Gets or sets the [DataTemplate](../windows.ui.xaml/datatemplate.md) used to display each menu item. + +## -xaml-syntax + +```xaml + + + singleDataTemplate + + +``` + +```xaml + +``` + + +## -xaml-values + +
singleDataTemplate
singleDataTemplateA single DataTemplate object element. That DataTemplate would typically have multiple child elements that define the visual appearance of the data representation.
+
resourceReferenceToDataTemplate
resourceReferenceToDataTemplateA resource reference to an existing DataTemplate from a resources collection. The resource reference must specify the desired DataTemplate by key through a {StaticResource} markup extension usage.
+
+ +## -property-value + +The template that specifies the visualization of the menu data objects. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemtemplateproperty.md b/windows.ui.xaml.controls/navigationview_menuitemtemplateproperty.md new file mode 100644 index 0000000000..e5953abb13 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemtemplateproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplateProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplateProperty + +## -description + +Identifies the MenuItemTemplate dependency property. + +## -property-value + +The identifier for the MenuItemTemplate dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemtemplateselector.md b/windows.ui.xaml.controls/navigationview_menuitemtemplateselector.md new file mode 100644 index 0000000000..0f3cf332ce --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemtemplateselector.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplateSelector +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplateSelector + +## -description + +Gets or sets a reference to a custom [DataTemplateSelector](datatemplateselector.md) logic class. The [DataTemplateSelector](datatemplateselector.md) referenced by this property returns a template to apply to items. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
dataTemplateSelectorReference
dataTemplateSelectorReferenceA reference to an existing DataTemplateSelector. Typically this is a keyed resource, which you reference through {StaticResource} markup extension.
+
+ +## -property-value + +A reference to a custom [DataTemplateSelector](datatemplateselector.md) logic class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_menuitemtemplateselectorproperty.md b/windows.ui.xaml.controls/navigationview_menuitemtemplateselectorproperty.md new file mode 100644 index 0000000000..f702da606e --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_menuitemtemplateselectorproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplateSelectorProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.MenuItemTemplateSelectorProperty + +## -description + +Identifies the MenuItemTemplateSelector dependency property. + +## -property-value + +The identifier for the MenuItemTemplateSelector dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_panefooter.md b/windows.ui.xaml.controls/navigationview_panefooter.md index b726a91a53..b35e26fe7b 100644 --- a/windows.ui.xaml.controls/navigationview_panefooter.md +++ b/windows.ui.xaml.controls/navigationview_panefooter.md @@ -13,6 +13,21 @@ public UIElement PaneFooter { get; set; } Gets or sets the content for the pane footer. +## -xaml-syntax + +```xaml + + + footerElement + + +``` + +## -xaml-values + +
footerElement
footerElementA single UI element that serves as footer content. This can be a panel that contains other UI elements.
+ + ## -property-value The content of the pane footer. The default is **null**. diff --git a/windows.ui.xaml.controls/navigationview_panetogglebuttonstyle.md b/windows.ui.xaml.controls/navigationview_panetogglebuttonstyle.md index af1793bf3c..e387f01d48 100644 --- a/windows.ui.xaml.controls/navigationview_panetogglebuttonstyle.md +++ b/windows.ui.xaml.controls/navigationview_panetogglebuttonstyle.md @@ -13,6 +13,16 @@ public Style PaneToggleButtonStyle { get; set; } Gets or sets the Style that defines the look of the menu toggle button. +## -xaml-syntax +```xaml + +``` + + +## -xaml-values +
styleResourceKey
styleResourceKeyThe key that identifies the style being requested. The key refers to an existing resource in a ResourceDictionary.
+
+ ## -property-value The Style that defines the look of the menu toggle button. The default is **null**. diff --git a/windows.ui.xaml.controls/navigationview_selecteditem.md b/windows.ui.xaml.controls/navigationview_selecteditem.md new file mode 100644 index 0000000000..80f5265185 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_selecteditem.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.SelectedItem +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.SelectedItem + +## -description + +Gets or sets the selected item. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
bindingReference
bindingReferenceA data binding reference to a specific item from the data collection that populates the control.
+
+ +## -property-value + +The selected item. The default is null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_selecteditemproperty.md b/windows.ui.xaml.controls/navigationview_selecteditemproperty.md new file mode 100644 index 0000000000..864f9702a9 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_selecteditemproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.SelectedItemProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.SelectedItemProperty + +## -description + +Identifies the SelectedItem dependency property. + +## -property-value + +The identifier for the SelectedItem dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_selectionchanged.md b/windows.ui.xaml.controls/navigationview_selectionchanged.md new file mode 100644 index 0000000000..d668f9b6df --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_selectionchanged.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.NavigationView.SelectionChanged +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.SelectionChanged + +## -description + +Occurs when the currently selected item changes. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_settingsitem.md b/windows.ui.xaml.controls/navigationview_settingsitem.md new file mode 100644 index 0000000000..9548d57534 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_settingsitem.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.SettingsItem +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.SettingsItem + +## -description + +Gets the navigation item that represents the entry point to app settings. + +## -property-value + +The item that represents the entry point to app settings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationview_settingsitemproperty.md b/windows.ui.xaml.controls/navigationview_settingsitemproperty.md new file mode 100644 index 0000000000..a37d879946 --- /dev/null +++ b/windows.ui.xaml.controls/navigationview_settingsitemproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationView.SettingsItemProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationView.SettingsItemProperty + +## -description + +Identifies the SettingsItem dependency property. + +## -property-value + +The identifier for the SettingsItem dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewdisplaymodechangedeventargs.md b/windows.ui.xaml.controls/navigationviewdisplaymodechangedeventargs.md new file mode 100644 index 0000000000..3fb0e6346e --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewdisplaymodechangedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewDisplayModeChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewDisplayModeChangedEventArgs + +## -description + +Provides data for the [NavigationView.DisplayModeChanged](navigationview_displaymodechanged.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewdisplaymodechangedeventargs_displaymode.md b/windows.ui.xaml.controls/navigationviewdisplaymodechangedeventargs_displaymode.md new file mode 100644 index 0000000000..eaa102ae20 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewdisplaymodechangedeventargs_displaymode.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewDisplayModeChangedEventArgs.DisplayMode +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewDisplayModeChangedEventArgs.DisplayMode + +## -description + +Gets the new display mode. + +## -property-value + +The new display mode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitem.md b/windows.ui.xaml.controls/navigationviewitem.md new file mode 100644 index 0000000000..0458508ce7 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitem.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewItem +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItem + +## -description + +Represents the container for an item in a [NavigationView](navigationview.md) control. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitem_compactpanelength.md b/windows.ui.xaml.controls/navigationviewitem_compactpanelength.md new file mode 100644 index 0000000000..c2393ba9bc --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitem_compactpanelength.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewItem.CompactPaneLength +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItem.CompactPaneLength + +## -description + +Gets the [CompactPaneLength](navigationview_compactpanelength.md) of the NavigationView that hosts this item. + +## -property-value + +The [CompactPaneLength](navigationview_compactpanelength.md) of the NavigationView that hosts this item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitem_compactpanelengthproperty.md b/windows.ui.xaml.controls/navigationviewitem_compactpanelengthproperty.md new file mode 100644 index 0000000000..06a1e9cbff --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitem_compactpanelengthproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewItem.CompactPaneLengthProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItem.CompactPaneLengthProperty + +## -description + +Identifies the CompactPaneLength dependency property. + +## -property-value + +The identifier for the CompactPaneLength dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitem_icon.md b/windows.ui.xaml.controls/navigationviewitem_icon.md new file mode 100644 index 0000000000..dba564a061 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitem_icon.md @@ -0,0 +1,45 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewItem.Icon +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItem.Icon + +## -description + +Gets or sets the icon to show next to the menu item text. + +## -xaml-syntax + +```xaml + +``` + +```xaml + + +   iconElement + + +``` + +## -xaml-values + +
symbolName
symbolNameA named constant of the Symbol enumeration.
+
iconElement
iconElementA single object element that derives from IconElement and describes the graphic content of the button. The object element is typically one of these classes: SymbolIcon, FontIcon, or PathIcon.
+
+ +## -property-value + +The icon to show next to the menu item text. The default in **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitem_iconproperty.md b/windows.ui.xaml.controls/navigationviewitem_iconproperty.md new file mode 100644 index 0000000000..a33277b007 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitem_iconproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewItem.IconProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItem.IconProperty + +## -description + +Identifies the Icon dependency property. + +## -property-value + +The identifier for the Icon dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitem_navigationviewitem_1221375020.md b/windows.ui.xaml.controls/navigationviewitem_navigationviewitem_1221375020.md new file mode 100644 index 0000000000..3dcea75e1c --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitem_navigationviewitem_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationViewItem.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItem.NavigationViewItem + +## -description + +Initializes a new instance of the NavigationViewItem class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitembase.md b/windows.ui.xaml.controls/navigationviewitembase.md new file mode 100644 index 0000000000..5d5f20c9a9 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitembase.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewItemBase +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemBase + +## -description + +Base class for [NavigationView](navigationview.md) menu items. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitemheader.md b/windows.ui.xaml.controls/navigationviewitemheader.md new file mode 100644 index 0000000000..7dded60745 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitemheader.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewItemHeader +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemHeader + +## -description + +Represents a header for a group of menu items in a NavigationMenu. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitemheader_navigationviewitemheader_1221375020.md b/windows.ui.xaml.controls/navigationviewitemheader_navigationviewitemheader_1221375020.md new file mode 100644 index 0000000000..8d9c0619d0 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitemheader_navigationviewitemheader_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationViewItemHeader.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemHeader.NavigationViewItemHeader + +## -description + +Initializes a new instance of the NavigationViewItemHeader class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewiteminvokedeventargs.md b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs.md new file mode 100644 index 0000000000..2fe72659e8 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs + +## -description + +Provides event data for the [NavigationView.ItemInvoked](navigationview_iteminvoked.md) event. + +## -remarks + +## -see-also + +[RoutedEventArgs](../windows.ui.xaml/routedeventargs.md) + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_invokeditem.md b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_invokeditem.md new file mode 100644 index 0000000000..08be11fe7e --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_invokeditem.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs.InvokedItem +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs.InvokedItem + +## -description + +Gets a reference to the invoked item. + +## -property-value + +The invoked item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_issettingsinvoked.md b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_issettingsinvoked.md new file mode 100644 index 0000000000..c404d2c81f --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_issettingsinvoked.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs.IsSettingsInvoked +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs.IsSettingsInvoked + +## -description + +Gets a value that indicates whether the **InvokedItem** is the menu item for Settings. + +## -property-value + +**true** if the **InvokedItem** is the menu item for Settings; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_navigationviewiteminvokedeventargs_1221375020.md b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_navigationviewiteminvokedeventargs_1221375020.md new file mode 100644 index 0000000000..1d554d3497 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewiteminvokedeventargs_navigationviewiteminvokedeventargs_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemInvokedEventArgs.NavigationViewItemInvokedEventArgs + +## -description + +Initializes a new instance of the NavigationViewItemInvokedEventArgs class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitemseparator.md b/windows.ui.xaml.controls/navigationviewitemseparator.md new file mode 100644 index 0000000000..21a5d08732 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitemseparator.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewItemSeparator +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemSeparator + +## -description + +Represents a line that separates menu items in a NavigationMenu. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewitemseparator_navigationviewitemseparator_1221375020.md b/windows.ui.xaml.controls/navigationviewitemseparator_navigationviewitemseparator_1221375020.md new file mode 100644 index 0000000000..7b28b4eed3 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewitemseparator_navigationviewitemseparator_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationViewItemSeparator.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewItemSeparator.NavigationViewItemSeparator + +## -description + +Initializes a new instance of the NavigationViewItemSeparator class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewlist.md b/windows.ui.xaml.controls/navigationviewlist.md new file mode 100644 index 0000000000..d00af00ad2 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewlist.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewList +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewList + +## -description + +Represents a control that displays menu items in a [NavigationView](navigationview.md) control. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewlist_navigationviewlist_1221375020.md b/windows.ui.xaml.controls/navigationviewlist_navigationviewlist_1221375020.md new file mode 100644 index 0000000000..da5b9a4612 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewlist_navigationviewlist_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.NavigationViewList.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewList.NavigationViewList + +## -description + +Initializes a new instance of the NavigationViewList class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewselectionchangedeventargs.md b/windows.ui.xaml.controls/navigationviewselectionchangedeventargs.md new file mode 100644 index 0000000000..f169797940 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewselectionchangedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.NavigationViewSelectionChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewSelectionChangedEventArgs + +## -description + +Provides data for the [NavigationView.SelectionChanged](navigationview_selectionchanged.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewselectionchangedeventargs_issettingsselected.md b/windows.ui.xaml.controls/navigationviewselectionchangedeventargs_issettingsselected.md new file mode 100644 index 0000000000..4d43f68a61 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewselectionchangedeventargs_issettingsselected.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewSelectionChangedEventArgs.IsSettingsSelected +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewSelectionChangedEventArgs.IsSettingsSelected + +## -description + +Gets a value that indicates whether the **SelectedItem** is the menu item for Settings. + +## -property-value + +**true** if the **SelectedItem** is the menu item for Settings; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/navigationviewselectionchangedeventargs_selecteditem.md b/windows.ui.xaml.controls/navigationviewselectionchangedeventargs_selecteditem.md new file mode 100644 index 0000000000..1b1c832a06 --- /dev/null +++ b/windows.ui.xaml.controls/navigationviewselectionchangedeventargs_selecteditem.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.NavigationViewSelectionChangedEventArgs.SelectedItem +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.NavigationViewSelectionChangedEventArgs.SelectedItem + +## -description + +Gets the newly selected menu item. + +## -property-value + +The newly selected menu item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/parallaxview.md b/windows.ui.xaml.controls/parallaxview.md index 910063ee13..1729bcbfd2 100644 --- a/windows.ui.xaml.controls/parallaxview.md +++ b/windows.ui.xaml.controls/parallaxview.md @@ -13,6 +13,12 @@ public class ParallaxView : FrameworkElement, FrameworkElement Represents a container that ties the scroll position of a foreground element, such as a list, to a background element, such as an image. As you scroll through the foreground element, it animates the background element to create a parallax effect. +## -xaml-syntax + +```xaml + +``` + ## -remarks ## -see-also diff --git a/windows.ui.xaml.controls/parallaxview_child.md b/windows.ui.xaml.controls/parallaxview_child.md index 9624efe2b8..3bb707b9a6 100644 --- a/windows.ui.xaml.controls/parallaxview_child.md +++ b/windows.ui.xaml.controls/parallaxview_child.md @@ -13,6 +13,12 @@ public UIElement Child { get; set; } Gets or sets the background content of the ParallaxView. +## -xaml-syntax + +```xaml + +``` + ## -property-value The background content of the ParallaxView, typically an image. The default is **null**. diff --git a/windows.ui.xaml.controls/parallaxview_horizontalshift.md b/windows.ui.xaml.controls/parallaxview_horizontalshift.md index 956ce93a78..a59ee34316 100644 --- a/windows.ui.xaml.controls/parallaxview_horizontalshift.md +++ b/windows.ui.xaml.controls/parallaxview_horizontalshift.md @@ -13,6 +13,12 @@ public double HorizontalShift { get; set; } Represents the horizontal range of motion of the child element. +## -xaml-syntax + +```xaml + +``` + ## -property-value The horizontal range of motion. The default is 0. diff --git a/windows.ui.xaml.controls/parallaxview_horizontalsourceendoffset.md b/windows.ui.xaml.controls/parallaxview_horizontalsourceendoffset.md index 61d48d4288..2fdc358d44 100644 --- a/windows.ui.xaml.controls/parallaxview_horizontalsourceendoffset.md +++ b/windows.ui.xaml.controls/parallaxview_horizontalsourceendoffset.md @@ -13,6 +13,12 @@ public double HorizontalSourceEndOffset { get; set; } Represents the horizontal scroll offset at which the parallax motion ends. +## -xaml-syntax + +```xaml + +``` + ## -property-value The horizontal scroll offset at which parallax motion ends. The default is 0. diff --git a/windows.ui.xaml.controls/parallaxview_horizontalsourceoffsetkind.md b/windows.ui.xaml.controls/parallaxview_horizontalsourceoffsetkind.md index d235d444f8..3def729ea4 100644 --- a/windows.ui.xaml.controls/parallaxview_horizontalsourceoffsetkind.md +++ b/windows.ui.xaml.controls/parallaxview_horizontalsourceoffsetkind.md @@ -13,6 +13,12 @@ public ParallaxSourceOffsetKind HorizontalSourceOffsetKind { get; set; } Gets or sets a value that determines how the horizontal source offset values of a ParallaxView are interpreted. +## -xaml-syntax + +```xaml + +``` + ## -property-value A value of the enumeration that determines how the horizontal source offset values of a ParallaxView are interpreted. diff --git a/windows.ui.xaml.controls/parallaxview_horizontalsourcestartoffset.md b/windows.ui.xaml.controls/parallaxview_horizontalsourcestartoffset.md index 28ff7eaec9..2332c80e00 100644 --- a/windows.ui.xaml.controls/parallaxview_horizontalsourcestartoffset.md +++ b/windows.ui.xaml.controls/parallaxview_horizontalsourcestartoffset.md @@ -13,6 +13,12 @@ public double HorizontalSourceStartOffset { get; set; } Represents the horizontal scroll offset at which parallax motion starts. +## -xaml-syntax + +```xaml + +``` + ## -property-value The horizontal scroll offset at which parallax motion starts. The default is 0. diff --git a/windows.ui.xaml.controls/parallaxview_ishorizontalshiftclamped.md b/windows.ui.xaml.controls/parallaxview_ishorizontalshiftclamped.md index 15cbeebb5d..7044958af2 100644 --- a/windows.ui.xaml.controls/parallaxview_ishorizontalshiftclamped.md +++ b/windows.ui.xaml.controls/parallaxview_ishorizontalshiftclamped.md @@ -13,6 +13,12 @@ public bool IsHorizontalShiftClamped { get; set; } Gets or sets a value that indicates whether the horizontal parallax ratio is clampled to a specified percentage of the source scroll velocity. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the parallax ratio is clampled to a specified percentage of the source scroll velocity; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/parallaxview_isverticalshiftclamped.md b/windows.ui.xaml.controls/parallaxview_isverticalshiftclamped.md index 4321f56e25..ef732420c6 100644 --- a/windows.ui.xaml.controls/parallaxview_isverticalshiftclamped.md +++ b/windows.ui.xaml.controls/parallaxview_isverticalshiftclamped.md @@ -13,6 +13,12 @@ public bool IsVerticalShiftClamped { get; set; } Gets or sets a value that indicates whether the vertical parallax ratio is clampled to a specified percentage of the source scroll velocity. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the parallax ratio is clampled to a specified percentage of the source scroll velocity; otherwise, **false**. The default is **true**. diff --git a/windows.ui.xaml.controls/parallaxview_maxhorizontalshiftratio.md b/windows.ui.xaml.controls/parallaxview_maxhorizontalshiftratio.md index 5400c387b0..5d1e7e41f5 100644 --- a/windows.ui.xaml.controls/parallaxview_maxhorizontalshiftratio.md +++ b/windows.ui.xaml.controls/parallaxview_maxhorizontalshiftratio.md @@ -13,6 +13,12 @@ public double MaxHorizontalShiftRatio { get; set; } Clamps the horizontal parallax ratio to the specified percentage of the source scroll velocity. +## -xaml-syntax + +```xaml + +``` + ## -property-value The maximum percentage of the source scroll velocity. The default is 1.0. diff --git a/windows.ui.xaml.controls/parallaxview_maxverticalshiftratio.md b/windows.ui.xaml.controls/parallaxview_maxverticalshiftratio.md index 45d10059c3..318b66d8cd 100644 --- a/windows.ui.xaml.controls/parallaxview_maxverticalshiftratio.md +++ b/windows.ui.xaml.controls/parallaxview_maxverticalshiftratio.md @@ -13,6 +13,12 @@ public double MaxVerticalShiftRatio { get; set; } Clamps the vertical parallax ratio to the specified percentage of the source scroll velocity. +## -xaml-syntax + +```xaml + +``` + ## -property-value The maximum percentage of the source scroll velocity. The default is 1.0. diff --git a/windows.ui.xaml.controls/parallaxview_source.md b/windows.ui.xaml.controls/parallaxview_source.md index 1628079415..b539cd6218 100644 --- a/windows.ui.xaml.controls/parallaxview_source.md +++ b/windows.ui.xaml.controls/parallaxview_source.md @@ -13,6 +13,12 @@ public UIElement Source { get; set; } The element that either is or contains the ScrollViewer that controls the parallax operation. +## -xaml-syntax + +```xaml + +``` + ## -property-value ## -remarks diff --git a/windows.ui.xaml.controls/parallaxview_verticalshift.md b/windows.ui.xaml.controls/parallaxview_verticalshift.md index 5309037afc..41178c9726 100644 --- a/windows.ui.xaml.controls/parallaxview_verticalshift.md +++ b/windows.ui.xaml.controls/parallaxview_verticalshift.md @@ -13,6 +13,12 @@ public double VerticalShift { get; set; } Represents the vertical range of motion of the child element. +## -xaml-syntax + +```xaml + +``` + ## -property-value The vertical range of motion. The default is 0. diff --git a/windows.ui.xaml.controls/parallaxview_verticalsourceendoffset.md b/windows.ui.xaml.controls/parallaxview_verticalsourceendoffset.md index 29c6f70709..75ab71f23a 100644 --- a/windows.ui.xaml.controls/parallaxview_verticalsourceendoffset.md +++ b/windows.ui.xaml.controls/parallaxview_verticalsourceendoffset.md @@ -13,6 +13,12 @@ public double VerticalSourceEndOffset { get; set; } Represents the vertical scroll offset at which the parallax motion ends. +## -xaml-syntax + +```xaml + +``` + ## -property-value The vertical scroll offset at which parallax motion ends. The default is 0. diff --git a/windows.ui.xaml.controls/parallaxview_verticalsourceoffsetkind.md b/windows.ui.xaml.controls/parallaxview_verticalsourceoffsetkind.md index 20ea20f7ef..b1e5c104a6 100644 --- a/windows.ui.xaml.controls/parallaxview_verticalsourceoffsetkind.md +++ b/windows.ui.xaml.controls/parallaxview_verticalsourceoffsetkind.md @@ -13,6 +13,12 @@ public ParallaxSourceOffsetKind VerticalSourceOffsetKind { get; set; } Gets or sets a value that determines how the vertical source offset values of a ParallaxView are interpreted. +## -xaml-syntax + +```xaml + +``` + ## -property-value A value of the enumeration that determines how the vertical source offset values of a ParallaxView are interpreted. diff --git a/windows.ui.xaml.controls/parallaxview_verticalsourcestartoffset.md b/windows.ui.xaml.controls/parallaxview_verticalsourcestartoffset.md index b088ff6b5c..8313ebfd1e 100644 --- a/windows.ui.xaml.controls/parallaxview_verticalsourcestartoffset.md +++ b/windows.ui.xaml.controls/parallaxview_verticalsourcestartoffset.md @@ -13,6 +13,12 @@ public double VerticalSourceStartOffset { get; set; } Represents the vertical scroll offset at which parallax motion starts. +## -xaml-syntax + +```xaml + +``` + ## -property-value The vertical scroll offset at which parallax motion starts. The default is 0. diff --git a/windows.ui.xaml.controls/passwordbox_passwordchanging.md b/windows.ui.xaml.controls/passwordbox_passwordchanging.md new file mode 100644 index 0000000000..385bf6930c --- /dev/null +++ b/windows.ui.xaml.controls/passwordbox_passwordchanging.md @@ -0,0 +1,29 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.PasswordBox.PasswordChanging +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.PasswordBox.PasswordChanging + +## -description + +Occurs synchronously when the text in the password box starts to change, but before it is rendered. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +[TextBox.TextChanging](textbox_textchanging.md) + +## -examples + diff --git a/windows.ui.xaml.controls/passwordboxpasswordchangingeventargs.md b/windows.ui.xaml.controls/passwordboxpasswordchangingeventargs.md new file mode 100644 index 0000000000..b1a4ec3da6 --- /dev/null +++ b/windows.ui.xaml.controls/passwordboxpasswordchangingeventargs.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.PasswordBoxPasswordChangingEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.PasswordBoxPasswordChangingEventArgs + +## -description + +Provides event data for the [PasswordBox.PasswordChanging](passwordbox_passwordchanging.md) event. + +## -remarks + +An instance of this class is passed as a parameter to the [PasswordBox.PasswordChanging](passwordbox_passwordchanging.md) event handler. + +## -see-also + +[PasswordBox.PasswordChanging](passwordbox_passwordchanging.md) + +## -examples + diff --git a/windows.ui.xaml.controls/passwordboxpasswordchangingeventargs_iscontentchanging.md b/windows.ui.xaml.controls/passwordboxpasswordchangingeventargs_iscontentchanging.md new file mode 100644 index 0000000000..65e3362007 --- /dev/null +++ b/windows.ui.xaml.controls/passwordboxpasswordchangingeventargs_iscontentchanging.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.PasswordBoxPasswordChangingEventArgs.IsContentChanging +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.PasswordBoxPasswordChangingEventArgs.IsContentChanging + +## -description + +Gets a value that indicates whether the event occured due to a change in the text content. + +## -property-value + +**true** if a change to the text content caused the event; otherwise, **false**. + +## -remarks + +This event occurs for a format or content change. The IsContentChanging property helps to distinguish when text content is changing. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls/pathiconsource.md b/windows.ui.xaml.controls/pathiconsource.md new file mode 100644 index 0000000000..89ebdce4e2 --- /dev/null +++ b/windows.ui.xaml.controls/pathiconsource.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.PathIconSource +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.PathIconSource + +## -description + +Represents an icon source that uses a vector path as its content. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +**PathIconSource** is similar to [PathIcon](pathicon.md). However, because it is not a [FrameworkElement](../windows.ui.xaml/frameworkelement.md), it can be shared. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/pathiconsource_data.md b/windows.ui.xaml.controls/pathiconsource_data.md new file mode 100644 index 0000000000..3c7cf3915c --- /dev/null +++ b/windows.ui.xaml.controls/pathiconsource_data.md @@ -0,0 +1,45 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.PathIconSource.Data +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.PathIconSource.Data + +## -description + +Gets or sets a [Geometry](../windows.ui.xaml.media/geometry.md) that specifies the shape to be drawn. In XAML. this can also be set using a string that describes [Move and draw commands syntax](http://msdn.microsoft.com/library/7772bc3e-a631-46ff-9940-3dd5b9d0e0d9). + +## -xaml-syntax + +```xaml + + + singleGeometry + + +``` + +```xaml + +``` + +## -xaml-values + +
singleGeometry
singleGeometryA single object element that derives from Geometry. This can be one of the following: One of the simple geometries EllipseGeometry, LineGeometry, or RectangleGeometry.A single GeometryGroup, which supports other geometries as child elements. A PathGeometry, which supports child object elements that establish a path geometry object model of figures and segments. See the "XAML Values" section of PathGeometry.
+
moveAndDrawCommands
moveAndDrawCommandsThis is a complex syntax that cannot be adequately summarized here. See Move and draw commands syntax.
+
+ +## -property-value + +A description of the shape to be drawn. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/pathiconsource_dataproperty.md b/windows.ui.xaml.controls/pathiconsource_dataproperty.md new file mode 100644 index 0000000000..861589449d --- /dev/null +++ b/windows.ui.xaml.controls/pathiconsource_dataproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.PathIconSource.DataProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.PathIconSource.DataProperty + +## -description + +Identifies the Data dependency property. + +## -property-value + +The identifier for the Data dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/pathiconsource_pathiconsource_1221375020.md b/windows.ui.xaml.controls/pathiconsource_pathiconsource_1221375020.md new file mode 100644 index 0000000000..6d63ec7c6d --- /dev/null +++ b/windows.ui.xaml.controls/pathiconsource_pathiconsource_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.PathIconSource.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.PathIconSource.PathIconSource + +## -description + +Initializes a new instance of the PathIconSource class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/personpicture.md b/windows.ui.xaml.controls/personpicture.md index aab1d6a275..bf6616c1ce 100644 --- a/windows.ui.xaml.controls/personpicture.md +++ b/windows.ui.xaml.controls/personpicture.md @@ -13,6 +13,12 @@ public class PersonPicture : Control, Control Represents a control that displays the avatar image for a person, if one is available; if not, it displays the person's initials or a generic glyph. +## -xaml-syntax + +```xaml + +``` + ## -remarks ## -see-also diff --git a/windows.ui.xaml.controls/personpicture_badgeglyph.md b/windows.ui.xaml.controls/personpicture_badgeglyph.md index e41a4c59ca..0c3d8fb119 100644 --- a/windows.ui.xaml.controls/personpicture_badgeglyph.md +++ b/windows.ui.xaml.controls/personpicture_badgeglyph.md @@ -11,11 +11,22 @@ public string BadgeGlyph { get; set; } ## -description -Gets or sets a glyph to display on the badge. +Gets or sets a Segoe MDL2 Assets font glyph to display on the badge. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the badge glyph, such as "&#xE00B;".
+
## -property-value -The glyph to display on the badge. +The hexadecimal character code for the badge glyph. ## -remarks diff --git a/windows.ui.xaml.controls/personpicture_badgeimagesource.md b/windows.ui.xaml.controls/personpicture_badgeimagesource.md index 403135731e..13a77934fb 100644 --- a/windows.ui.xaml.controls/personpicture_badgeimagesource.md +++ b/windows.ui.xaml.controls/personpicture_badgeimagesource.md @@ -13,9 +13,20 @@ public ImageSource BadgeImageSource { get; set; } Gets or sets the source of an image to display on the badge. +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ ## -property-value -The source of an image to display on the badge. +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. ## -remarks diff --git a/windows.ui.xaml.controls/personpicture_badgenumber.md b/windows.ui.xaml.controls/personpicture_badgenumber.md index f90f1e4ede..b1025ea98c 100644 --- a/windows.ui.xaml.controls/personpicture_badgenumber.md +++ b/windows.ui.xaml.controls/personpicture_badgenumber.md @@ -13,6 +13,12 @@ public int BadgeNumber { get; set; } Gets or sets the contact number to display on the badge. +## -xaml-syntax + +```xaml + +``` + ## -property-value The contact number to display on the badge. diff --git a/windows.ui.xaml.controls/personpicture_badgetext.md b/windows.ui.xaml.controls/personpicture_badgetext.md index 57a0a9e011..6dde0c1d07 100644 --- a/windows.ui.xaml.controls/personpicture_badgetext.md +++ b/windows.ui.xaml.controls/personpicture_badgetext.md @@ -13,6 +13,12 @@ public string BadgeText { get; set; } Gets or sets the contact text to display on the badge. +## -xaml-syntax + +```xaml + +``` + ## -property-value The contact text to display on the badge. diff --git a/windows.ui.xaml.controls/personpicture_contact.md b/windows.ui.xaml.controls/personpicture_contact.md index ff079a1776..ad0079f6e2 100644 --- a/windows.ui.xaml.controls/personpicture_contact.md +++ b/windows.ui.xaml.controls/personpicture_contact.md @@ -13,6 +13,12 @@ public Contact Contact { get; set; } Gets or sets a [Contact](../windows.applicationmodel.contacts/contact.md) object that contains information about the person. +## -xaml-syntax + +```xaml + +``` + ## -property-value A [Contact](../windows.applicationmodel.contacts/contact.md) object that contains information about the person. diff --git a/windows.ui.xaml.controls/personpicture_displayname.md b/windows.ui.xaml.controls/personpicture_displayname.md index a731d5dffb..129f7b82d7 100644 --- a/windows.ui.xaml.controls/personpicture_displayname.md +++ b/windows.ui.xaml.controls/personpicture_displayname.md @@ -13,6 +13,12 @@ public string DisplayName { get; set; } Gets or sets the contact's display name. +## -xaml-syntax + +```xaml + +``` + ## -property-value The contact's display name. diff --git a/windows.ui.xaml.controls/personpicture_initials.md b/windows.ui.xaml.controls/personpicture_initials.md index 3ffb09d44d..c01c1de092 100644 --- a/windows.ui.xaml.controls/personpicture_initials.md +++ b/windows.ui.xaml.controls/personpicture_initials.md @@ -13,6 +13,12 @@ public string Initials { get; set; } Gets or sets the contact's initials. +## -xaml-syntax + +```xaml + +``` + ## -property-value The contact's initials. diff --git a/windows.ui.xaml.controls/personpicture_isgroup.md b/windows.ui.xaml.controls/personpicture_isgroup.md index 92c6719d69..ce4c1ef55d 100644 --- a/windows.ui.xaml.controls/personpicture_isgroup.md +++ b/windows.ui.xaml.controls/personpicture_isgroup.md @@ -13,6 +13,12 @@ public bool IsGroup { get; set; } Gets or sets a value that indicates whether the PersonPicture represents a group or an individual. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** if the PersonPicture represents a group; otherwise, **false**. diff --git a/windows.ui.xaml.controls/personpicture_prefersmallimage.md b/windows.ui.xaml.controls/personpicture_prefersmallimage.md index d63813cd22..85e1d4fae9 100644 --- a/windows.ui.xaml.controls/personpicture_prefersmallimage.md +++ b/windows.ui.xaml.controls/personpicture_prefersmallimage.md @@ -13,6 +13,12 @@ public bool PreferSmallImage { get; set; } Gets or sets a value that indicates whether a small image is displayed rather than a large image when both are available. +## -xaml-syntax + +```xaml + +``` + ## -property-value **true** to display a small image even when a large image is available; otherwise, **false**. The default is **false**. diff --git a/windows.ui.xaml.controls/personpicture_profilepicture.md b/windows.ui.xaml.controls/personpicture_profilepicture.md index 359b9a7cfd..07bfbd8509 100644 --- a/windows.ui.xaml.controls/personpicture_profilepicture.md +++ b/windows.ui.xaml.controls/personpicture_profilepicture.md @@ -13,9 +13,20 @@ public ImageSource ProfilePicture { get; set; } Gets or sets the source of the contact's profile picture. +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ ## -property-value -The source of the contact's profile picture. +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. ## -remarks diff --git a/windows.ui.xaml.controls/ratingcontrol.md b/windows.ui.xaml.controls/ratingcontrol.md new file mode 100644 index 0000000000..8f90699666 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.RatingControl +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.RatingControl + +## -description + +Represents a control that lets a user enter a star rating. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_caption.md b/windows.ui.xaml.controls/ratingcontrol_caption.md new file mode 100644 index 0000000000..3663d2662f --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_caption.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.Caption +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.Caption + +## -description + +Gets or sets the text label for the control. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The text label for the control. The default is an empty string. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_captionproperty.md b/windows.ui.xaml.controls/ratingcontrol_captionproperty.md new file mode 100644 index 0000000000..742b47b95e --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_captionproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.CaptionProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.CaptionProperty + +## -description + +Identifies the Caption dependency property. + +## -property-value + +The identifier for Caption dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_initialsetvalue.md b/windows.ui.xaml.controls/ratingcontrol_initialsetvalue.md new file mode 100644 index 0000000000..04caeb4819 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_initialsetvalue.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.InitialSetValue +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.InitialSetValue + +## -description + +Gets or sets the initial set rating value. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The initial set rating value. The default is 1. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_initialsetvalueproperty.md b/windows.ui.xaml.controls/ratingcontrol_initialsetvalueproperty.md new file mode 100644 index 0000000000..059da2fe3b --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_initialsetvalueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.InitialSetValueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.InitialSetValueProperty + +## -description + +Identifies the InitialSetValue dependency property. + +## -property-value + +The identifier for InitialSetValue dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_isclearenabled.md b/windows.ui.xaml.controls/ratingcontrol_isclearenabled.md new file mode 100644 index 0000000000..e71fc0d804 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_isclearenabled.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.IsClearEnabled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.IsClearEnabled + +## -description + +Gets or sets the value that determines if the user can remove the rating. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** if the user can remove the rating; otherwise, **false**. The default is **true**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_isclearenabledproperty.md b/windows.ui.xaml.controls/ratingcontrol_isclearenabledproperty.md new file mode 100644 index 0000000000..981af584f0 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_isclearenabledproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.IsClearEnabledProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.IsClearEnabledProperty + +## -description + +Identifies the IsClearEnabled dependency property. + +## -property-value + +The identifier for IsClearEnabled dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_isreadonly.md b/windows.ui.xaml.controls/ratingcontrol_isreadonly.md new file mode 100644 index 0000000000..fb7519cc1b --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_isreadonly.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.IsReadOnly +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.IsReadOnly + +## -description + +Gets or sets the value that determines if the user can change the rating. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +**true** if the rating is read-only; otherwise, **false**. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_isreadonlyproperty.md b/windows.ui.xaml.controls/ratingcontrol_isreadonlyproperty.md new file mode 100644 index 0000000000..778ebc8322 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_isreadonlyproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.IsReadOnlyProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.IsReadOnlyProperty + +## -description + +Identifies the IsReadOnly dependency property. + +## -property-value + +The identifier for IsReadOnly dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_iteminfo.md b/windows.ui.xaml.controls/ratingcontrol_iteminfo.md new file mode 100644 index 0000000000..2df3f61565 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_iteminfo.md @@ -0,0 +1,47 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.ItemInfo +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.ItemInfo + +## -description + +Gets or sets info about the visual states of the items that represent a rating. + +## -xaml-syntax + +```xaml + +``` + +```xaml + + + ratingItemInfo + + +``` + +## -xaml-values + +
resourceReferenceToRatingItemInfo
resourceReferenceToRatingItemInfoA resource reference to an existing RatingItemInfo-derived object from a resources collection. The resource reference must specify the desired RatingItemInfo by key through a {StaticResource} markup extension usage.
+
ratingItemInfo
ratingItemInfoDefinition for the RatingItemInfo-derived object.
+
+ +## -property-value + +A RatingItemInfo-derived object that contains details about the visual states of the items that represent a rating. + +## -remarks + +You can set the ItemInfo property to replace the default stars with other glyphs or images that represent a rating. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_iteminfoproperty.md b/windows.ui.xaml.controls/ratingcontrol_iteminfoproperty.md new file mode 100644 index 0000000000..8b6f147d9b --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_iteminfoproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.ItemInfoProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.ItemInfoProperty + +## -description + +Identifies the ItemInfo dependency property. + +## -property-value + +The identifier for ItemInfo dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_maxrating.md b/windows.ui.xaml.controls/ratingcontrol_maxrating.md new file mode 100644 index 0000000000..428b23ea1e --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_maxrating.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.MaxRating +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.MaxRating + +## -description + +Gets or sets the maximum allowed rating value. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The maximum allowed rating value. The default is 5. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_maxratingproperty.md b/windows.ui.xaml.controls/ratingcontrol_maxratingproperty.md new file mode 100644 index 0000000000..9d83a5a768 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_maxratingproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.MaxRatingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.MaxRatingProperty + +## -description + +Identifies the MaxRating dependency property. + +## -property-value + +The identifier for MaxRating dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_placeholdervalue.md b/windows.ui.xaml.controls/ratingcontrol_placeholdervalue.md new file mode 100644 index 0000000000..80ba5a62b1 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_placeholdervalue.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.PlaceholderValue +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.PlaceholderValue + +## -description + +Gets or sets the rating that is displayed in the control until the value is changed by a user action or some other operation. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The rating that is displayed in the control when no value is entered. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_placeholdervalueproperty.md b/windows.ui.xaml.controls/ratingcontrol_placeholdervalueproperty.md new file mode 100644 index 0000000000..ed54db4c1b --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_placeholdervalueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.PlaceholderValueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.PlaceholderValueProperty + +## -description + +Identifies the PlaceholderValue dependency property. + +## -property-value + +The identifier for PlaceholderValue dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_ratingcontrol_1221375020.md b/windows.ui.xaml.controls/ratingcontrol_ratingcontrol_1221375020.md new file mode 100644 index 0000000000..bf10ab5155 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_ratingcontrol_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.RatingControl.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.RatingControl + +## -description + +Initializes a new instance of the RatingControl class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_value.md b/windows.ui.xaml.controls/ratingcontrol_value.md new file mode 100644 index 0000000000..f86ffe1178 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_value.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.Value +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.Value + +## -description + +Gets or sets the rating value. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The rating value. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_valuechanged.md b/windows.ui.xaml.controls/ratingcontrol_valuechanged.md new file mode 100644 index 0000000000..be6261cc97 --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_valuechanged.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.RatingControl.ValueChanged +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.ValueChanged + +## -description + +Occurs when the Value property has changed. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingcontrol_valueproperty.md b/windows.ui.xaml.controls/ratingcontrol_valueproperty.md new file mode 100644 index 0000000000..85d644597b --- /dev/null +++ b/windows.ui.xaml.controls/ratingcontrol_valueproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingControl.ValueProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingControl.ValueProperty + +## -description + +Identifies the Value dependency property. + +## -property-value + +The identifier for Value dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo.md b/windows.ui.xaml.controls/ratingitemfontinfo.md new file mode 100644 index 0000000000..b6add678b7 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.RatingItemFontInfo +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo + +## -description + +Represents information about the visual states of font elements that represent a rating. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_disabledglyph.md b/windows.ui.xaml.controls/ratingitemfontinfo_disabledglyph.md new file mode 100644 index 0000000000..4af463adb3 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_disabledglyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.DisabledGlyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.DisabledGlyph + +## -description + +Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that is disabled. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the rating element glyph, such as "&#xE00B;".
+
+ +## -property-value + +The hexadecimal character code for the rating element glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_disabledglyphproperty.md b/windows.ui.xaml.controls/ratingitemfontinfo_disabledglyphproperty.md new file mode 100644 index 0000000000..1ce8a224b3 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_disabledglyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.DisabledGlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.DisabledGlyphProperty + +## -description + +Identifies the DisabledGlyph dependency property. + +## -property-value + +The identifier for DisabledGlyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_glyph.md b/windows.ui.xaml.controls/ratingitemfontinfo_glyph.md new file mode 100644 index 0000000000..21262f3bf9 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_glyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.Glyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.Glyph + +## -description + +Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that has been set by the user. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the rating element glyph, such as "&#xE00B;".
+
+ +## -property-value + +The hexadecimal character code for the rating element glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_glyphproperty.md b/windows.ui.xaml.controls/ratingitemfontinfo_glyphproperty.md new file mode 100644 index 0000000000..d530e8d1a5 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_glyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.GlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.GlyphProperty + +## -description + +Identifies the Glyph dependency property. + +## -property-value + +The identifier for Glyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_placeholderglyph.md b/windows.ui.xaml.controls/ratingitemfontinfo_placeholderglyph.md new file mode 100644 index 0000000000..211127111e --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_placeholderglyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.PlaceholderGlyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.PlaceholderGlyph + +## -description + +Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that is showing a placeholder value. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the rating element glyph, such as "&#xE00B;".
+
+ +## -property-value + +The hexadecimal character code for the rating element glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_placeholderglyphproperty.md b/windows.ui.xaml.controls/ratingitemfontinfo_placeholderglyphproperty.md new file mode 100644 index 0000000000..6cd0120b1f --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_placeholderglyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.PlaceholderGlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.PlaceholderGlyphProperty + +## -description + +Identifies the PlaceholderGlyph dependency property. + +## -property-value + +The identifier for PlaceholderGlyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverglyph.md b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverglyph.md new file mode 100644 index 0000000000..9df24eca13 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverglyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverGlyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverGlyph + +## -description + +Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that has the pointer over it. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the rating element glyph, such as "&#xE00B;".
+
+ +## -property-value + +The hexadecimal character code for the rating element glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverglyphproperty.md b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverglyphproperty.md new file mode 100644 index 0000000000..e657b4ef5e --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverglyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverGlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverGlyphProperty + +## -description + +Identifies the PointerOverGlyph dependency property. + +## -property-value + +The identifier for PointerOverGlyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverplaceholderglyph.md b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverplaceholderglyph.md new file mode 100644 index 0000000000..19c96c70c3 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverplaceholderglyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverPlaceholderGlyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverPlaceholderGlyph + +## -description + +Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element showing a placeholder value with the pointer over it. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the rating element glyph, such as "&#xE00B;".
+
+ +## -property-value + +The hexadecimal character code for the rating element glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverplaceholderglyphproperty.md b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverplaceholderglyphproperty.md new file mode 100644 index 0000000000..992c4f0fc2 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_pointeroverplaceholderglyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverPlaceholderGlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.PointerOverPlaceholderGlyphProperty + +## -description + +Identifies the PointerOverPlaceholderGlyph dependency property. + +## -property-value + +The identifier for PointerOverPlaceholderGlyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_ratingitemfontinfo_1221375020.md b/windows.ui.xaml.controls/ratingitemfontinfo_ratingitemfontinfo_1221375020.md new file mode 100644 index 0000000000..3ef4aced77 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_ratingitemfontinfo_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.RatingItemFontInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.RatingItemFontInfo + +## -description + +Initializes a new instance of the RatingItemFontInfo class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_unsetglyph.md b/windows.ui.xaml.controls/ratingitemfontinfo_unsetglyph.md new file mode 100644 index 0000000000..ab9e6e63af --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_unsetglyph.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.UnsetGlyph +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.UnsetGlyph + +## -description + +Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that has not been set. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCode
characterCodeThe hexadecimal character code for the rating element glyph, such as "&#xE00B;".
+
+ +## -property-value + +The hexadecimal character code for the rating element glyph. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemfontinfo_unsetglyphproperty.md b/windows.ui.xaml.controls/ratingitemfontinfo_unsetglyphproperty.md new file mode 100644 index 0000000000..a34dd6b517 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemfontinfo_unsetglyphproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemFontInfo.UnsetGlyphProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemFontInfo.UnsetGlyphProperty + +## -description + +Identifies the UnsetGlyph dependency property. + +## -property-value + +The identifier for UnsetGlyph dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo.md b/windows.ui.xaml.controls/ratingitemimageinfo.md new file mode 100644 index 0000000000..1c738685a9 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.RatingItemImageInfo +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo + +## -description + +Represents information about the visual states of image elements that represent a rating. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_disabledimage.md b/windows.ui.xaml.controls/ratingitemimageinfo_disabledimage.md new file mode 100644 index 0000000000..a31e5b327e --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_disabledimage.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.DisabledImage +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.DisabledImage + +## -description + +Gets or sets an image that represents a rating element that is disabled. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ +## -property-value + +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_disabledimageproperty.md b/windows.ui.xaml.controls/ratingitemimageinfo_disabledimageproperty.md new file mode 100644 index 0000000000..b6221ef090 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_disabledimageproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.DisabledImageProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.DisabledImageProperty + +## -description + +Identifies the DisabledImage dependency property. + +## -property-value + +The identifier for DisabledImage dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_image.md b/windows.ui.xaml.controls/ratingitemimageinfo_image.md new file mode 100644 index 0000000000..9ea9ab0e5b --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_image.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.Image +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.Image + +## -description + +Gets or sets an image that represents a rating element that has been set by the user. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ +## -property-value + +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_imageproperty.md b/windows.ui.xaml.controls/ratingitemimageinfo_imageproperty.md new file mode 100644 index 0000000000..ab2f402be5 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_imageproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.ImageProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.ImageProperty + +## -description + +Identifies the Image dependency property. + +## -property-value + +The identifier for Image dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_placeholderimage.md b/windows.ui.xaml.controls/ratingitemimageinfo_placeholderimage.md new file mode 100644 index 0000000000..f2747a2b54 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_placeholderimage.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.PlaceholderImage +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.PlaceholderImage + +## -description + +Gets or sets an image that represents a rating element that is showing a placeholder value. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ +## -property-value + +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_placeholderimageproperty.md b/windows.ui.xaml.controls/ratingitemimageinfo_placeholderimageproperty.md new file mode 100644 index 0000000000..1e33a665aa --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_placeholderimageproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.PlaceholderImageProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.PlaceholderImageProperty + +## -description + +Identifies the PlaceholderImage dependency property. + +## -property-value + +The identifier for PlaceholderImage dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverimage.md b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverimage.md new file mode 100644 index 0000000000..b7ee8e0840 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverimage.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverImage +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverImage + +## -description + +Gets or sets an image that represents a rating element that has the pointer over it. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ +## -property-value + +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverimageproperty.md b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverimageproperty.md new file mode 100644 index 0000000000..a6eebb7a81 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverimageproperty.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverImageProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverImageProperty + +## -description + +Identifies the PointerOverImage dependency property. + +## -property-value + +The identifier for PointerOverImage dependency property. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverplaceholderimage.md b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverplaceholderimage.md new file mode 100644 index 0000000000..ee83994ec7 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverplaceholderimage.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverPlaceholderImage +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverPlaceholderImage + +## -description + +Gets or sets an image that represents a rating element showing a placeholder value with the pointer over it. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ +## -property-value + +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverplaceholderimageproperty.md b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverplaceholderimageproperty.md new file mode 100644 index 0000000000..fdc584b6a6 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_pointeroverplaceholderimageproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverPlaceholderImageProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.PointerOverPlaceholderImageProperty + +## -description + +Identifies the PointerOverPlaceholderImage dependency property. + +## -property-value + +The identifier for PointerOverPlaceholderImage dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_ratingitemimageinfo_1221375020.md b/windows.ui.xaml.controls/ratingitemimageinfo_ratingitemimageinfo_1221375020.md new file mode 100644 index 0000000000..15396cd1e1 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_ratingitemimageinfo_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.RatingItemImageInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.RatingItemImageInfo + +## -description + +Initializes a new instance of the RatingItemImageInfo class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_unsetimage.md b/windows.ui.xaml.controls/ratingitemimageinfo_unsetimage.md new file mode 100644 index 0000000000..28559413b0 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_unsetimage.md @@ -0,0 +1,38 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.UnsetImage +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.UnsetImage + +## -description + +Gets or sets an image that represents a rating element that has not been set. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
uri
uriThe location of the image source file. In XAML syntax, you can specify what appears to be a relative that is relative to a base . The base is interpreted based on the location of the XAML file that loads it, and uses the ms-appx: scheme implicitly. For more info see Image.Source.
+
+ +## -property-value + +An object that represents the image source file for the drawn image. Typically you set this with a [BitmapImage](../windows.ui.xaml.media.imaging/bitmapimage.md) object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a [BitmapSource](../windows.ui.xaml.media.imaging/bitmapsource.md) with a stream, perhaps a stream from a storage file. + +## -remarks + +## -see-also + +[Image.Source](image_source.md) + +## -examples + diff --git a/windows.ui.xaml.controls/ratingitemimageinfo_unsetimageproperty.md b/windows.ui.xaml.controls/ratingitemimageinfo_unsetimageproperty.md new file mode 100644 index 0000000000..4e434b6c82 --- /dev/null +++ b/windows.ui.xaml.controls/ratingitemimageinfo_unsetimageproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RatingItemImageInfo.UnsetImageProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RatingItemImageInfo.UnsetImageProperty + +## -description + +Identifies the UnsetImage dependency property. + +## -property-value + +The identifier for UnsetImage dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingiteminfo.md b/windows.ui.xaml.controls/ratingiteminfo.md new file mode 100644 index 0000000000..20a8fc1a8b --- /dev/null +++ b/windows.ui.xaml.controls/ratingiteminfo.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.RatingItemInfo +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.RatingItemInfo + +## -description + +Represents information about the visual states of the elements that represent a rating. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/ratingiteminfo_ratingiteminfo_1221375020.md b/windows.ui.xaml.controls/ratingiteminfo_ratingiteminfo_1221375020.md new file mode 100644 index 0000000000..42c21eb793 --- /dev/null +++ b/windows.ui.xaml.controls/ratingiteminfo_ratingiteminfo_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.RatingItemInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.RatingItemInfo.RatingItemInfo + +## -description + +Initializes a new instance of the RatingItemInfo class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_charactercasing.md b/windows.ui.xaml.controls/richeditbox_charactercasing.md new file mode 100644 index 0000000000..f6c26ba0a5 --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_charactercasing.md @@ -0,0 +1,39 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichEditBox.CharacterCasing +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.CharacterCasing + +## -description + +Gets or sets a value that indicates how the control modifies the case of characters as they are typed. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCasingValue
characterCasingValueA named constant of the CharacterCasing enumeration, such as Upper.
+
+ +## -property-value + +A value of the enumeration that indicates how the control modifies the case of characters as they are typed. The default is **Normal**, which indicates that the charcters are not changed. + +## -remarks + +> [!NOTE] +> This property modifies the case of characters as they are typed. It doesn’t modify characters that are entered in other ways, like paste or ink. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_charactercasingproperty.md b/windows.ui.xaml.controls/richeditbox_charactercasingproperty.md new file mode 100644 index 0000000000..247df1629b --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_charactercasingproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichEditBox.CharacterCasingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.CharacterCasingProperty + +## -description + +Identifies the CharacterCasing dependency property. + +## -property-value + +The identifier for the CharacterCasing dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_copyingtoclipboard.md b/windows.ui.xaml.controls/richeditbox_copyingtoclipboard.md new file mode 100644 index 0000000000..13428cfe96 --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_copyingtoclipboard.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.RichEditBox.CopyingToClipboard +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.CopyingToClipboard + +## -description + +Occurs before copied text is moved to the clipboard. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_cuttingtoclipboard.md b/windows.ui.xaml.controls/richeditbox_cuttingtoclipboard.md new file mode 100644 index 0000000000..f5ae1f43af --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_cuttingtoclipboard.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.RichEditBox.CuttingToClipboard +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.CuttingToClipboard + +## -description + +Occurs before cut text is moved to the clipboard. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_disabledformattingaccelerators.md b/windows.ui.xaml.controls/richeditbox_disabledformattingaccelerators.md new file mode 100644 index 0000000000..4b7f89a9d7 --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_disabledformattingaccelerators.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichEditBox.DisabledFormattingAccelerators +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.DisabledFormattingAccelerators + +## -description + +Gets or sets a value that indicates which keyboard shortcuts for formatting are disabled. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
disabledFormattingAcceleratorsValue
disabledFormattingAcceleratorsValueA named constant of the DisabledFormattingAccelerators enumeration, such as Bold.
+
+ +## -property-value + +A value that indicates which keyboard shortcuts for formatting are disabled. The default is **None**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_disabledformattingacceleratorsproperty.md b/windows.ui.xaml.controls/richeditbox_disabledformattingacceleratorsproperty.md new file mode 100644 index 0000000000..6e1c4ce536 --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_disabledformattingacceleratorsproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichEditBox.DisabledFormattingAcceleratorsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.DisabledFormattingAcceleratorsProperty + +## -description + +Identifies the DisabledFormattingAccelerators dependency property. + +## -property-value + +The identifier for the DisabledFormattingAccelerators dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_horizontaltextalignment.md b/windows.ui.xaml.controls/richeditbox_horizontaltextalignment.md new file mode 100644 index 0000000000..0ea30c66de --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_horizontaltextalignment.md @@ -0,0 +1,38 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichEditBox.HorizontalTextAlignment +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.HorizontalTextAlignment + +## -description + +Gets or sets a value that indicates how text is aligned in the RichEditBox. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
textAlignmentValue
textAlignmentValueA named constant of the TextAlignment enumeration, such as Left.
+
+ +## -property-value + +One of the [TextAlignment](../windows.ui.xaml/textalignment.md) enumeration values that specifies how text is aligned. The default is **Left**. + +## -remarks + +This property supports [XAML Standard](http://aka.ms/xamlstandard). It provides the same functionality as the **TextAlignement** property. If both properties are set to conflicting values, the last one set is used. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_horizontaltextalignmentproperty.md b/windows.ui.xaml.controls/richeditbox_horizontaltextalignmentproperty.md new file mode 100644 index 0000000000..4a863311dc --- /dev/null +++ b/windows.ui.xaml.controls/richeditbox_horizontaltextalignmentproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichEditBox.HorizontalTextAlignmentProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichEditBox.HorizontalTextAlignmentProperty + +## -description + +Identifies the HorizontalTextAlignment dependency property. + +## -property-value + +The identifier for the HorizontalTextAlignment dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richeditbox_textcompositionchanged.md b/windows.ui.xaml.controls/richeditbox_textcompositionchanged.md index 220c708709..9476a54de6 100644 --- a/windows.ui.xaml.controls/richeditbox_textcompositionchanged.md +++ b/windows.ui.xaml.controls/richeditbox_textcompositionchanged.md @@ -12,6 +12,12 @@ public event Windows.Foundation.TypedEventHandler TextCompositionChanged +``` + ## -remarks For event data, see [TextCompositionChangedEventArgs](textcompositionchangedeventargs.md). diff --git a/windows.ui.xaml.controls/richeditbox_textcompositionended.md b/windows.ui.xaml.controls/richeditbox_textcompositionended.md index 89ab06d1ad..559bfcc058 100644 --- a/windows.ui.xaml.controls/richeditbox_textcompositionended.md +++ b/windows.ui.xaml.controls/richeditbox_textcompositionended.md @@ -12,6 +12,12 @@ public event Windows.Foundation.TypedEventHandler TextCompositionEnded +``` + ## -remarks For event data, see [TextCompositionEndedEventArgs](textcompositionendedeventargs.md). diff --git a/windows.ui.xaml.controls/richeditbox_textcompositionstarted.md b/windows.ui.xaml.controls/richeditbox_textcompositionstarted.md index 1d344ed846..b78bb8ce9a 100644 --- a/windows.ui.xaml.controls/richeditbox_textcompositionstarted.md +++ b/windows.ui.xaml.controls/richeditbox_textcompositionstarted.md @@ -12,6 +12,12 @@ public event Windows.Foundation.TypedEventHandler TextCompositionStarted +``` + ## -remarks For event data, see [TextCompositionStartedEventArgs](textcompositionstartedeventargs.md). diff --git a/windows.ui.xaml.controls/richtextblock_horizontaltextalignment.md b/windows.ui.xaml.controls/richtextblock_horizontaltextalignment.md new file mode 100644 index 0000000000..3b0975fe74 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblock_horizontaltextalignment.md @@ -0,0 +1,38 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlock.HorizontalTextAlignment +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlock.HorizontalTextAlignment + +## -description + +Gets or sets a value that indicates how text is aligned in the RichTextBlock. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
textAlignmentValue
textAlignmentValueA named constant of the TextAlignment enumeration, such as Left.
+
+ +## -property-value + +One of the [TextAlignment](../windows.ui.xaml/textalignment.md) enumeration values that specifies how text is aligned. The default is **Left**. + +## -remarks + +This property supports [XAML Standard](http://aka.ms/xamlstandard). It provides the same functionality as the **TextAlignement** property. If both properties are set to conflicting values, the last one set is used. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblock_horizontaltextalignmentproperty.md b/windows.ui.xaml.controls/richtextblock_horizontaltextalignmentproperty.md new file mode 100644 index 0000000000..80ec2428f8 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblock_horizontaltextalignmentproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlock.HorizontalTextAlignmentProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlock.HorizontalTextAlignmentProperty + +## -description + +Identifies the HorizontalTextAlignment dependency property. + +## -property-value + +The identifier for the HorizontalTextAlignment dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblock_istexttrimmed.md b/windows.ui.xaml.controls/richtextblock_istexttrimmed.md new file mode 100644 index 0000000000..ff3b6f094d --- /dev/null +++ b/windows.ui.xaml.controls/richtextblock_istexttrimmed.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlock.IsTextTrimmed +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlock.IsTextTrimmed + +## -description + +Gets a value that indicates whether the control has trimmed text that overflows the content area. + +## -property-value + +**true** if text is trimmed; otherwise, **false**. + +## -remarks + +See the TextTrimming property and [TextTrimming](../windows.ui.xaml/texttrimming.md) enumeration for more info about how text is trimmed. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblock_istexttrimmedchanged.md b/windows.ui.xaml.controls/richtextblock_istexttrimmedchanged.md new file mode 100644 index 0000000000..a9a702f1e7 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblock_istexttrimmedchanged.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.RichTextBlock.IsTextTrimmedChanged +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlock.IsTextTrimmedChanged + +## -description + +Occurs when the **IsTextTrimmed** property value has changed. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblock_istexttrimmedproperty.md b/windows.ui.xaml.controls/richtextblock_istexttrimmedproperty.md new file mode 100644 index 0000000000..28fbfb0161 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblock_istexttrimmedproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlock.IsTextTrimmedProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlock.IsTextTrimmedProperty + +## -description + +Identifies the IsTextTrimmed dependency property. + +## -property-value + +The identifier for the IsTextTrimmed dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblock_texthighlighters.md b/windows.ui.xaml.controls/richtextblock_texthighlighters.md new file mode 100644 index 0000000000..81a9d327d6 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblock_texthighlighters.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlock.TextHighlighters +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlock.TextHighlighters + +## -description + +Gets the collection of text highlights. + +## -property-value + +The collection of text highlights. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmed.md b/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmed.md new file mode 100644 index 0000000000..58951af851 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmed.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlockOverflow.IsTextTrimmed +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlockOverflow.IsTextTrimmed + +## -description + +Gets a value that indicates whether the control has trimmed text that overflows the content area. + +## -property-value + +**true** if text is trimmed; otherwise, **false**. + +## -remarks + +See the TextTrimming property and [TextTrimming](../windows.ui.xaml/texttrimming.md) enumeration for more info about how text is trimmed. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmedchanged.md b/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmedchanged.md new file mode 100644 index 0000000000..3d245ad10d --- /dev/null +++ b/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmedchanged.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.RichTextBlockOverflow.IsTextTrimmedChanged +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlockOverflow.IsTextTrimmedChanged + +## -description + +Occurs when the **IsTextTrimmed** property value has changed. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmedproperty.md b/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmedproperty.md new file mode 100644 index 0000000000..f29ef9d7a2 --- /dev/null +++ b/windows.ui.xaml.controls/richtextblockoverflow_istexttrimmedproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.RichTextBlockOverflow.IsTextTrimmedProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.RichTextBlockOverflow.IsTextTrimmedProperty + +## -description + +Identifies the IsTextTrimmed dependency property. + +## -property-value + +The identifier for the IsTextTrimmed dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/splitview_paneopened.md b/windows.ui.xaml.controls/splitview_paneopened.md new file mode 100644 index 0000000000..87f3938efd --- /dev/null +++ b/windows.ui.xaml.controls/splitview_paneopened.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.SplitView.PaneOpened +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.SplitView.PaneOpened + +## -description + +Occurs when the [SplitView](splitview.md) pane is opened. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/splitview_paneopening.md b/windows.ui.xaml.controls/splitview_paneopening.md new file mode 100644 index 0000000000..0fac6c77f5 --- /dev/null +++ b/windows.ui.xaml.controls/splitview_paneopening.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.SplitView.PaneOpening +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.SplitView.PaneOpening + +## -description + +Occurs when the [SplitView](splitview.md) pane is opening. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/stackpanel_spacing.md b/windows.ui.xaml.controls/stackpanel_spacing.md new file mode 100644 index 0000000000..3df77ca1b2 --- /dev/null +++ b/windows.ui.xaml.controls/stackpanel_spacing.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.StackPanel.Spacing +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.StackPanel.Spacing + +## -description + +Gets or sets the distance (in pixels) between stacked items. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The distance (in pixels) between stacked items. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/stackpanel_spacingproperty.md b/windows.ui.xaml.controls/stackpanel_spacingproperty.md new file mode 100644 index 0000000000..764ef04631 --- /dev/null +++ b/windows.ui.xaml.controls/stackpanel_spacingproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.StackPanel.SpacingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.StackPanel.SpacingProperty + +## -description + +Identifies the Spacing dependency property. + +## -property-value + +The identifier for the Spacing dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipebehavioroninvoked.md b/windows.ui.xaml.controls/swipebehavioroninvoked.md new file mode 100644 index 0000000000..b453d1af9b --- /dev/null +++ b/windows.ui.xaml.controls/swipebehavioroninvoked.md @@ -0,0 +1,40 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SwipeBehaviorOnInvoked +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.SwipeBehaviorOnInvoked + +## -description + +Defines constants that specify how a [SwipeControl](swipecontrol.md) behaves after a command is invoked. + +## -enum-fields + +### -field RemainOpen:2 + +The SwipeControl remains open after an item is invoked. + +### -field Close:1 + +The SwipeControl closes after an item is invoked. + +### -field Auto:0 + +In **Reveal** mode, the SwipeControl closes after an item is invoked. In **Execute** mode, the SwipeControl remains open. + +## -remarks + +## -see-also + ++ [SwipeMode](swipemode.md) enumeration ++ [SwipeItems.Mode](swipeitems_mode.md) property ++ [SwipeItem.Invoked](swipeitem_invoked.md) event ++ [SwipeControl](swipecontrol.md) class + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol.md b/windows.ui.xaml.controls/swipecontrol.md new file mode 100644 index 0000000000..5eeabb1bdf --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SwipeControl +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl + +## -description + +Represents a container that provides access to contextual commands through touch interactions. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_bottomitems.md b/windows.ui.xaml.controls/swipecontrol_bottomitems.md new file mode 100644 index 0000000000..4c7737d6db --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_bottomitems.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.BottomItems +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.BottomItems + +## -description + +Gets or sets the items that can be invoked when the control is swiped from the bottom up. + +## -xaml-syntax + +```xaml + + + oneOrMoreSwipeItemDefinitions + + +``` + +## -xaml-values + +
oneOrMoreSwipeItemDefinitions
oneOrMoreSwipeItemDefinitionsOne or more SwipeItem elements.
+
+ +## -property-value + +The items that can be invoked when the control is swiped from the bottom up. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_bottomitemsproperty.md b/windows.ui.xaml.controls/swipecontrol_bottomitemsproperty.md new file mode 100644 index 0000000000..5b95e1c07b --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_bottomitemsproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.BottomItemsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.BottomItemsProperty + +## -description + +Identifies the BottomItems dependency property. + +## -property-value + +The identifier for the BottomItems dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_close_811482585.md b/windows.ui.xaml.controls/swipecontrol_close_811482585.md new file mode 100644 index 0000000000..6df8fd9cf9 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeControl.Close +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.Close + +## -description + +Closes the swipe control. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_leftitems.md b/windows.ui.xaml.controls/swipecontrol_leftitems.md new file mode 100644 index 0000000000..d44bd006f3 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_leftitems.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.LeftItems +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.LeftItems + +## -description + +Gets or sets the items that can be invoked when the control is swiped from the left side. + +## -xaml-syntax + +```xaml + + + oneOrMoreSwipeItemDefinitions + + +``` + +## -xaml-values + +
oneOrMoreSwipeItemDefinitions
oneOrMoreSwipeItemDefinitionsOne or more SwipeItem elements.
+
+ +## -property-value + +The items that can be invoked when the control is swiped from the left side. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_leftitemsproperty.md b/windows.ui.xaml.controls/swipecontrol_leftitemsproperty.md new file mode 100644 index 0000000000..ee83a5ce85 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_leftitemsproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.LeftItemsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.LeftItemsProperty + +## -description + +Identifies the LeftItems dependency property. + +## -property-value + +The identifier for the LeftItems dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_rightitems.md b/windows.ui.xaml.controls/swipecontrol_rightitems.md new file mode 100644 index 0000000000..c580e32f59 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_rightitems.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.RightItems +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.RightItems + +## -description + +Gets or sets the items that can be invoked when the control is swiped from the right side. + +## -xaml-syntax + +```xaml + + + oneOrMoreSwipeItemDefinitions + + +``` + +## -xaml-values + +
oneOrMoreSwipeItemDefinitions
oneOrMoreSwipeItemDefinitionsOne or more SwipeItem elements.
+
+ +## -property-value + +The items that can be invoked when the control is swiped from the right side. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_rightitemsproperty.md b/windows.ui.xaml.controls/swipecontrol_rightitemsproperty.md new file mode 100644 index 0000000000..ab0024d13e --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_rightitemsproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.RightItemsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.RightItemsProperty + +## -description + +Identifies the RightItems dependency property. + +## -property-value + +The identifier for the RightItems dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_swipecontrol_1221375020.md b/windows.ui.xaml.controls/swipecontrol_swipecontrol_1221375020.md new file mode 100644 index 0000000000..b104a0e9a4 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_swipecontrol_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeControl.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.SwipeControl + +## -description + +Initializes a new instance of the SwipeControl class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_topitems.md b/windows.ui.xaml.controls/swipecontrol_topitems.md new file mode 100644 index 0000000000..9f04a948f2 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_topitems.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.TopItems +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.TopItems + +## -description + +Gets or sets the items that can be invoked when the control is swiped from the top down. + +## -xaml-syntax + +```xaml + + + oneOrMoreSwipeItemDefinitions + + +``` + +## -xaml-values + +
oneOrMoreSwipeItemDefinitions
oneOrMoreSwipeItemDefinitionsOne or more SwipeItem elements.
+
+ +## -property-value + +The items that can be invoked when the control is swiped from the top down. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipecontrol_topitemsproperty.md b/windows.ui.xaml.controls/swipecontrol_topitemsproperty.md new file mode 100644 index 0000000000..5ddd2ef367 --- /dev/null +++ b/windows.ui.xaml.controls/swipecontrol_topitemsproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeControl.TopItemsProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeControl.TopItemsProperty + +## -description + +Identifies the TopItems dependency property. + +## -property-value + +The identifier for the TopItems dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem.md b/windows.ui.xaml.controls/swipeitem.md new file mode 100644 index 0000000000..a3d663af85 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SwipeItem +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem + +## -description + +Represents an individual command in a SwipeControl. + +## -xaml-syntax + +```xaml + +-or- + + content + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_background.md b/windows.ui.xaml.controls/swipeitem_background.md new file mode 100644 index 0000000000..8dd191d4d5 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_background.md @@ -0,0 +1,41 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.Background +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.Background + +## -description + +Gets or sets a brush that provides the background of the control. + +## -xaml-syntax + +```xaml + +``` + +```xaml + +``` + +## -xaml-values + +
resourceName
resourceNameThe resource name (x:Key attribute value) of an existing XAML resource that defines a brush. This is the recommended way to specify Brush values in XAML if you have any intention of using the same colors or brushes in more than one part of your UI. See Remarks in Brush or ResourceDictionary and XAML resource references.
+
colorString
colorStringThe Color for a SolidColorBrush expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+
+ +## -property-value + +The brush that provides the background of the control. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_backgroundproperty.md b/windows.ui.xaml.controls/swipeitem_backgroundproperty.md new file mode 100644 index 0000000000..a4023e063d --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_backgroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.BackgroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.BackgroundProperty + +## -description + +Identifies the Background dependency property. + +## -property-value + +The identifier for the Background dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_behavioroninvoked.md b/windows.ui.xaml.controls/swipeitem_behavioroninvoked.md new file mode 100644 index 0000000000..fac77f89b3 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_behavioroninvoked.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.BehaviorOnInvoked +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.BehaviorOnInvoked + +## -description + + Gets or sets a value that indicates how a [SwipeControl](swipecontrol.md) behaves after this item is invoked. + +## -xaml-syntax + +```xaml + +``` + +g## -xaml-values + +
swipeBehaviorOnInvokedMemberName
swipeBehaviorOnInvokedMemberNameA named constant of the SwipeBehaviorOnInvoked enumeration.
+
+ +## -property-value + +A value that indicates how a [SwipeControl](swipecontrol.md) behaves after this item is invoked. The default is **Auto**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_behavioroninvokedproperty.md b/windows.ui.xaml.controls/swipeitem_behavioroninvokedproperty.md new file mode 100644 index 0000000000..34250c8f2c --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_behavioroninvokedproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.BehaviorOnInvokedProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.BehaviorOnInvokedProperty + +## -description + +Identifies the BehaviorOnInvoked dependency property. + +## -property-value + +The identifier for the BehaviorOnInvoked dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_command.md b/windows.ui.xaml.controls/swipeitem_command.md new file mode 100644 index 0000000000..0c888545b0 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_command.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.Command +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.Command + +## -description + +Gets or sets the command to execute when this item is invoked. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
commandReference
commandReferenceA reference to an ICommand implementation that describes the command logic. Typically this is done through a {Binding} markup extension reference to a data source, when using view-view model designs.
+
+ +## -property-value + +The command to execute when this item is invoked. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_commandparameter.md b/windows.ui.xaml.controls/swipeitem_commandparameter.md new file mode 100644 index 0000000000..cc28f0b021 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_commandparameter.md @@ -0,0 +1,39 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.CommandParameter +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.CommandParameter + +## -description + +Gets or sets the parameter to pass to the Command property. + +## -xaml-syntax + +```xaml + + + object + + +``` + +```xaml + +``` + +## -property-value + +The parameter to pass to the Command property. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_commandparameterproperty.md b/windows.ui.xaml.controls/swipeitem_commandparameterproperty.md new file mode 100644 index 0000000000..e2c6f75e17 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_commandparameterproperty.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.CommandParameterProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.CommandParameterProperty + +## -description + +Identifies the CommandParameter dependency property. + +## -property-value + +The identifier for the CommandParameter dependency property. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_commandproperty.md b/windows.ui.xaml.controls/swipeitem_commandproperty.md new file mode 100644 index 0000000000..5cf1d428ae --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_commandproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.CommandProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.CommandProperty + +## -description + +Identifies the Command dependency property. + +## -property-value + +The identifier for the Command dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_foreground.md b/windows.ui.xaml.controls/swipeitem_foreground.md new file mode 100644 index 0000000000..0db7c7ee1a --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_foreground.md @@ -0,0 +1,41 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.Foreground +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.Foreground + +## -description + +Gets or sets the brush that paints the text and icon of the item. + +## -xaml-syntax + +```xaml + +``` + +```xaml + +``` + +## -xaml-values + +
resourceName
resourceNameThe resource name (x:Key attribute value) of an existing XAML resource that defines a brush. This is the recommended way to specify Brush values in XAML if you have any intention of using the same colors or brushes in more than one part of your UI. See Remarks in Brush or ResourceDictionary and XAML resource references.
+
colorString
colorStringThe Color for a SolidColorBrush expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+
+ +## -property-value + +The brush that paints the text and icon of the item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_foregroundproperty.md b/windows.ui.xaml.controls/swipeitem_foregroundproperty.md new file mode 100644 index 0000000000..016c12f77d --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_foregroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.ForegroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.ForegroundProperty + +## -description + +Identifies the Foreground dependency property. + +## -property-value + +The identifier for the Foreground dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_iconsource.md b/windows.ui.xaml.controls/swipeitem_iconsource.md new file mode 100644 index 0000000000..0286deda26 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_iconsource.md @@ -0,0 +1,40 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.IconSource +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.IconSource + +## -description + +Gets or sets the graphic content of the item. + +## -xaml-syntax + +```xaml + + +   iconSourceElement + + +``` + +## -xaml-values + +
iconSourceElement
iconSourceElementA single object element that derives from IconSource and describes the graphic content of the button.
+ + +## -property-value + +The graphic content of the item. The default is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_iconsourceproperty.md b/windows.ui.xaml.controls/swipeitem_iconsourceproperty.md new file mode 100644 index 0000000000..cbda54f93c --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_iconsourceproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.IconSourceProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.IconSourceProperty + +## -description + +Identifies the IconSource dependency property. + +## -property-value + +The identifier for the IconSource dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_invoked.md b/windows.ui.xaml.controls/swipeitem_invoked.md new file mode 100644 index 0000000000..d5d09dab38 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_invoked.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.SwipeItem.Invoked +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.Invoked + +## -description + +Occurs when user interaction indicates that the command represented by this item should execute. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_swipeitem_1221375020.md b/windows.ui.xaml.controls/swipeitem_swipeitem_1221375020.md new file mode 100644 index 0000000000..55b6fe8e1f --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_swipeitem_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItem.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.SwipeItem + +## -description + +Initializes a new instance of the SwipeItem class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_text.md b/windows.ui.xaml.controls/swipeitem_text.md new file mode 100644 index 0000000000..dcde031e80 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_text.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.Text +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.Text + +## -description + +Gets or sets the text description displayed on the item. + +## -xaml-syntax + +```xaml + +``` + +## -property-value + +The text description displayed on the item. The default is an empty string. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitem_textproperty.md b/windows.ui.xaml.controls/swipeitem_textproperty.md new file mode 100644 index 0000000000..205681f41c --- /dev/null +++ b/windows.ui.xaml.controls/swipeitem_textproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItem.TextProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItem.TextProperty + +## -description + +Identifies the Text dependency property. + +## -property-value + +The identifier for the Text dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeiteminvokedeventargs.md b/windows.ui.xaml.controls/swipeiteminvokedeventargs.md new file mode 100644 index 0000000000..d809115ac7 --- /dev/null +++ b/windows.ui.xaml.controls/swipeiteminvokedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SwipeItemInvokedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.SwipeItemInvokedEventArgs + +## -description + +Provides event data for the [SwipeItem.Invoked](swipeitem_invoked.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeiteminvokedeventargs_swipecontrol.md b/windows.ui.xaml.controls/swipeiteminvokedeventargs_swipecontrol.md new file mode 100644 index 0000000000..b4fd801fa9 --- /dev/null +++ b/windows.ui.xaml.controls/swipeiteminvokedeventargs_swipecontrol.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItemInvokedEventArgs.SwipeControl +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItemInvokedEventArgs.SwipeControl + +## -description + +Gets the [SwipeControl](swipecontrol.md) that owns the invoked item. + +## -property-value + +The SwipeControl that owns the invoked item. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems.md b/windows.ui.xaml.controls/swipeitems.md new file mode 100644 index 0000000000..c8f08651ba --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems.md @@ -0,0 +1,36 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SwipeItems +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems + +## -description + +Represents a collection of [SwipeItem](swipeitem.md) objects. + +## -xaml-syntax + +```xaml + + + oneOrMoreSwipeItemDefinitions + + +``` + +## -xaml-values + +
oneOrMoreSwipeItemDefinitions
oneOrMoreSwipeItemDefinitionsOne or more SwipeItem elements.
+
+ +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_append_1034582120.md b/windows.ui.xaml.controls/swipeitems_append_1034582120.md new file mode 100644 index 0000000000..6a754cb4b6 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_append_1034582120.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.Append(Windows.UI.Xaml.Controls.SwipeItem) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.Append + +## -description + +Adds a new item to the collection. + +## -parameters + +### -param value + +The new item to add. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_clear_556466.md b/windows.ui.xaml.controls/swipeitems_clear_556466.md new file mode 100644 index 0000000000..b7f97be50f --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_clear_556466.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.Clear +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.Clear + +## -description + +Removes all items from the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_first_1920739956.md b/windows.ui.xaml.controls/swipeitems_first_1920739956.md new file mode 100644 index 0000000000..f635b1ed67 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_first_1920739956.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.First +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.First + +## -description + +Returns an iterator for the items in the collection. + +## -returns + +The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_getat_496709656.md b/windows.ui.xaml.controls/swipeitems_getat_496709656.md new file mode 100644 index 0000000000..da69c99b2b --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_getat_496709656.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.GetAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.GetAt + +## -description + +Returns the item located at the specified index. + +## -parameters + +### -param index + +The integer index for the value to retrieve. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_getmany_1909000554.md b/windows.ui.xaml.controls/swipeitems_getmany_1909000554.md new file mode 100644 index 0000000000..aafb7488de --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_getmany_1909000554.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.GetMany(System.UInt32,Windows.UI.Xaml.Controls.SwipeItem[]) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.GetMany + +## -description + +Retrieves multiple elements in a single pass through the iterator. + +## -parameters + +### -param startIndex + +The index from which to start retrieval. + +### -param items + +Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. + +## -returns + +The number of items retrieved. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_getview_37498667.md b/windows.ui.xaml.controls/swipeitems_getview_37498667.md new file mode 100644 index 0000000000..4ab54ca66b --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_getview_37498667.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.GetView +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.GetView + +## -description + +Gets an immutable view into the collection. + +## -returns + +An object representing the immutable collection view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_indexof_1964930904.md b/windows.ui.xaml.controls/swipeitems_indexof_1964930904.md new file mode 100644 index 0000000000..a0a3033c32 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_indexof_1964930904.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.IndexOf(Windows.UI.Xaml.Controls.SwipeItem,System.UInt32@) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.IndexOf + +## -description + +Retrieves the index of the specified item. + +## -parameters + +### -param value + +The value to find in the collection. + +### -param index + +The index of the item to find, if found. + +## -returns + +**true** if an item with the specified value was found; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_insertat_273742706.md b/windows.ui.xaml.controls/swipeitems_insertat_273742706.md new file mode 100644 index 0000000000..aa2786b7cb --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_insertat_273742706.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.InsertAt(System.UInt32,Windows.UI.Xaml.Controls.SwipeItem) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.InsertAt + +## -description + +Inserts the specified item at the specified index. + +## -parameters + +### -param index + +The index at which to set the value. + +### -param value + +The value to set. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_mode.md b/windows.ui.xaml.controls/swipeitems_mode.md new file mode 100644 index 0000000000..e6e6decda7 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_mode.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItems.Mode +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.Mode + +## -description + +Gets or sets a value that indicates the effect of a swipe interaction. + +## -property-value + +A value of the enumeration that indicates the effect of a swipe interaction. The default is **Reveal**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_modeproperty.md b/windows.ui.xaml.controls/swipeitems_modeproperty.md new file mode 100644 index 0000000000..480585a9aa --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_modeproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItems.ModeProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.ModeProperty + +## -description + +Identifies the Mode dependency property. + +## -property-value + +The identifier for the Mode dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_removeat_1960564133.md b/windows.ui.xaml.controls/swipeitems_removeat_1960564133.md new file mode 100644 index 0000000000..e9a84cb9f4 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_removeat_1960564133.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.RemoveAt(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.RemoveAt + +## -description + +Removes the item at the specified index. + +## -parameters + +### -param index + +The index position of the item to remove. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_removeatend_1813436897.md b/windows.ui.xaml.controls/swipeitems_removeatend_1813436897.md new file mode 100644 index 0000000000..4559198419 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_removeatend_1813436897.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.RemoveAtEnd +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.RemoveAtEnd + +## -description + +Removes the last item in the collection. + +## -remarks + +If successful, calling this method reduces the collection size by one. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_replaceall_577387840.md b/windows.ui.xaml.controls/swipeitems_replaceall_577387840.md new file mode 100644 index 0000000000..010435eeef --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_replaceall_577387840.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.ReplaceAll(Windows.UI.Xaml.Controls.SwipeItem[]) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.ReplaceAll + +## -description + +Initially clears the collection, then inserts the provided array as new items. + +## -parameters + +### -param items + +The new collection items. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_setat_1628412674.md b/windows.ui.xaml.controls/swipeitems_setat_1628412674.md new file mode 100644 index 0000000000..72c4122eb6 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_setat_1628412674.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.SetAt(System.UInt32,Windows.UI.Xaml.Controls.SwipeItem) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.SetAt + +## -description + +Sets the value at the specified index to the value specified. + +## -parameters + +### -param index + +The index at which to set the value. + +### -param value + +The value to set. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_size.md b/windows.ui.xaml.controls/swipeitems_size.md new file mode 100644 index 0000000000..25ae396609 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_size.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SwipeItems.Size +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.Size + +## -description + +Gets the size (count) of the collection. + +## -property-value + +The count of items in the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipeitems_swipeitems_1221375020.md b/windows.ui.xaml.controls/swipeitems_swipeitems_1221375020.md new file mode 100644 index 0000000000..09fefdc792 --- /dev/null +++ b/windows.ui.xaml.controls/swipeitems_swipeitems_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SwipeItems.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SwipeItems.SwipeItems + +## -description + +Initializes a new instance of the SwipeItems class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/swipemode.md b/windows.ui.xaml.controls/swipemode.md new file mode 100644 index 0000000000..159c1b8aab --- /dev/null +++ b/windows.ui.xaml.controls/swipemode.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SwipeMode +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Controls.SwipeMode + +## -description + +Defines constants that specify the effect of a swipe interaction. + +## -enum-fields + +### -field Reveal:0 + +A swipe reveals a menu of commands. + +### -field Execute:1 + +A swipe executes a command. + +## -remarks + +This enumeration is used by the [SwipeItems.Mode](swipeitems_mode.md) property. + +## -see-also + +[SwipeItems.Mode](swipeitems_mode.md) + +## -examples + diff --git a/windows.ui.xaml.controls/symbol.md b/windows.ui.xaml.controls/symbol.md index 0edf514087..ca52309335 100644 --- a/windows.ui.xaml.controls/symbol.md +++ b/windows.ui.xaml.controls/symbol.md @@ -598,18 +598,17 @@ E294 Scan icon ### -field Preview:58005 E295 Preview icon - -### -field GlobalNavButton:59136 - +### -field GlobalNavigationButton:59136 +E700 ### -field Print:59209 - +E749 ### -field Share:59181 - +E72D ### -field XboxOneConsole:59792 - +E990 ## -remarks The [Symbol](symbol.md) enumeration is typically used to set the value of the [AppBarButton.Icon](appbarbutton_icon.md) property or the [SymbolIcon.Symbol](symbolicon_symbol.md) property. For more info and examples, see the documentation for [AppBarButton](appbarbutton.md) and [SymbolIcon](symbolicon.md). @@ -626,3 +625,4 @@ The [Symbol](symbol.md) enumeration is typically used to set the value of the [A + diff --git a/windows.ui.xaml.controls/symboliconsource.md b/windows.ui.xaml.controls/symboliconsource.md new file mode 100644 index 0000000000..0e1cda69da --- /dev/null +++ b/windows.ui.xaml.controls/symboliconsource.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.SymbolIconSource +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.SymbolIconSource + +## -description + +Represents an icon source that uses a glyph from the Segoe MDL2 Assets font as its content. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +**SymbolIconSource** is similar to [SymbolIcon](symbolicon.md). However, because it is not a [FrameworkElement](../windows.ui.xaml/frameworkelement.md), it can be shared. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/symboliconsource_symbol.md b/windows.ui.xaml.controls/symboliconsource_symbol.md new file mode 100644 index 0000000000..7732225752 --- /dev/null +++ b/windows.ui.xaml.controls/symboliconsource_symbol.md @@ -0,0 +1,36 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SymbolIconSource.Symbol +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SymbolIconSource.Symbol + +## -description + +Gets or sets the Segoe MDL2 Assets glyph used as the icon content. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
symbolName
symbolNameA named constant of the Symbol enumeration, which enumerates a subset of the Segoe MDL2 Assets font.
+
+ +## -property-value + +A named constant of the numeration that specifies the Segoe MDL2 Assets glyph to use. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/symboliconsource_symboliconsource_1221375020.md b/windows.ui.xaml.controls/symboliconsource_symboliconsource_1221375020.md new file mode 100644 index 0000000000..3dc173ab68 --- /dev/null +++ b/windows.ui.xaml.controls/symboliconsource_symboliconsource_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.SymbolIconSource.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.SymbolIconSource.SymbolIconSource + +## -description + +Initializes a new instance of the SymbolIconSource class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/symboliconsource_symbolproperty.md b/windows.ui.xaml.controls/symboliconsource_symbolproperty.md new file mode 100644 index 0000000000..dd0404fd6d --- /dev/null +++ b/windows.ui.xaml.controls/symboliconsource_symbolproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.SymbolIconSource.SymbolProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.SymbolIconSource.SymbolProperty + +## -description + +Identifies the Symbol dependency property. + +## -property-value + +The identifier for the Symbol dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textblock_horizontaltextalignment.md b/windows.ui.xaml.controls/textblock_horizontaltextalignment.md new file mode 100644 index 0000000000..2056e07fe5 --- /dev/null +++ b/windows.ui.xaml.controls/textblock_horizontaltextalignment.md @@ -0,0 +1,38 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBlock.HorizontalTextAlignment +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBlock.HorizontalTextAlignment + +## -description + +Gets or sets a value that indicates how text is aligned in the TextBlock. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
textAlignmentValue
textAlignmentValueA named constant of the TextAlignment enumeration, such as Left.
+
+ +## -property-value + +One of the [TextAlignment](../windows.ui.xaml/textalignment.md) enumeration values that specifies how text is aligned. The default is **Left**. + +## -remarks + +This property supports [XAML Standard](http://aka.ms/xamlstandard). It provides the same functionality as the **TextAlignement** property. If both properties are set to conflicting values, the last one set is used. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textblock_horizontaltextalignmentproperty.md b/windows.ui.xaml.controls/textblock_horizontaltextalignmentproperty.md new file mode 100644 index 0000000000..6b41d1a375 --- /dev/null +++ b/windows.ui.xaml.controls/textblock_horizontaltextalignmentproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBlock.HorizontalTextAlignmentProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBlock.HorizontalTextAlignmentProperty + +## -description + +Identifies the HorizontalTextAlignment dependency property. + +## -property-value + +The identifier for the HorizontalTextAlignment dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textblock_istexttrimmed.md b/windows.ui.xaml.controls/textblock_istexttrimmed.md new file mode 100644 index 0000000000..925583aeac --- /dev/null +++ b/windows.ui.xaml.controls/textblock_istexttrimmed.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBlock.IsTextTrimmed +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBlock.IsTextTrimmed + +## -description + +Gets a value that indicates whether the control has trimmed text that overflows the content area. + +## -property-value + +**true** if text is trimmed; otherwise, **false**. + +## -remarks + +See the TextTrimming property and [TextTrimming](../windows.ui.xaml/texttrimming.md) enumeration for more info about how text is trimmed. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textblock_istexttrimmedchanged.md b/windows.ui.xaml.controls/textblock_istexttrimmedchanged.md new file mode 100644 index 0000000000..c55fb3309b --- /dev/null +++ b/windows.ui.xaml.controls/textblock_istexttrimmedchanged.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.TextBlock.IsTextTrimmedChanged +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.TextBlock.IsTextTrimmedChanged + +## -description + +Occurs when the **IsTextTrimmed** property value has changed. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textblock_istexttrimmedproperty.md b/windows.ui.xaml.controls/textblock_istexttrimmedproperty.md new file mode 100644 index 0000000000..ededd93c21 --- /dev/null +++ b/windows.ui.xaml.controls/textblock_istexttrimmedproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBlock.IsTextTrimmedProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBlock.IsTextTrimmedProperty + +## -description + +Identifies the IsTextTrimmed dependency property. + +## -property-value + +The identifier for the IsTextTrimmed dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textblock_texthighlighters.md b/windows.ui.xaml.controls/textblock_texthighlighters.md new file mode 100644 index 0000000000..763609e51f --- /dev/null +++ b/windows.ui.xaml.controls/textblock_texthighlighters.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBlock.TextHighlighters +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBlock.TextHighlighters + +## -description + +Gets the collection of text highlights. + +## -property-value + +The collection of text highlights. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_beforetextchanging.md b/windows.ui.xaml.controls/textbox_beforetextchanging.md new file mode 100644 index 0000000000..2bcacee2b4 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_beforetextchanging.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.TextBox.BeforeTextChanging +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.TextBox.BeforeTextChanging + +## -description + +Occurs synchronously when the text in the text box starts to change, but before the **Text** property is updated. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_charactercasing.md b/windows.ui.xaml.controls/textbox_charactercasing.md new file mode 100644 index 0000000000..893b2c0f68 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_charactercasing.md @@ -0,0 +1,39 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBox.CharacterCasing +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBox.CharacterCasing + +## -description + +Gets or sets a value that indicates how the control modifies the case of characters as they are typed. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
characterCasingValue
characterCasingValueA named constant of the CharacterCasing enumeration, such as Upper.
+
+ +## -property-value + +A value of the enumeration that indicates how the control modifies the case of characters as they are typed. The default is **Normal**, which indicates that the charcters are not changed. + +## -remarks + +> [!NOTE] +> This property modifies the case of characters as they are typed. It doesn’t modify characters that are entered in other ways, like paste or ink. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_charactercasingproperty.md b/windows.ui.xaml.controls/textbox_charactercasingproperty.md new file mode 100644 index 0000000000..c32b831042 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_charactercasingproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBox.CharacterCasingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBox.CharacterCasingProperty + +## -description + +Identifies the CharacterCasing dependency property. + +## -property-value + +The identifier for the CharacterCasing dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_copyingtoclipboard.md b/windows.ui.xaml.controls/textbox_copyingtoclipboard.md new file mode 100644 index 0000000000..708ad941fa --- /dev/null +++ b/windows.ui.xaml.controls/textbox_copyingtoclipboard.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.TextBox.CopyingToClipboard +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.TextBox.CopyingToClipboard + +## -description + +Occurs before copied text is moved to the clipboard. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_cuttingtoclipboard.md b/windows.ui.xaml.controls/textbox_cuttingtoclipboard.md new file mode 100644 index 0000000000..811e795d95 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_cuttingtoclipboard.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.TextBox.CuttingToClipboard +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.TextBox.CuttingToClipboard + +## -description + +Occurs before cut text is moved to the clipboard. + +## -xaml-syntax + +```xaml + +``` + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_horizontaltextalignment.md b/windows.ui.xaml.controls/textbox_horizontaltextalignment.md new file mode 100644 index 0000000000..f450e73583 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_horizontaltextalignment.md @@ -0,0 +1,38 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBox.HorizontalTextAlignment +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBox.HorizontalTextAlignment + +## -description + +Gets or sets a value that indicates how text is aligned in the TextBox. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
textAlignmentValue
textAlignmentValueA named constant of the TextAlignment enumeration, such as Left.
+
+ +## -property-value + +One of the [TextAlignment](../windows.ui.xaml/textalignment.md) enumeration values that specifies how text is aligned. The default is **Left**. + +## -remarks + +This property supports [XAML Standard](http://aka.ms/xamlstandard). It provides the same functionality as the **TextAlignement** property. If both properties are set to conflicting values, the last one set is used. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_horizontaltextalignmentproperty.md b/windows.ui.xaml.controls/textbox_horizontaltextalignmentproperty.md new file mode 100644 index 0000000000..bedc3d8867 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_horizontaltextalignmentproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBox.HorizontalTextAlignmentProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBox.HorizontalTextAlignmentProperty + +## -description + +Identifies the HorizontalTextAlignment dependency property. + +## -property-value + +The identifier for the HorizontalTextAlignment dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_placeholderforeground.md b/windows.ui.xaml.controls/textbox_placeholderforeground.md new file mode 100644 index 0000000000..9d33bac4f4 --- /dev/null +++ b/windows.ui.xaml.controls/textbox_placeholderforeground.md @@ -0,0 +1,41 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBox.PlaceholderForeground +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBox.PlaceholderForeground + +## -description + +Gets or sets a brush that describes the color of placeholder text. + +## -xaml-syntax + +```xaml + +``` + +```xaml + +``` + +## -xaml-values + +
resourceName
resourceNameThe resource name (x:Key attribute value) of an existing XAML resource that defines a brush. This is the recommended way to specify Brush values in XAML if you have any intention of using the same colors or brushes in more than one part of your UI. See Remarks in Brush or ResourceDictionary and XAML resource references.
+
colorString
colorStringThe Color for a SolidColorBrush expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
+
+ +## -property-value + +The brush that describes the color of placeholder text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_placeholderforegroundproperty.md b/windows.ui.xaml.controls/textbox_placeholderforegroundproperty.md new file mode 100644 index 0000000000..10a5f799fc --- /dev/null +++ b/windows.ui.xaml.controls/textbox_placeholderforegroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBox.PlaceholderForegroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBox.PlaceholderForegroundProperty + +## -description + +Identifies the PlaceholderForeground dependency property. + +## -property-value + +The identifier for the PlaceholderForeground dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textbox_textcompositionchanged.md b/windows.ui.xaml.controls/textbox_textcompositionchanged.md index fe4768bf22..0e2fb1f0e0 100644 --- a/windows.ui.xaml.controls/textbox_textcompositionchanged.md +++ b/windows.ui.xaml.controls/textbox_textcompositionchanged.md @@ -12,6 +12,12 @@ public event Windows.Foundation.TypedEventHandler TextCompositionChanged +``` + ## -remarks For event data, see [TextCompositionChangedEventArgs](textcompositionchangedeventargs.md). diff --git a/windows.ui.xaml.controls/textbox_textcompositionended.md b/windows.ui.xaml.controls/textbox_textcompositionended.md index 43e6ead0f2..3b729d4edb 100644 --- a/windows.ui.xaml.controls/textbox_textcompositionended.md +++ b/windows.ui.xaml.controls/textbox_textcompositionended.md @@ -12,6 +12,12 @@ public event Windows.Foundation.TypedEventHandler TextCompositionEnded +``` + ## -remarks For event data, see [TextCompositionEndedEventArgs](textcompositionendedeventargs.md). diff --git a/windows.ui.xaml.controls/textbox_textcompositionstarted.md b/windows.ui.xaml.controls/textbox_textcompositionstarted.md index f26a953611..ac2a7ca27b 100644 --- a/windows.ui.xaml.controls/textbox_textcompositionstarted.md +++ b/windows.ui.xaml.controls/textbox_textcompositionstarted.md @@ -12,6 +12,12 @@ public event Windows.Foundation.TypedEventHandler TextCompositionStarted +``` + ## -remarks For event data, see [TextCompositionStartedEventArgs](textcompositionstartedeventargs.md). diff --git a/windows.ui.xaml.controls/textboxbeforetextchangingeventargs.md b/windows.ui.xaml.controls/textboxbeforetextchangingeventargs.md new file mode 100644 index 0000000000..a310d9c175 --- /dev/null +++ b/windows.ui.xaml.controls/textboxbeforetextchangingeventargs.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.TextBoxBeforeTextChangingEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.TextBoxBeforeTextChangingEventArgs + +## -description + +Provides event data for the [TextBox.BeforeTextChanging](textbox_beforetextchanging.md) event. + +## -remarks + +An instance of this class is passed as a parameter to the [BeforeTextChanging](textbox_beforetextchanging.md) event handler. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textboxbeforetextchangingeventargs_cancel.md b/windows.ui.xaml.controls/textboxbeforetextchangingeventargs_cancel.md new file mode 100644 index 0000000000..8c01d4d5b9 --- /dev/null +++ b/windows.ui.xaml.controls/textboxbeforetextchangingeventargs_cancel.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBoxBeforeTextChangingEventArgs.Cancel +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBoxBeforeTextChangingEventArgs.Cancel + +## -description + +Gets or sets a value that indicates whether to cancel the text changes. + +## -property-value + +**true** to cancel the text changes; otherwise, **false**. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textboxbeforetextchangingeventargs_newtext.md b/windows.ui.xaml.controls/textboxbeforetextchangingeventargs_newtext.md new file mode 100644 index 0000000000..824d7a910c --- /dev/null +++ b/windows.ui.xaml.controls/textboxbeforetextchangingeventargs_newtext.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextBoxBeforeTextChangingEventArgs.NewText +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextBoxBeforeTextChangingEventArgs.NewText + +## -description + +Gets the new text that is entered into the text box. + +## -property-value + +The new text value that is entered into the text box. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textcontrolcopyingtoclipboardeventargs.md b/windows.ui.xaml.controls/textcontrolcopyingtoclipboardeventargs.md new file mode 100644 index 0000000000..64f6dcff0c --- /dev/null +++ b/windows.ui.xaml.controls/textcontrolcopyingtoclipboardeventargs.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.TextControlCopyingToClipboardEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.TextControlCopyingToClipboardEventArgs + +## -description + +Provides event data for the **CopyingToClipboard** event. + +## -remarks + + If you perform any action in the handler for a CopyingToClipboard event, set the **Handled** property to **true**; otherwise, the default copy action is performed. + +## -see-also + +- [TextBox.CopyingToClipboard](textbox_copyingtoclipboard.md) +- [RichEditBox.CopyingToClipboard](richeditbox_copyingtoclipboard.md) + +## -examples + diff --git a/windows.ui.xaml.controls/textcontrolcopyingtoclipboardeventargs_handled.md b/windows.ui.xaml.controls/textcontrolcopyingtoclipboardeventargs_handled.md new file mode 100644 index 0000000000..1a5dad3796 --- /dev/null +++ b/windows.ui.xaml.controls/textcontrolcopyingtoclipboardeventargs_handled.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextControlCopyingToClipboardEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextControlCopyingToClipboardEventArgs.Handled + +## -description + +Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again. + +## -property-value + +**true** to mark the routed event handled. **false** to leave the routed event unhandled, which causes the default copy action to be performed. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/textcontrolcuttingtoclipboardeventargs.md b/windows.ui.xaml.controls/textcontrolcuttingtoclipboardeventargs.md new file mode 100644 index 0000000000..94bfebbe1d --- /dev/null +++ b/windows.ui.xaml.controls/textcontrolcuttingtoclipboardeventargs.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.TextControlCuttingToClipboardEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.TextControlCuttingToClipboardEventArgs + +## -description + +Provides event data for the **CuttingToClipboard** event. + +## -remarks + + If you perform any action in the handler for a CuttingToClipboard event, set the **Handled** property to **true**; otherwise, the default cut action is performed. + +## -see-also + +- [TextBox.CuttingToClipboard](textbox_cuttingtoclipboard.md) +- [RichEditBox.CuttingToClipboard](richeditbox_cuttingtoclipboard.md) + +## -examples + diff --git a/windows.ui.xaml.controls/textcontrolcuttingtoclipboardeventargs_handled.md b/windows.ui.xaml.controls/textcontrolcuttingtoclipboardeventargs_handled.md new file mode 100644 index 0000000000..47bc59069a --- /dev/null +++ b/windows.ui.xaml.controls/textcontrolcuttingtoclipboardeventargs_handled.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.TextControlCuttingToClipboardEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.TextControlCuttingToClipboardEventArgs.Handled + +## -description + +Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again. + +## -property-value + +**true** to mark the routed event handled. **false** to leave the routed event unhandled, which causes the default cut action to be performed. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.data/updatesourcetrigger.md b/windows.ui.xaml.data/updatesourcetrigger.md index 62f91f93b8..6fb196ec9d 100644 --- a/windows.ui.xaml.data/updatesourcetrigger.md +++ b/windows.ui.xaml.data/updatesourcetrigger.md @@ -23,10 +23,13 @@ The binding source is updated whenever the binding target value changes. This is The binding source is updated only when you call the [BindingExpression.UpdateSource](bindingexpression_updatesource.md) method. +### -field LostFocus:3 +The binding source is updated whenever the binding target element loses focus. + ## -remarks > [!NOTE] > The default [UpdateSourceTrigger](updatesourcetrigger.md) value is **Default** rather than **PropertyChanged** for legacy reasons. Previous XAML frameworks enabled a way to register a dependency property with a value that influenced what its default binding update behavior does. That dependency property behavior isn't implemented in the Windows Runtime. ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.ui.xaml.documents/block_horizontaltextalignment.md b/windows.ui.xaml.documents/block_horizontaltextalignment.md new file mode 100644 index 0000000000..b7d2fe6666 --- /dev/null +++ b/windows.ui.xaml.documents/block_horizontaltextalignment.md @@ -0,0 +1,38 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.Block.HorizontalTextAlignment +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.Block.HorizontalTextAlignment + +## -description + +Gets or sets a value that indicates how text is aligned in the Block. + +## -xaml-syntax + +```xaml + +``` + +## -xaml-values + +
textAlignmentValue
textAlignmentValueA named constant of the TextAlignment enumeration, such as Left.
+
+ +## -property-value + +One of the [TextAlignment](../windows.ui.xaml/textalignment.md) enumeration values that specifies how text is aligned. The default is **Left**. + +## -remarks + +This property supports [XAML Standard](http://aka.ms/xamlstandard). It provides the same functionality as the **TextAlignement** property. If both properties are set to conflicting values, the last one set is used. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/block_horizontaltextalignmentproperty.md b/windows.ui.xaml.documents/block_horizontaltextalignmentproperty.md new file mode 100644 index 0000000000..851ef6726c --- /dev/null +++ b/windows.ui.xaml.documents/block_horizontaltextalignmentproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.Block.HorizontalTextAlignmentProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.Block.HorizontalTextAlignmentProperty + +## -description + +Identifies the HorizontalTextAlignment dependency property. + +## -property-value + +The identifier for the HorizontalTextAlignment dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter.md b/windows.ui.xaml.documents/texthighlighter.md new file mode 100644 index 0000000000..467580b519 --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Documents.TextHighlighter +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter + +## -description + +Represents an object that highlights one or more ranges of text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter_background.md b/windows.ui.xaml.documents/texthighlighter_background.md new file mode 100644 index 0000000000..08a3954aef --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter_background.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.TextHighlighter.Background +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter.Background + +## -description + +Gets or sets the brush used to highlight the text. + +## -property-value + +The brush used to highlight the text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter_backgroundproperty.md b/windows.ui.xaml.documents/texthighlighter_backgroundproperty.md new file mode 100644 index 0000000000..48451dbcda --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter_backgroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.TextHighlighter.BackgroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter.BackgroundProperty + +## -description + +Identifies the Background dependency property. + +## -property-value + +The identifier for the Background dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter_foreground.md b/windows.ui.xaml.documents/texthighlighter_foreground.md new file mode 100644 index 0000000000..480b3e4556 --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter_foreground.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.TextHighlighter.Foreground +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter.Foreground + +## -description + +Gets or sets the brush used to color highlighted text. + +## -property-value + +The brush used to color highlighted text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter_foregroundproperty.md b/windows.ui.xaml.documents/texthighlighter_foregroundproperty.md new file mode 100644 index 0000000000..e8e855d5ec --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter_foregroundproperty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.TextHighlighter.ForegroundProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter.ForegroundProperty + +## -description + +Identifies the Foreground dependency property. + +## -property-value + +The identifier for the Foreground dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter_ranges.md b/windows.ui.xaml.documents/texthighlighter_ranges.md new file mode 100644 index 0000000000..8fcaed4d8f --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter_ranges.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Documents.TextHighlighter.Ranges +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter.Ranges + +## -description + +Gets the text ranges to highlight. + +## -property-value + +The collection of text ranges to highlight. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighter_texthighlighter_1221375020.md b/windows.ui.xaml.documents/texthighlighter_texthighlighter_1221375020.md new file mode 100644 index 0000000000..9581a172dc --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighter_texthighlighter_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Documents.TextHighlighter.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighter.TextHighlighter + +## -description + +Initializes a new instance of the TextHighlighter class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/texthighlighterbase.md b/windows.ui.xaml.documents/texthighlighterbase.md new file mode 100644 index 0000000000..8ab7c98ad3 --- /dev/null +++ b/windows.ui.xaml.documents/texthighlighterbase.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Documents.TextHighlighterBase +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Documents.TextHighlighterBase + +## -description + +The base class for [TextHighlighter](texthighlighter.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.documents/textrange.md b/windows.ui.xaml.documents/textrange.md new file mode 100644 index 0000000000..a2ac154abb --- /dev/null +++ b/windows.ui.xaml.documents/textrange.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.UI.Xaml.Documents.TextRange +-api-type: winrt struct +--- + + + +# Windows.UI.Xaml.Documents.TextRange + +## -description + +Represents a selection of text content. + +## -struct-fields + +### -field Length + +The length of the current selection, in Unicode characters. + +### -field StartIndex + +The position that marks the beginning of the current selection, measured in Unicode characters from the beginning of the text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager.md b/windows.ui.xaml.hosting/designerappmanager.md new file mode 100644 index 0000000000..c56673c723 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Hosting.DesignerAppManager +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager + +## -description + +Manages an application in a XAML design surface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_appusermodelid.md b/windows.ui.xaml.hosting/designerappmanager_appusermodelid.md new file mode 100644 index 0000000000..129ee9ff7f --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_appusermodelid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Hosting.DesignerAppManager.AppUserModelId +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.AppUserModelId + +## -description + +Gets the identifier for the app user model. + +## -property-value + +The identifier for the app user model. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_close_811482585.md b/windows.ui.xaml.hosting/designerappmanager_close_811482585.md new file mode 100644 index 0000000000..0b84b7e3fb --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppManager.Close +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.Close + +## -description + +Closes the app manager. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_createnewviewasync_70340253.md b/windows.ui.xaml.hosting/designerappmanager_createnewviewasync_70340253.md new file mode 100644 index 0000000000..8ff4dccdd5 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_createnewviewasync_70340253.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppManager.CreateNewViewAsync(Windows.UI.Xaml.Hosting.DesignerAppViewState,Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.CreateNewViewAsync + +## -description + +Creates a new DesignerAppView. + +## -parameters +### -param initialViewState + +The initial state of the view. + +### -param initialViewSize + +The initial size of the view. + +## -returns + +The created DesignerAppView. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_designerappmanager_290278668.md b/windows.ui.xaml.hosting/designerappmanager_designerappmanager_290278668.md new file mode 100644 index 0000000000..255306b8bf --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_designerappmanager_290278668.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppManager.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.DesignerAppManager + +## -description + +Initializes a new instance of the DesignerAppManager class. + +## -parameters +### -param appUserModelId + +The identifier for the app user model. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_duplicatehandleintoapp_1025983953.md b/windows.ui.xaml.hosting/designerappmanager_duplicatehandleintoapp_1025983953.md new file mode 100644 index 0000000000..0f299bd316 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_duplicatehandleintoapp_1025983953.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppManager.DuplicateHandleIntoApp(System.UInt64,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.DuplicateHandleIntoApp + +## -description + +Adds a copy of a handle into the app. + +## -parameters +### -param handle + +The handle to duplicate. + +### -param inheritable + +**true** if the handle can be inherited; otherwise, **false**. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_loadobjectintoappasync_712292650.md b/windows.ui.xaml.hosting/designerappmanager_loadobjectintoappasync_712292650.md new file mode 100644 index 0000000000..0425e4aef1 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_loadobjectintoappasync_712292650.md @@ -0,0 +1,38 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppManager.LoadObjectIntoAppAsync(System.String,System.Guid,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.LoadObjectIntoAppAsync + +## -description + +Loads the specified object into the app. + +## -parameters +### -param dllName + +The name of the DLL. + +### -param classId + +The identifier for the class. + +### -param initializationData + +Data to initialize the object. + +## -returns + +The asynchronous results of the operation. Use this to determine when the async call is complete. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappmanager_processexited.md b/windows.ui.xaml.hosting/designerappmanager_processexited.md new file mode 100644 index 0000000000..fc1f28c475 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappmanager_processexited.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.Xaml.Hosting.DesignerAppManager.ProcessExited +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppManager.ProcessExited + +## -description + +Occurs when the process has exited. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview.md b/windows.ui.xaml.hosting/designerappview.md new file mode 100644 index 0000000000..da4ddb3773 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Hosting.DesignerAppView +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView + +## -description + +Represents an app view in a XAML design surface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview_applicationviewid.md b/windows.ui.xaml.hosting/designerappview_applicationviewid.md new file mode 100644 index 0000000000..c84d261988 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview_applicationviewid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Hosting.DesignerAppView.ApplicationViewId +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView.ApplicationViewId + +## -description + +Gets the identifier for the app view. + +## -property-value + +The identifier for the app view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview_appusermodelid.md b/windows.ui.xaml.hosting/designerappview_appusermodelid.md new file mode 100644 index 0000000000..27960a5bd4 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview_appusermodelid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Hosting.DesignerAppView.AppUserModelId +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView.AppUserModelId + +## -description + +Gets the identifier for the app user model. + +## -property-value + +The identifier for the app user model. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview_close_811482585.md b/windows.ui.xaml.hosting/designerappview_close_811482585.md new file mode 100644 index 0000000000..7c475b8e92 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppView.Close +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView.Close + +## -description + +Closes the app view in the designer. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview_updateviewasync_1985119353.md b/windows.ui.xaml.hosting/designerappview_updateviewasync_1985119353.md new file mode 100644 index 0000000000..c2d0d24371 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview_updateviewasync_1985119353.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Xaml.Hosting.DesignerAppView.UpdateViewAsync(Windows.UI.Xaml.Hosting.DesignerAppViewState,Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView.UpdateViewAsync + +## -description + +Updates the app view in the designer. + +## -parameters +### -param viewState + +The state of the app view. + +### -param viewSize + +The size of the app view. + +## -returns + +The asynchronous results of the operation. Use this to determine when the async call is complete. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview_viewsize.md b/windows.ui.xaml.hosting/designerappview_viewsize.md new file mode 100644 index 0000000000..534b45485d --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview_viewsize.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Hosting.DesignerAppView.ViewSize +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView.ViewSize + +## -description + +Get the size of the app view in the designer. + +## -property-value + +The size of the app view in the designer. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappview_viewstate.md b/windows.ui.xaml.hosting/designerappview_viewstate.md new file mode 100644 index 0000000000..c348d41451 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappview_viewstate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Hosting.DesignerAppView.ViewState +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppView.ViewState + +## -description + +Gets a value that indicates whether the view is visible or hidden. + +## -property-value + +A value that indicates whether the view is **Visible** or **Hidden**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/designerappviewstate.md b/windows.ui.xaml.hosting/designerappviewstate.md new file mode 100644 index 0000000000..a5e2d0edd9 --- /dev/null +++ b/windows.ui.xaml.hosting/designerappviewstate.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.Xaml.Hosting.DesignerAppViewState +-api-type: winrt enum +--- + + + +# Windows.UI.Xaml.Hosting.DesignerAppViewState + +## -description + +Defines constants that specify whether the app view is visible or hidden. + +## -enum-fields +### -field Visible:0 + +The app view is visible. + +### -field Hidden:1 + +The app view is hidden. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/processexitedeventargs.md b/windows.ui.xaml.hosting/processexitedeventargs.md new file mode 100644 index 0000000000..db9a64ea99 --- /dev/null +++ b/windows.ui.xaml.hosting/processexitedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Hosting.ProcessExitedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Hosting.ProcessExitedEventArgs + +## -description + +Provides event data for the [DesignerAppManager.ProcessExited](designerappmanager_processexited.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.hosting/processexitedeventargs_exitcode.md b/windows.ui.xaml.hosting/processexitedeventargs_exitcode.md new file mode 100644 index 0000000000..5c2774837c --- /dev/null +++ b/windows.ui.xaml.hosting/processexitedeventargs_exitcode.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Hosting.ProcessExitedEventArgs.ExitCode +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Hosting.ProcessExitedEventArgs.ExitCode + +## -description + +Gets the exit code for the app exit event. + +## -property-value + +The exit code for the app exit event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/characterreceivedroutedeventargs.md b/windows.ui.xaml.input/characterreceivedroutedeventargs.md new file mode 100644 index 0000000000..c2c8c7b1b3 --- /dev/null +++ b/windows.ui.xaml.input/characterreceivedroutedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs + +## -description +Provides event data for the [UIElement.CharacterReceived](../windows.ui.xaml/uielement_characterreceived.md) routed event. + +## -remarks + +## -examples + +## -see-also +[RoutedEventArgs](../windows.ui.xaml/routedeventargs.md) + diff --git a/windows.ui.xaml.input/characterreceivedroutedeventargs_character.md b/windows.ui.xaml.input/characterreceivedroutedeventargs_character.md new file mode 100644 index 0000000000..ce8381776c --- /dev/null +++ b/windows.ui.xaml.input/characterreceivedroutedeventargs_character.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs.Character +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs.Character + +## -description +Gets the composed character associated with the [UIElement.CharacterReceived](../windows.ui.xaml/uielement_characterreceived.md) event. + +> [!NOTE] +> A composed character is a single visual object derived from a sequence of one or more other characters. + +## -property-value +The composed character associated with the [UIElement.CharacterReceived](../windows.ui.xaml/uielement_characterreceived.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/characterreceivedroutedeventargs_handled.md b/windows.ui.xaml.input/characterreceivedroutedeventargs_handled.md new file mode 100644 index 0000000000..3927ca472d --- /dev/null +++ b/windows.ui.xaml.input/characterreceivedroutedeventargs_handled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs.Handled + +## -description +Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again. + +## -property-value +**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**. + +## -remarks + +## -examples + +## -see-also +[Events and routed events overview](http://msdn.microsoft.com/library/34c219e8-3efb-45bc-8bbd-6fd937698832) diff --git a/windows.ui.xaml.input/characterreceivedroutedeventargs_keystatus.md b/windows.ui.xaml.input/characterreceivedroutedeventargs_keystatus.md new file mode 100644 index 0000000000..231405b6a1 --- /dev/null +++ b/windows.ui.xaml.input/characterreceivedroutedeventargs_keystatus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs.KeyStatus +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.CharacterReceivedRoutedEventArgs.KeyStatus + +## -description +Gets the status of the physical key that raised the character-received event. + +## -property-value +The status of the key that was pressed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/contextrequestedeventargs.md b/windows.ui.xaml.input/contextrequestedeventargs.md index 448872c531..de89444f1b 100644 --- a/windows.ui.xaml.input/contextrequestedeventargs.md +++ b/windows.ui.xaml.input/contextrequestedeventargs.md @@ -13,7 +13,6 @@ public class ContextRequestedEventArgs : Windows.UI.Xaml.RoutedEventArgs, Window Provides event data for the [ContextRequested](../windows.ui.xaml/uielement_contextrequested.md) event. ## -remarks -Available starting in Windows 10, version 1607. ## -examples diff --git a/windows.ui.xaml.input/contextrequestedeventargs_handled.md b/windows.ui.xaml.input/contextrequestedeventargs_handled.md index 475d4bb72d..c3d0372ad4 100644 --- a/windows.ui.xaml.input/contextrequestedeventargs_handled.md +++ b/windows.ui.xaml.input/contextrequestedeventargs_handled.md @@ -20,3 +20,4 @@ Gets or sets a value that marks the routed event as handled. A **true** value fo ## -examples ## -see-also +[Events and routed events overview](http://msdn.microsoft.com/library/34c219e8-3efb-45bc-8bbd-6fd937698832) \ No newline at end of file diff --git a/windows.ui.xaml.input/keyboardaccelerator.md b/windows.ui.xaml.input/keyboardaccelerator.md new file mode 100644 index 0000000000..dcc463ed16 --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.UI.Xaml.Input.KeyboardAccelerator +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator + +## -description +Represents a keyboard shortcut (or accelerator) that lets a user perform an action using the keyboard instead of navigating the app UI (directly or through access keys). + +Accelerators are typically assigned to buttons or menu items. + +## -remarks +An accelerator key can be a single key, such as F1 - F12 and Esc, or a combination of keys (Ctrl + Shift + B, or Ctrl C) that invoke a command. They differ from access keys (mnemonics), which are typically modified with the Alt key and simply activate a command or control. + +An accelerator can be executed even if the element associated with the accelerator is not visible. For example, an item in the [SecondaryCommands](..\windows.ui.xaml.controls\commandbar_secondarycommands.md) collection of the [**CommandBar**](..\windows.ui.xaml.controls\commandbar.md) can be invoked using an accelerator without expanding the overflow menu and displaying the element. + +By default, an accelerator has global scope. However, you can constrain scope using [ScopeOwner](keyboardaccelerator_scopeowner.md) or disable an accelerator completely using [IsEnabled](keyboardaccelerator_isenabled.md). + +## -examples + +## -see-also diff --git a/windows.ui.xaml.input/keyboardaccelerator_invoked.md b/windows.ui.xaml.input/keyboardaccelerator_invoked.md new file mode 100644 index 0000000000..3470c7f8ea --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_invoked.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Xaml.Input.KeyboardAccelerator.Invoked +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.Invoked + +## -description +Occurs when the key combination for this [**KeyboardAccelerator**](keyboardaccelerator.md) is pressed. + +## -remarks + +## -examples + +## -see-also +- [KeyboardAcceleratorInvokedEventArgs](keyboardacceleratorinvokedeventargs.md) diff --git a/windows.ui.xaml.input/keyboardaccelerator_isenabled.md b/windows.ui.xaml.input/keyboardaccelerator_isenabled.md new file mode 100644 index 0000000000..3189beb361 --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_isenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.IsEnabled +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.IsEnabled + +## -description +Gets or sets whether a keyboard shortcut (accelerator) is available to the user. + +## -property-value +**true** if the shortcut is available; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_isenabledproperty.md b/windows.ui.xaml.input/keyboardaccelerator_isenabledproperty.md new file mode 100644 index 0000000000..e3d44ae127 --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_isenabledproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.IsEnabledProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.IsEnabledProperty + +## -description +Identifies the [IsEnabled](keyboardaccelerator_isenabled.md) dependency property. + +## -property-value +The identifier for the [IsEnabled](keyboardaccelerator_isenabled.md) dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_key.md b/windows.ui.xaml.input/keyboardaccelerator_key.md new file mode 100644 index 0000000000..5d6fd48263 --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_key.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.Key +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.Key + +## -description +Gets or sets the virtual key (used in conjunction with one or more modifier keys) for a keyboard shortcut (accelerator). + +A keyboard shortcut is invoked when the modifier keys asssociated with the shortcut are pressed and then the non-modifier key is pressed at the same time. For example, Ctrl+C for copy and Ctrl+S for save. + +## -property-value +The virtual key. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_keyboardaccelerator_1221375020.md b/windows.ui.xaml.input/keyboardaccelerator_keyboardaccelerator_1221375020.md new file mode 100644 index 0000000000..0e0cc16056 --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_keyboardaccelerator_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.UI.Xaml.Input.KeyboardAccelerator.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.KeyboardAccelerator + +## -description +Initializes a new instance of the [**KeyboardAccelerator**](keyboardaccelerator.md) class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_keyproperty.md b/windows.ui.xaml.input/keyboardaccelerator_keyproperty.md new file mode 100644 index 0000000000..68b06cd1eb --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_keyproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.KeyProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.KeyProperty + +## -description +Identifies the [Key](keyboardaccelerator_key.md) dependency property. + +## -property-value +The identifier for the [Key](keyboardaccelerator_key.md) dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_modifiers.md b/windows.ui.xaml.input/keyboardaccelerator_modifiers.md new file mode 100644 index 0000000000..2d3cd8fb1a --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_modifiers.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.Modifiers +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.Modifiers + +## -description +Gets or sets the virtual key used to modify another keypress for a keyboard shortcut (accelerator). + +A keyboard shortcut is invoked when the modifier keys asssociated with the shortcut are pressed and then the non-modifier key is pressed at the same time. For example, Ctrl+C for copy and Ctrl+S for save. + +## -property-value +The virtual key. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_modifiersproperty.md b/windows.ui.xaml.input/keyboardaccelerator_modifiersproperty.md new file mode 100644 index 0000000000..58756f87a2 --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_modifiersproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.ModifiersProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.ModifiersProperty + +## -description +Identifies the [Modifiers](keyboardaccelerator_modifiers.md) dependency property. + +## -property-value +The identifier for the [Modifiers](keyboardaccelerator_modifiers.md) dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.input/keyboardaccelerator_scopeowner.md b/windows.ui.xaml.input/keyboardaccelerator_scopeowner.md new file mode 100644 index 0000000000..5775a1301d --- /dev/null +++ b/windows.ui.xaml.input/keyboardaccelerator_scopeowner.md @@ -0,0 +1,45 @@ +--- +-api-id: P:Windows.UI.Xaml.Input.KeyboardAccelerator.ScopeOwner +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Input.KeyboardAccelerator.ScopeOwner + +## -description +Gets or sets the scope (or target) of the keyboard accelerator. + +## -property-value +The default is null (global scope). + +## -remarks +By default, an accelerator has global scope. However, you can constrain scope using [ScopeOwner](keyboardaccelerator_scopeowner.md) or disable an accelerator completely using [IsEnabled](keyboardaccelerator_isenabled.md). + +## -see-also + +## -examples + +This example demonstrates how to create a scoped accelerator. The Ctrl+Menu+S accelerator is invoked only if the focus is on a child of `MainGrid`. + +```xaml + + … + + … + + > + … +