Skip to content

Commit fc4d096

Browse files
VladislavAntonyukVladislavAntonyuk
authored
Merge branch 'main' into 2934-mct-docs
2 parents a6d2eb8 + 9f76fad commit fc4d096

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+7158
-0
lines changed

‎docs/archive/windows/backgroundtaskhelper.md‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
---
2+
title: Background Task Helper
3+
author: nmetulev
4+
description: The Background Task Helper helps users interact with background tasks in an easier manner.
5+
keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, Background Task Helper
6+
dev_langs:
7+
- csharp
8+
- vb
9+
---
10+
11+
# Background Task Helper (Archived)
12+
13+
> [!WARNING]
14+
> This document has been archived and the component is not available in the current version of the Windows Community Toolkit.
15+
>
16+
> While there are no immediate plans to port this component to 8.x, the community is welcome to express interest or contribute to its inclusion.
17+
>
18+
> For more information:
19+
> - [Community Toolkit GitHub repository](https://github.com/CommunityToolkit/Windows)
20+
> - [Documentation feedback and suggestions](https://github.com/MicrosoftDocs/CommunityToolkit/issues)
21+
>
22+
> Original documentation follows below.
23+
24+
---
25+
26+
The [Background Task Helper](/dotnet/api/microsoft.toolkit.uwp.helpers.backgroundtaskhelper) helps users interact with background tasks in an easier manner.
27+
28+
> [!div class="nextstepaction"]
29+
> [Try it in the sample app](uwpct://Helpers?sample=BackgroundTaskHelper)
30+
31+
## Syntax
32+
33+
```csharp
34+
using Microsoft.Toolkit.Uwp;
35+
36+
BackgroundTaskRegistration registered = BackgroundTaskHelper.Register(typeof(BackgroundTaskClass), new TimeTrigger(15, true));
37+
BackgroundTaskRegistration registered = BackgroundTaskHelper.Register("TaskName", "TaskEntryPoint", new TimeTrigger(15, true));
38+
```
39+
40+
```vb
41+
Imports Microsoft.Toolkit.Uwp
42+
43+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register(GetType(BackgroundTaskClass), New TimeTrigger(15, True))
44+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register("TaskName", "TaskEntryPoint", New TimeTrigger(15, True))
45+
```
46+
47+
## Methods
48+
49+
| Methods | Return Type | Description |
50+
| -- | -- | -- |
51+
| GetBackgroundTask(String) | [IBackgroundTaskRegistration](/uwp/api/Windows.ApplicationModel.Background.IBackgroundTaskRegistration) | Get the registered background task of the given type |
52+
| GetBackgroundTask(Type) | IBackgroundTaskRegistration | Get the registered background task of the given type |
53+
| IsBackgroundTaskRegistered(String) | bool | Check if a background task is registered |
54+
| IsBackgroundTaskRegistered(Type) | bool | Check if a background task is registered |
55+
| Register(String, IBackgroundTrigger, Boolean, Boolean, IBackgroundCondition[]) | [BackgroundTaskRegistration](/uwp/api/Windows.ApplicationModel.Background.BackgroundTaskRegistration) | Registers under the Single Process Model |
56+
| Register(Type, IBackgroundTrigger, Boolean, Boolean, IBackgroundCondition[]) | BackgroundTaskRegistration | Register a background task with conditions |
57+
| Register(String, String, IBackgroundTrigger, Boolean, Boolean, IBackgroundCondition[]) | BackgroundTaskRegistration | Register a background task with conditions |
58+
| Unregister(String, Boolean) | void | Unregister a background task |
59+
| Unregister(Type, Boolean) | void | Unregister a background task |
60+
| Unregister(IBackgroundTaskRegistration, Boolean) | void | Unregister a background task |
61+
62+
## Example
63+
64+
### Using Multi-Process Model
65+
66+
Using MPM (Multi-Process Model) is the classic way of using Background Task.
67+
68+
To make it work, you will need :
69+
70+
* To create Background Tasks in a Windows Runtime Component
71+
* To register the Background Tasks in the package manifest (appxmanifest file)
72+
73+
Once it is done, you can register your Background Tasks.
74+
75+
```csharp
76+
// Be sure to include the using at the top of the file:
77+
using Microsoft.Toolkit.Uwp;
78+
using Windows.ApplicationModel.Background;
79+
80+
// Register a normal, separate process, background task
81+
BackgroundTaskRegistration registered = BackgroundTaskHelper.Register("TaskName", "TaskEntryPoint", new TimeTrigger(15, true));
82+
83+
// This can also be written using the overload of Register with Type parameter.
84+
BackgroundTaskRegistration registered = BackgroundTaskHelper.Register(typeof(BackgroundTaskClass), new TimeTrigger(15, true));
85+
86+
// With condition
87+
BackgroundTaskRegistration registered =
88+
BackgroundTaskHelper.Register(typeof(BackgroundTaskClass),
89+
new TimeTrigger(15, true),
90+
false, true,
91+
new SystemCondition(SystemConditionType.InternetAvailable));
92+
93+
// 2 or more conditions
94+
BackgroundTaskRegistration registered =
95+
BackgroundTaskHelper.Register(typeof(BackgroundTaskClass),
96+
new TimeTrigger(15, true),
97+
false, true,
98+
new SystemCondition(SystemConditionType.InternetAvailable),
99+
new SystemCondition(SystemConditionType.UserPresent));
100+
```
101+
102+
```vb
103+
' Be sure to include the Imports at the top of the file:
104+
Imports Microsoft.Toolkit.Uwp
105+
Imports Windows.ApplicationModel.Background
106+
107+
' Register a normal, separate process, background task
108+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register("TaskName", "TaskEntryPoint", New TimeTrigger(15, True))
109+
110+
' This can also be written using the overload of Register with Type parameter.
111+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register(GetType(BackgroundTaskClass), New TimeTrigger(15, True))
112+
113+
' With condition
114+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register(GetType(BackgroundTaskClass),
115+
New TimeTrigger(15, True),
116+
False,
117+
True,
118+
New SystemCondition(SystemConditionType.InternetAvailable))
119+
120+
' 2 or more conditions
121+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register(GetType(BackgroundTaskClass),
122+
New TimeTrigger(15, True),
123+
False,
124+
True,
125+
New SystemCondition(SystemConditionType.InternetAvailable),
126+
New SystemCondition(SystemConditionType.UserPresent))
127+
```
128+
129+
### Using Single-Process Model
130+
131+
Using SPM (Single-Process Model) is the new and simple way of using Background Task.
132+
It is required to target Anniversary Update (SDK 14393) or later.
133+
134+
Using SPM, you can declare your Background Tasks inside your own project, no need to create a Windows Runtime Component.
135+
Moreover, it is no longer required to register the Background Tasks in the package manifest (appxmanifest file).
136+
137+
Once you have created the Background Task, you can register it by calling the `Register` method.
138+
139+
```csharp
140+
// Be sure to include the using at the top of the file:
141+
using Microsoft.Toolkit.Uwp;
142+
using Windows.ApplicationModel.Background;
143+
144+
// Register a single process background task (Anniversary Update and later ONLY)
145+
BackgroundTaskRegistration registered = BackgroundTaskHelper.Register("Name of the Background Task", new TimeTrigger(15, true));
146+
```
147+
148+
```vb
149+
' Be sure to include the imports at the top of the file:
150+
Imports Microsoft.Toolkit.Uwp
151+
Imports Windows.ApplicationModel.Background
152+
153+
' Register a single process background task (Anniversary Update and later ONLY)
154+
Dim registered As BackgroundTaskRegistration = BackgroundTaskHelper.Register("Name of the Background Task", New TimeTrigger(15, True))
155+
```
156+
157+
The other difference between SPM and MPM is that in SPM, you have to handle your Background Tasks inside the `OnBackgroundActivated` event of `App.xaml.cs` class.
158+
Here is an example of how to handle Background Tasks in SPM.
159+
160+
```csharp
161+
// Event fired when a Background Task is activated (in Single Process Model)
162+
protected override void OnBackgroundActivated(BackgroundActivatedEventArgs args)
163+
{
164+
base.OnBackgroundActivated(args);
165+
166+
var deferral = args.TaskInstance.GetDeferral();
167+
168+
switch (args.TaskInstance.Task.Name)
169+
{
170+
case "Name of the Background Task":
171+
new TestBackgroundTask().Run(args.TaskInstance);
172+
break;
173+
}
174+
175+
deferral.Complete();
176+
}
177+
```
178+
179+
```vb
180+
Protected Overrides Sub OnBackgroundActivated(ByVal args As BackgroundActivatedEventArgs)
181+
MyBase.OnBackgroundActivated(args)
182+
183+
Dim deferral = args.TaskInstance.GetDeferral()
184+
185+
Select Case args.TaskInstance.Task.Name
186+
Case "Name of the Background Task"
187+
New TestBackgroundTask().Run(args.TaskInstance)
188+
End Select
189+
190+
deferral.Complete()
191+
End Sub
192+
```
193+
194+
## Sample Project
195+
196+
[Background Task Helper](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackgroundTaskHelper). You can [see this in action](uwpct://Helpers?sample=BackgroundTaskHelper) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp).
197+
198+
## Requirements
199+
200+
| Device family | Universal, 10.0.16299.0 or higher |
201+
| --- | --- |
202+
| Namespace | Microsoft.Toolkit.Uwp |
203+
| NuGet package | [Microsoft.Toolkit.Uwp](https://www.nuget.org/packages/Microsoft.Toolkit.Uwp/) |
204+
205+
## API
206+
207+
* [Background Task source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp/Helpers/BackgroundTaskHelper.cs)

‎docs/archive/windows/bindablevalueholder.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: BindableValueHolder
3+
author: nmetulev
4+
description: The BindableValueHolder lets users change several objects' states at a time.
5+
keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, BindableValueHolder
6+
---
7+
8+
# BindableValueHolder (Archived)
9+
10+
> [!WARNING]
11+
> This document has been archived and the component is not available in the current version of the Windows Community Toolkit.
12+
>
13+
> While there are no immediate plans to port this component to 8.x, the community is welcome to express interest or contribute to its inclusion.
14+
>
15+
> For more information:
16+
> - [Community Toolkit GitHub repository](https://github.com/CommunityToolkit/Windows)
17+
> - [Documentation feedback and suggestions](https://github.com/MicrosoftDocs/CommunityToolkit/issues)
18+
> - [GitHub issue #491](https://github.com/CommunityToolkit/Windows/issues/491) (Documentation mapping and porting)
19+
>
20+
> Original documentation follows below.
21+
22+
---
23+
24+
The [BindableValueHolder](/dotnet/api/microsoft.toolkit.uwp.ui.helpers.bindablevalueholder) lets users change several objects' states at a time.
25+
26+
## Syntax
27+
28+
```xaml
29+
<helpers:BindableValueHolder x:Name="BindName" Value="{StaticResource BindValue}" />
30+
```
31+
32+
## Properties
33+
34+
| Property | Type | Description |
35+
| -- | -- | -- |
36+
| Value | object | Gets or sets the held value |
37+
38+
## Example
39+
40+
You can use it to switch several object states by declaring it as a Resource (either in a page or control):
41+
42+
```xaml
43+
<helpers:BindableValueHolder x:Name="HighlightBrushHolder" Value="{StaticResource BlackBrush}" />
44+
```
45+
46+
and using it like that:
47+
48+
```xaml
49+
<TextBlock x:Name="Label" Foreground="{Binding Value, ElementName=HighlightBrushHolder}" />
50+
51+
<TextBox x:Name="Field" BorderBrush="{Binding Value, ElementName=HighlightBrushHolder}" />
52+
```
53+
54+
and switching it like that:
55+
56+
```xaml
57+
<VisualStateGroup x:Name="HighlightStates">
58+
<VisualState x:Name="Normal" />
59+
60+
<VisualState x:Name="Wrong">
61+
<VisualState.Setters>
62+
<Setter Target="HighlightBrushHolder.Value" Value="{StaticResource RedBrush}" />
63+
</VisualState.Setters>
64+
</VisualState>
65+
</VisualStateGroup>
66+
```
67+
68+
## Requirements
69+
70+
| Device family | Universal, 10.0.16299.0 or higher |
71+
| --- | --- |
72+
| Namespace | Microsoft.Toolkit.Uwp.UI |
73+
| NuGet package | [Microsoft.Toolkit.Uwp.UI](https://www.nuget.org/packages/Microsoft.Toolkit.Uwp.UI/) |
74+
75+
## API
76+
77+
* [BindableValueHolder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Helpers/BindableValueHolder.cs)

0 commit comments

Comments
 (0)