Skip to content

Commit 30fd414

Browse files
committed
Update docs
1 parent 1483f54 commit 30fd414

29 files changed

+132
-114
lines changed

.github/workflows/docs.yaml

-28
This file was deleted.

.github/workflows/wpf-ui-docs.yaml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: wpfui-docs
2+
3+
on:
4+
push:
5+
branches: [development]
6+
7+
workflow_dispatch:
8+
9+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
16+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
# Single deploy job since we're just deploying
23+
deploy:
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v3
31+
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v3
34+
35+
- uses: nikeee/docfx-action@v1.0.0
36+
name: Build Documentation
37+
with:
38+
args: docs/docfx.json
39+
40+
- name: Upload artifact
41+
uses: actions/upload-pages-artifact@v1
42+
with:
43+
# Upload entire repository
44+
path: docs/_site/
45+
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v2

.vsconfig

+23-27
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,25 @@
11
{
2-
"version": "1.0",
3-
"components": [
4-
"Microsoft.VisualStudio.Component.NuGet",
5-
"Microsoft.VisualStudio.Component.Roslyn.Compiler",
6-
"Microsoft.Component.MSBuild",
7-
"Microsoft.NetCore.Component.Runtime.6.0",
8-
"Microsoft.NetCore.Component.SDK",
9-
"Microsoft.Net.Component.4.7.2.TargetingPack",
10-
"Microsoft.VisualStudio.Component.Roslyn.LanguageServices",
11-
"Microsoft.ComponentGroup.ClickOnce.Publish",
12-
"Microsoft.NetCore.Component.DevelopmentTools",
13-
"Microsoft.Net.Component.4.8.SDK",
14-
"Microsoft.Net.ComponentGroup.DevelopmentPrerequisites",
15-
"Microsoft.Component.ClickOnce",
16-
"Microsoft.VisualStudio.Component.ManagedDesktop.Core",
17-
"Microsoft.Net.Component.4.8.TargetingPack",
18-
"Microsoft.Net.Component.4.7.TargetingPack",
19-
"Microsoft.VisualStudio.Component.ManagedDesktop.Prerequisites",
20-
"Microsoft.VisualStudio.Component.PortableLibrary",
21-
"Microsoft.VisualStudio.Workload.ManagedDesktop",
22-
"Microsoft.Net.ComponentGroup.TargetingPacks.Common",
23-
"Microsoft.Component.CodeAnalysis.SDK",
24-
"Microsoft.Net.Component.4.6.TargetingPack",
25-
"Microsoft.NetCore.Component.Runtime.3.1",
26-
"Microsoft.NetCore.Component.Runtime.5.0",
27-
"Microsoft.Net.Component.4.6.1.TargetingPack"
28-
]
2+
"version": "1.0",
3+
"components": [
4+
"Microsoft.Component.ClickOnce",
5+
"Microsoft.Component.CodeAnalysis.SDK",
6+
"Microsoft.Component.MSBuild",
7+
"Microsoft.ComponentGroup.ClickOnce.Publish",
8+
"Microsoft.Net.Component.4.6.2.TargetingPack",
9+
"Microsoft.Net.Component.4.7.2.TargetingPack",
10+
"Microsoft.Net.Component.4.8.1.TargetingPack",
11+
"Microsoft.Net.ComponentGroup.DevelopmentPrerequisites",
12+
"Microsoft.Net.ComponentGroup.TargetingPacks.Common",
13+
"Microsoft.NetCore.Component.DevelopmentTools",
14+
"Microsoft.NetCore.Component.Runtime.6.0",
15+
"Microsoft.NetCore.Component.Runtime.7.0",
16+
"Microsoft.NetCore.Component.SDK",
17+
"Microsoft.VisualStudio.Component.ManagedDesktop.Core",
18+
"Microsoft.VisualStudio.Component.ManagedDesktop.Prerequisites",
19+
"Microsoft.VisualStudio.Component.NuGet",
20+
"Microsoft.VisualStudio.Component.PortableLibrary",
21+
"Microsoft.VisualStudio.Component.Roslyn.Compiler",
22+
"Microsoft.VisualStudio.Component.Roslyn.LanguageServices",
23+
"Microsoft.VisualStudio.Workload.ManagedDesktop"
24+
]
2925
}

Directory.Build.props

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@
77
</PropertyGroup>
88

99
<PropertyGroup>
10+
<NuGetAudit>true</NuGetAudit>
11+
<NuGetAuditLevel>moderate</NuGetAuditLevel>
1012
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
1113
<CentralPackageTransitivePinningEnabled>false</CentralPackageTransitivePinningEnabled>
1214
</PropertyGroup>
1315

1416
<PropertyGroup>
1517
<Authors>lepo.co</Authors>
1618
<Company>lepo.co</Company>
17-
<Copyright>Copyright (C) 2021-2022 Leszek Pomianowski and WPF UI Contributors</Copyright>
19+
<Copyright>Copyright (C) 2021-2023 Leszek Pomianowski and WPF UI Contributors</Copyright>
1820
</PropertyGroup>
1921

2022
<PropertyGroup>

src/Wpf.Ui/Controls/Anchor.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ namespace Wpf.Ui.Controls;
1313
/// <summary>
1414
/// Creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.
1515
/// </summary>
16-
[ToolboxItem(true)]
17-
[ToolboxBitmap(typeof(Anchor), "Anchor.bmp")]
16+
//[ToolboxItem(true)]
17+
//[ToolboxBitmap(typeof(Anchor), "Anchor.bmp")]
1818
public class Anchor : Wpf.Ui.Controls.Hyperlink
1919
{
20-
20+
2121
}

src/Wpf.Ui/Controls/Arc.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ namespace Wpf.Ui.Controls;
1616
/// <summary>
1717
/// Control that draws a symmetrical arc with rounded edges.
1818
/// </summary>
19-
[ToolboxItem(true)]
20-
[ToolboxBitmap(typeof(Arc), "Arc.bmp")]
19+
//[ToolboxItem(true)]
20+
//[ToolboxBitmap(typeof(Arc), "Arc.bmp")]
2121
public class Arc : System.Windows.Shapes.Shape
2222
{
2323
/// <summary>

src/Wpf.Ui/Controls/AutoSuggestBoxControl/AutoSuggestBox.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020

2121
namespace Wpf.Ui.Controls.AutoSuggestBoxControl;
2222

23-
[ToolboxItem(true)]
24-
[ToolboxBitmap(typeof(AutoSuggestBox), "AutoSuggestBox.bmp")]
23+
//[ToolboxItem(true)]
24+
//[ToolboxBitmap(typeof(AutoSuggestBox), "AutoSuggestBox.bmp")]
2525
[TemplatePart(Name = ElementTextBox, Type = typeof(TextBox))]
2626
[TemplatePart(Name = ElementSuggestionsPopup, Type = typeof(Popup))]
2727
[TemplatePart(Name = ElementSuggestionsList, Type = typeof(ListView))]
@@ -220,7 +220,7 @@ public event TypedEventHandler<AutoSuggestBox, AutoSuggestBoxTextChangedEventArg
220220

221221
private bool _changingTextAfterSuggestionChosen;
222222
private bool _isChangedTextOutSideOfTextBox;
223-
223+
224224
private object? _selectedItem;
225225

226226
public AutoSuggestBox()
@@ -311,7 +311,7 @@ protected virtual void OnSuggestionChosen(object selectedItem)
311311
{
312312
SelectedItem = selectedItem
313313
};
314-
314+
315315
RaiseEvent(args);
316316

317317
if (UpdateTextOnSelect && !args.Handled)
@@ -476,7 +476,7 @@ private void DefaultFiltering(string text)
476476
var item = OriginalItemsSource[i];
477477
var itemText = GetStringFromObj(item);
478478

479-
var found = splitText.All(key=> itemText.ToLower().Contains(key));
479+
var found = splitText.All(key => itemText.ToLower().Contains(key));
480480

481481
if (found)
482482
suitableItems.Add(item);

src/Wpf.Ui/Controls/Badge.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ namespace Wpf.Ui.Controls;
1414
/// <summary>
1515
/// Used to highlight an item, attract attention or flag status.
1616
/// </summary>
17-
[ToolboxItem(true)]
18-
[ToolboxBitmap(typeof(Badge), "Badge.bmp")]
17+
//[ToolboxItem(true)]
18+
//[ToolboxBitmap(typeof(Badge), "Badge.bmp")]
1919
public class Badge : System.Windows.Controls.ContentControl, IAppearanceControl
2020
{
2121
/// <summary>

src/Wpf.Ui/Controls/Card.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ namespace Wpf.Ui.Controls;
1212
/// <summary>
1313
/// Simple Card with content and <see cref="Footer"/>.
1414
/// </summary>
15-
[ToolboxItem(true)]
16-
[ToolboxBitmap(typeof(Card), "Card.bmp")]
15+
//[ToolboxItem(true)]
16+
//[ToolboxBitmap(typeof(Card), "Card.bmp")]
1717
public class Card : System.Windows.Controls.ContentControl
1818
{
1919
/// <summary>

src/Wpf.Ui/Controls/CardAction.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ namespace Wpf.Ui.Controls;
1515
/// Inherited from the <see cref="System.Windows.Controls.Primitives.ButtonBase"/> interactive card styled according to Fluent Design.
1616
/// </summary>
1717
//#if NETFRAMEWORK
18-
// [ToolboxBitmap(typeof(Button))]
18+
// //[ToolboxBitmap(typeof(Button))]
1919
//#endif
20-
[ToolboxItem(true)]
21-
[ToolboxBitmap(typeof(CardAction), "CardAction.bmp")]
20+
//[ToolboxItem(true)]
21+
//[ToolboxBitmap(typeof(CardAction), "CardAction.bmp")]
2222
public class CardAction : System.Windows.Controls.Primitives.ButtonBase
2323
{
2424
/// <summary>

src/Wpf.Ui/Controls/CardExpander.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ namespace Wpf.Ui.Controls;
1414
/// <summary>
1515
/// Inherited from the <see cref="System.Windows.Controls.Expander"/> control which can hide the collapsible content.
1616
/// </summary>
17-
[ToolboxItem(true)]
18-
[ToolboxBitmap(typeof(CardExpander), "CardExpander.bmp")]
17+
//[ToolboxItem(true)]
18+
//[ToolboxBitmap(typeof(CardExpander), "CardExpander.bmp")]
1919
public class CardExpander : System.Windows.Controls.Expander
2020
{
2121
/// <summary>

src/Wpf.Ui/Controls/CodeBlock.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ namespace Wpf.Ui.Controls;
2222
/// <summary>
2323
/// Formats and display a fragment of the source code.
2424
/// </summary>
25-
[ToolboxItem(true)]
26-
[ToolboxBitmap(typeof(CodeBlock), "CodeBlock.bmp")]
25+
//[ToolboxItem(true)]
26+
//[ToolboxBitmap(typeof(CodeBlock), "CodeBlock.bmp")]
2727
public class CodeBlock : System.Windows.Controls.ContentControl
2828
{
2929
private string _sourceCode = String.Empty;

src/Wpf.Ui/Controls/DynamicScrollBar.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ namespace Wpf.Ui.Controls;
1515
/// <summary>
1616
/// Custom <see cref="System.Windows.Controls.Primitives.ScrollBar"/> with events depending on actions taken by the user.
1717
/// </summary>
18-
[ToolboxItem(true)]
19-
[ToolboxBitmap(typeof(DynamicScrollBar), "DynamicScrollBar.bmp")]
18+
//[ToolboxItem(true)]
19+
//[ToolboxBitmap(typeof(DynamicScrollBar), "DynamicScrollBar.bmp")]
2020
public class DynamicScrollBar : System.Windows.Controls.Primitives.ScrollBar
2121
{
2222
private bool _isScrolling = false;

src/Wpf.Ui/Controls/DynamicScrollViewer.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ namespace Wpf.Ui.Controls;
1515
/// <summary>
1616
/// Custom <see cref="System.Windows.Controls.ScrollViewer"/> with events depending on actions taken by the user.
1717
/// </summary>
18-
[ToolboxItem(true)]
19-
[ToolboxBitmap(typeof(DynamicScrollViewer), "DynamicScrollViewer.bmp")]
18+
//[ToolboxItem(true)]
19+
//[ToolboxBitmap(typeof(DynamicScrollViewer), "DynamicScrollViewer.bmp")]
2020
[DefaultEvent("ScrollChangedEvent")]
2121
public class DynamicScrollViewer : System.Windows.Controls.ScrollViewer
2222
{

src/Wpf.Ui/Controls/IconElements/FontIcon.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ namespace Wpf.Ui.Controls.IconElements;
1717
/// <summary>
1818
/// Represents an icon that uses a glyph from the specified font.
1919
/// </summary>
20-
[ToolboxItem(true)]
21-
[ToolboxBitmap(typeof(FontIcon), "FontIcon.bmp")]
20+
//[ToolboxItem(true)]
21+
//[ToolboxBitmap(typeof(FontIcon), "FontIcon.bmp")]
2222
public class FontIcon : IconElement
2323
{
2424
#region Static properties
@@ -131,7 +131,7 @@ protected override UIElement InitializeChildren()
131131
{
132132
if (FontSize.Equals(SystemFonts.MessageFontSize))
133133
{
134-
SetResourceReference(FontSizeProperty, "DefaultIconFontSize");
134+
SetResourceReference(FontSizeProperty, "DefaultIconFontSize");
135135
}
136136

137137
TextBlock = new TextBlock

src/Wpf.Ui/Controls/IconElements/SymbolIcon.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ namespace Wpf.Ui.Controls.IconElements;
1515
/// <summary>
1616
/// Represents a text element containing an icon glyph.
1717
/// </summary>
18-
[ToolboxItem(true)]
19-
[ToolboxBitmap(typeof(SymbolIcon), "SymbolIcon.bmp")]
18+
//[ToolboxItem(true)]
19+
//[ToolboxBitmap(typeof(SymbolIcon), "SymbolIcon.bmp")]
2020
public class SymbolIcon : FontIcon
2121
{
2222
/// <summary>
@@ -50,9 +50,9 @@ public bool Filled
5050
set => SetValue(FilledProperty, value);
5151
}
5252

53-
public SymbolIcon() {}
53+
public SymbolIcon() { }
5454

55-
public SymbolIcon(SymbolRegular symbol, bool filled = false)
55+
public SymbolIcon(SymbolRegular symbol, bool filled = false)
5656
{
5757
Symbol = symbol;
5858
Filled = filled;

src/Wpf.Ui/Controls/MessageBoxControl/MessageBox.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ namespace Wpf.Ui.Controls.MessageBoxControl;
2020
/// <summary>
2121
/// Customized window for notifications.
2222
/// </summary>
23-
[ToolboxItem(true)]
24-
[ToolboxBitmap(typeof(MessageBox), "MessageBox.bmp")]
23+
//[ToolboxItem(true)]
24+
//[ToolboxBitmap(typeof(MessageBox), "MessageBox.bmp")]
2525
public class MessageBox : System.Windows.Window
2626
{
2727
#region Static properties

src/Wpf.Ui/Controls/Navigation/NavigationView.Base.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ namespace Wpf.Ui.Controls.Navigation;
2626
/// <summary>
2727
/// 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.
2828
/// </summary>
29-
[ToolboxItem(true)]
30-
[System.Drawing.ToolboxBitmap(typeof(NavigationView), "NavigationView.bmp")]
29+
//[ToolboxItem(true)]
30+
//[System.Drawing.ToolboxBitmap(typeof(NavigationView), "NavigationView.bmp")]
3131
public partial class NavigationView : System.Windows.Controls.Control, INavigationView
3232
{
3333
/// <summary>
@@ -391,7 +391,7 @@ protected virtual void CloseNavigationViewItemMenus()
391391
currentItem.Activate(this);
392392
return;
393393
}
394-
394+
395395
currentItem.Deactivate(this);
396396
currentItem.NavigationViewItemParent?.Activate(this);
397397
}

src/Wpf.Ui/Controls/Navigation/NavigationViewItemSeparator.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ namespace Wpf.Ui.Controls.Navigation;
1515
/// <summary>
1616
/// Represents a line that separates menu items in a NavigationMenu.
1717
/// </summary>
18-
[ToolboxItem(true)]
19-
[System.Drawing.ToolboxBitmap(typeof(NavigationViewItemSeparator), "NavigationViewItemSeparator.bmp")]
18+
//[ToolboxItem(true)]
19+
//[System.Drawing.ToolboxBitmap(typeof(NavigationViewItemSeparator), "NavigationViewItemSeparator.bmp")]
2020
public class NavigationViewItemSeparator : System.Windows.Controls.Separator
2121
{
2222
}

src/Wpf.Ui/Controls/NotifyIcon.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ namespace Wpf.Ui.Controls;
1919
/// <summary>
2020
/// Represents the implementation of icon in the tray menu as <see cref="FrameworkElement"/>.
2121
/// </summary>
22-
[ToolboxItem(true)]
23-
[ToolboxBitmap(typeof(NotifyIcon), "NotifyIcon.bmp")]
22+
//[ToolboxItem(true)]
23+
//[ToolboxBitmap(typeof(NotifyIcon), "NotifyIcon.bmp")]
2424
public class NotifyIcon : System.Windows.FrameworkElement
2525
{
2626
private readonly NotifyIconService _notifyIconService;

src/Wpf.Ui/Controls/NumberBoxControl/NumberBox.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ namespace Wpf.Ui.Controls.NumberBoxControl;
2020
/// <summary>
2121
/// Represents a control that can be used to display and edit numbers.
2222
/// </summary>
23-
[ToolboxItem(true)]
24-
[ToolboxBitmap(typeof(NumberBox), "NumberBox.bmp")]
23+
//[ToolboxItem(true)]
24+
//[ToolboxBitmap(typeof(NumberBox), "NumberBox.bmp")]
2525
public class NumberBox : Wpf.Ui.Controls.TextBox
2626
{
2727
private bool _valueUpdating = false;

0 commit comments

Comments
 (0)