Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Removing properties / methods from markdown #147

Merged
merged 1 commit into from
Jul 18, 2023
Merged

Removing properties / methods from markdown #147

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions components/CameraPreview/samples/CameraPreview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,35 +43,9 @@ private void CameraPreviewControl_PreviewFailed(object sender, PreviewFailedEven
}
```


> [!IMPORTANT]
> As a developer, you will need to make sure the CameraHelper resources used by the control are cleaned up when appropriate. See [CameraHelper documentation](../helpers/CameraHelper.md) for more details

## Properties

| Property | Type | Description |
| -- | -- | -- |
| CameraHelper| [CameraHelper](../helpers/CameraHelper.md) | Gets the CameraHelper associated with the control. |
| IsFrameSourceGroupButtonVisible | bool| Set this property to hide or show Frame Source Group Button. Note: This button is conditionally visible based on more than one source being available. |

```xaml
<controls:CameraPreview x:Name="CameraPreviewControl" IsFrameSourceGroupButtonVisible="false"
</controls:CameraPreview>
```

## Methods

| Methods | Return Type | Description |
| -- | -- | -- |
| StartAsync() | Task | Initializes camera preview control with a default Camera Helper instance and starts preview and frame capture. |
| StartAsync(CameraHelper cameraHelper) | Task | Initializes camera preview control with provided Camera Helper instance. |
| Stop() | void | Stops camera preview and disposes MediaPlayer. |

## Events

| Events | Description |
| -- | -- |
| PreviewFailed | Fires when camera preview fails. You can get the error reason from the PreviewFailedEventArgs.|

## Examples

Expand Down
9 changes: 0 additions & 9 deletions components/DeveloperTools/samples/DeveloperTools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,6 @@ You can control the grid's steps with `HorizontalStep` and `VerticalStep` proper

> [!Sample AlignmentGridSample]

### Properties

| Property | Type | Description |
| -- | -- | -- |
| HorizontalStep | double | Gets or sets the step to use horizontally |
| LineBrush | Brush | Gets or sets line Brush |
| VerticalStep | double | Gets or sets the step to use vertically |


## FocusTracker

The [FocusTracker Control](/dotnet/api/microsoft.toolkit.uwp.developertools.focustracker) can be used to display information about the current focused XAML element (if any).
Expand Down
22 changes: 0 additions & 22 deletions components/Helpers/samples/CameraHelper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,28 +59,6 @@ Likewise, make sure to handle app [suspending](/windows/uwp/launch-resume/suspen

Call `CameraHelper.CleanupAsync()` to clean up all internal resources. See the [CameraHelper sample page in the sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/CameraHelper) for full example.

## Properties

| Property | Type | Description |
| -- | -- | -- |
| FrameSourceGroup | MediaFrameSourceGroup | Gets the currently selected MediaFrameSourceGroup for video preview. User can set this property to preview video from a specific source. If no MediaFrameSourceGroup is provided, Camera Helper selects the first available camera source to use for media capture. |
| PreviewFrameSource | MediaFrameSource | Gets the currently selected MediaFrameSource for video preview. |

## Methods

| Methods | Return Type | Description |
| -- | -- | -- |
| GetFrameSourceGroupsAsync() | Task<IReadOnlyList\<MediaFrameSourceGroup>> | Gets a read only list of MediaFrameSourceGroups that support color video record or video preview streams. |
| InitializeAndStartCaptureAsync() | Task\<CameraHelperResult> | Initializes Media Capture and Frame Reader for video preview and capture frames in real time. |
| CleanUpAsync() | Task | Use this asynchronous method to dispose Camera Helper resources |
| Dispose() | void | Use this method to dispose Camera Helper resources |

## Events

| Events | Description |
| -- | -- |
| FrameArrived| Fires when a new frame arrives.|

## Examples

Demonstrates using Camera Helper to get video frames from a specific media frame source group.
Expand Down
35 changes: 0 additions & 35 deletions components/Helpers/samples/NetworkHelper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,38 +18,3 @@ It exposes network information though a property called ConnectionInformation. T
A metered connection is an Internet connection that has a data limit or cost associated with it. Cellular data connections are set as metered by default. Wi-Fi network connections can be set to metered, but aren't by default. Application developers should take metered nature of connection into account and reduce data usage.

> [!Sample NetworkHelperSample]


## NetworkHelper Properties

| Property | Type | Description |
| -- | -- | -- |
| ConnectionInformation | [ConnectionInformation](/dotnet/api/microsoft.toolkit.uwp.connectivity.connectioninformation) | Gets instance of ConnectionInformation |
| Instance | NetworkHelper | Gets public singleton property |


## ConnectionInformation Properties

| Property | Type | Description |
| -- | -- | -- |
| ConnectionCost | [ConnectionCost](/uwp/api/Windows.Networking.Connectivity.ConnectionCost) | Gets connection cost for the current Internet Connection Profile |
| ConnectionType | [ConnectionType](/dotnet/api/microsoft.toolkit.uwp.connectivity.connectiontype) | Gets connection type for the current Internet Connection Profile |
| ConnectivityLevel | [NetworkConnectivityLevel](/uwp/api/Windows.Networking.Connectivity.NetworkConnectivityLevel) | Gets connectivity level for the current Internet Connection Profile |
| IsInternetAvailable | bool | Gets a value indicating whether internet is available across all connections |
| IsInternetOnMeteredConnection | bool | Gets a value indicating whether if the current internet connection is metered |
| NetworkNames | IReadOnlyList\<string> | Gets signal strength for the current Internet Connection Profile |
| SignalStrength | Nullable\<Byte> | Gets signal strength for the current Internet Connection Profile |


## ConnectionInformation Methods

| Methods | Return Type | Description |
| -- | -- | -- |
| UpdateConnectionInformation(ConnectionProfile) | void | Updates the current object based on profile passed |


## NetworkHelper Events

| Events | Description |
| -- | -- |
| NetworkChanged | Event raised when the network changes |
15 changes: 0 additions & 15 deletions components/Helpers/samples/ThemeListener.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,3 @@ icon: Assets/ThemeListener.png
KNOWN ISSUE: `ThemeListener` might not work in WinUI3 applications.

> [!Sample ThemeListenerSample]

## Properties

| Property | Type | Description |
| -- | -- | -- |
| CurrentTheme | [ApplicationTheme](/uwp/api/Windows.UI.Xaml.ApplicationTheme) | Gets or sets the Current Theme. |
| CurrentThemeName | string | Gets the Name of the Current Theme. |
| IsHighContrast | bool | Gets or sets a value indicating whether the current theme is high contrast. |


## Events

| Events | Description |
| -- | -- |
| ThemeChanged | An event that fires if the Theme changes. |
15 changes: 0 additions & 15 deletions components/Helpers/samples/WeakEventListener.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,3 @@ var weakPropertyChangedListener = new WeakEventListener<DataGrid, object, Proper
}
inpc.PropertyChanged += weakPropertyChangedListener.OnEvent;
```


## Properties

| Property | Type | Description |
| -- | -- | -- |
| OnDetachAction | WeakEventListener<TInstance,TSource,TEventArgs>> | Gets or sets the method to call when detaching from the event |
| OnEventAction | Action<TInstance,TSource,TEventArgs> | Gets or sets the method to call when the event fires |

## Methods

| Methods | Return Type | Description |
| -- | -- | -- |
| Detach() | void | Detaches from the subscribed event |
| OnEvent(TSource, TEventArgs) | void | Handler for the subscribed event calls OnEventAction to handle it |
7 changes: 0 additions & 7 deletions components/LayoutTransformControl/samples/LayoutTransformControl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,3 @@ The transformations that can be applied are one of the following:
</Border>
</controls:LayoutTransformControl>
```

## Properties

| Property | Type | Description |
| -- | -- | -- |
| Child | FrameworkElement | The content of the control that will receive matrix transformations |
| Transform | Transform | The transformations to apply on the `Content`. It can be a single transformation like `RotateTransform`, `ScaleTransform` or `SkewTransform` or it can be a combo of multiple transformations using `TransformGroup` |
7 changes: 0 additions & 7 deletions components/MetadataControl/samples/MetadataControl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,3 @@ metadataControl.Items = new[]
## MetadataItem

A `MetadataItem` contains the information about one entry which will be displayed in the `MetadataControl`

| Property | Type | Description |
| -- | -- | -- |
| Label | String | Gets or sets the label of the item |
| AccessibleLabel | String | Gets or sets the automation name that will be set on the item. If not set, `Label` will be used. |
| Command | ICommand | Gets or sets the command associated to the item. If null, the item will be displayed as a text field. If set, the item will be displayed as an hyperlink. |
| CommandParameter | Object | Gets or sets the parameter that will be provided to the `Command`|
7 changes: 0 additions & 7 deletions components/Primitives/samples/DockPanel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,3 @@ You can set DockPanel LastChildFill property to true if you want the last item a
<StackPanel Width="100" controls:DockPanel.Dock="Right" Background="Blue"></StackPanel>
</controls:DockPanel>
```

## Properties

| Property | Type | Description |
| -- | -- | -- |
| LastChildFill | bool | Gets or sets a value indicating whether the last child element within a DockPanel stretches to fill the remaining available space |
| Padding | Thickness | The dimensions of the space between the edge and its child as a Thickness value. Thickness is a structure that stores dimension values using pixel measures. |
15 changes: 0 additions & 15 deletions components/Primitives/samples/UniformGrid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,18 +133,3 @@ In addition to `FlowDirection` to layout items from Right-to-Left. The UWP Unif

> [!NOTE]
> Changing the `FlowDirection` or `Orientation` properties effect how `FirstColumn` is interpreted. `FlowDirection` will effectively mirror the layout on the vertical axis. `Orientation` instead acts more like a transpose and will push items in the first column down.

## Properties

| Property | Type | Description |
| -- | -- | -- |
| Columns | int | Specifies a fixed number of columns to use for layout. Defaults to `0` which will automatically calculate a value based on the number of items. |
| FirstColumn | int | Specifies the first column from the top-left (during normal layout) to display the first item. Defaults to `0`.
| Orientation | Windows.UI.Xaml.Controls.Orientation | Determines if layout proceeds horizontally from left-to-right or vertically from top-to-bottom. The default is `Horizontal`. |
| Rows | int | Specifies a fixed number of rows to use for layout. Defaults to `0` which will automatically calculate a value based on the number of items. |

## Attached Properties

| Property | Type | Description |
| -- | -- | -- |
| AutoLayout | bool? | **DO NOT USE** - Internal property used to keep track of items that are fixed in position or need to automatically adjusted during layout. *Only set to `False` for the top-left edge case scenario described above for fixed child locations.* |
7 changes: 0 additions & 7 deletions components/Primitives/samples/WrapLayout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,6 @@ When the Orientation is Vertical, HorizontalSpacing adds uniform spacing between

> [!SAMPLE WrapLayoutSample]

## Properties

| Property | Type | Description |
| -- | -- | -- |
| Orientation | Orientation | Gets or sets the orientation of the WrapLayout, Horizontal or vertical means that child controls will be added horizontally until the width of the panel can't fit more control, then a new row is added to fit new horizontal added child controls, vertical means that child will be added vertically until the height of the panel is received then a new column is added |
| VerticalSpacing | double | Gets or sets the vertical distance between items |
| HorizontalSpacing | double | Gets or sets the horizontal distance between items |

## Examples

Expand Down
8 changes: 0 additions & 8 deletions components/Primitives/samples/WrapPanel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ When the Orientation is Vertical, HorizontalSpacing adds uniform spacing between

> [!SAMPLE WrapPanelSample]

## Properties

| Property | Type | Description |
| -- | -- | -- |
| HorizontalSpacing | double | Gets or sets the horizontal distance between items |
| Orientation | Orientation | Gets or sets the orientation of the WrapPanel, Horizontal or vertical means that child controls will be added horizontally until the width of the panel can't fit more control then a new row is added to fit new horizontal added child controls, vertical means that child will be added vertically until the height of the panel is received then a new column is added |
| Padding | Thickness | Gets or sets the distance between the border and its child object |
| VerticalSpacing | double | Gets or sets the vertical distance between items |

## Examples

Expand Down
37 changes: 0 additions & 37 deletions components/RadialGauge/samples/RadialGauge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,40 +18,3 @@ The round gauges are powerful, easy to use, and highly configurable to present d
The Radial Gauge supports animated transitions between configuration states. The control gradually animates as it redraws changes to the needle, needle position, scale range, color range, and more.

> [!Sample RadialGaugeSample]

## Properties

| Property | Type | Description |
| -- | -- | -- |
| Column | double | Gets or sets the column of the scale |
| IsInteractive | bool | Gets or sets a value indicating whether the control accepts setting its value through interaction |
| MaxAngle | int | Gets or sets the end angle of the scale, which corresponds with the Maximum value, in degrees |
| Maximum | double | Gets or sets the maximum value of the scale |
| MinAngle | int | Gets or sets the start angle of the scale, which corresponds with the Minimum value, in degrees |
| Minimum | double | Gets or sets the minimum value of the scale |
| NeedleBrush | SolidColorBrush | Gets or sets the needle background |
| NeedleBorderBrush | SolidColorBrush | Gets or sets the needle border |
| NeedleBorderThickness | double | Gets or sets the thickness of the border |
| NeedleLength | double | Gets or sets the needle length, in percentage of the gauge radius |
| NeedleWidth | double | Gets or sets the needle width, in percentage of the gauge radius |
| NormalizedMaxAngle | double | Gets the normalized maximum angle |
| NormalizedMinAngle | double | Gets the normalized minimum angle |
| ScaleBrush | Brush | Gets or sets the scale brush |
| ScalePadding | double | Gets or sets the distance of the scale from the outside of the control, in percentage of the gauge radius |
| ScaleTickCornerRadius | double | Gets or sets the cornerradius of the scale tick
| ScaleTickBrush | SolidColorBrush | Gets or sets the scale tick brush |
| ScaleTickLength | double | Gets or sets the length of the scaleticks, in percentage of the gauge radius |
| ScaleTickWidth | double | Gets or sets the width of the scale ticks, in percentage of the gauge radius |
| ScaleWidth | double | Gets or sets the width of the scale, in percentage of the gauge radius |
| StepSize | double | Gets or sets the rounding interval for the Value |
| TickBrush | SolidColorBrush | Gets or sets the outer tick brush |
| TickCornerRadius | double | Gets or sets the cornerradius of the tick |
| TickLength | double | Gets or sets the length of the ticks, in percentage of the gauge radius |
| TickPadding | double | Gets or sets the distance of the ticks from the outside of the control, in percentage of the gauge radius |
| TickSpacing | int | Gets or sets the tick spacing, in units |
| TickWidth | double | Gets or sets the width of the ticks, in percentage of the gauge radius |
| TrailBrush | Brush | Gets or sets the trail brush |
| Unit | string | Gets or sets the displayed unit measure |
| Value | double | Gets or sets the current value |
| ValueAngle | double | Gets or sets the current angle of the needle (between MinAngle and MaxAngle). Setting the angle will update the Value |
| ValueStringFormat | string | Gets or sets the value string format |
Loading