Skip to content

Commit

Permalink
Updates for v24.2.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
billhenn committed Aug 28, 2024
1 parent a8e5766 commit c49f971
Show file tree
Hide file tree
Showing 24 changed files with 67 additions and 67 deletions.
8 changes: 4 additions & 4 deletions Documentation/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@
],
"dest": "wwwroot",
"globalMetadata": {
"_appTitle": "Actipro Avalonia UI Docs",
"_appTitle": "Actipro Avalonia Docs",
"_docsCompanyHref": "https://www.actiprosoftware.com/products/controls/avalonia",
"_docsCompanyName": "Actipro Software LLC",
"_docsCopyrightYears": "2021-2024",
"_docsProductHref": "https://www.actiprosoftware.com/products/controls/avalonia",
"_docsProductName": "Avalonia UI",
"_docsProductName": "Avalonia",
"_docsProductVersion": "24.2",
"_disableContribution": true,
"_enableNewTab": true,
Expand All @@ -70,8 +70,8 @@
"_conditionalFlags": "avalonia",
"_replaceTokens": {
"PlatformAssemblySuffix": "Avalonia",
"PlatformName": "Avalonia UI",
"PlatformTitle": "Avalonia UI"
"PlatformName": "Avalonia",
"PlatformTitle": "Avalonia"
},
"_rootNamespaceAliases": {
"ActiproUIRoot": "ActiproSoftware.UI.Avalonia",
Expand Down
4 changes: 2 additions & 2 deletions Documentation/topics/conversion/converting-to-v24-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ order: 99
---
# Converting to v24.1

## Avalonia UI Dependency
## Avalonia Dependency

Updated the minimum Avalonia UI dependency from v11.0.5 to v11.0.7.
Updated the minimum Avalonia dependency from v11.0.5 to v11.0.7.

## RingSlice

Expand Down
4 changes: 2 additions & 2 deletions Documentation/topics/conversion/converting-to-v24-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ order: 98
---
# Converting to v24.2

## Avalonia UI Dependency
## Avalonia Dependency

Updated the minimum Avalonia UI dependency from v11.0.7 to v11.1.0.
Updated the minimum Avalonia dependency from v11.0.7 to v11.1.0.

## MenuItem Toggle Support

Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/customizing-string-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A string resource is a text string that generally can be displayed in the user i

For instance, when hovering the mouse over the **Show Password** button of a password textbox, a tooltip whose default text is `"Show Password"` is displayed. The string `"Show Password"` is defined as a string resource in the Shared assembly.

All Actipro Avalonia UI controls that have displayable strings will have string resources defined for those items. You can view all the string resources in our products with the [String Resource Browser](utilities/string-resource-browser.md).
All Actipro Avalonia controls that have displayable strings will have string resources defined for those items. You can view all the string resources in our products with the [String Resource Browser](utilities/string-resource-browser.md).

## Localization

Expand Down
8 changes: 4 additions & 4 deletions Documentation/topics/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ This table describes where referenced assemblies appear after project compilatio

## Redistributable Files

When you use our Actipro Avalonia UI Free products or own a license for Actipro Avalonia UI Pro, you are licensed to redistribute certain files with your application.
When you use our Actipro Avalonia Free products or own a license for Actipro Avalonia Pro, you are licensed to redistribute certain files with your application.

The lists below show the product assemblies that may be redistributed based on the product(s) for which you own licenses, along with the NuGet packages that contain them.

### Actipro Avalonia UI Free
### Actipro Avalonia Free

The following assemblies may be redistributed for free:
- *ActiproSoftware.Avalonia.Core.dll* - via `ActiproSoftware.Controls.Avalonia` NuGet package.
Expand All @@ -40,9 +40,9 @@ Optional free additional native control theme libraries:
- *ActiproSoftware.Avalonia.Themes.Native.ColorPicker.dll* - via `ActiproSoftware.Controls.Avalonia.Themes.ColorPicker` NuGet package.
- *ActiproSoftware.Avalonia.Themes.Native.DataGrid.dll* - via `ActiproSoftware.Controls.Avalonia.Themes.DataGrid` NuGet package.

### Actipro Avalonia UI Pro
### Actipro Avalonia Pro

The following assemblies may be redistributed when you own a license for Actipro Avalonia UI Pro:
The following assemblies may be redistributed when you own a license for Actipro Avalonia Pro:
- *ActiproSoftware.Avalonia.Core.dll* - via `ActiproSoftware.Controls.Avalonia` NuGet package.
- *ActiproSoftware.Avalonia.Shared.dll* - via `ActiproSoftware.Controls.Avalonia` NuGet package.
- *ActiproSoftware.Avalonia.Fundamentals.dll* - via `ActiproSoftware.Controls.Avalonia.Pro` NuGet package.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ When using the [builder pattern](builder-pattern.md), the [WithTitle](xref:@Acti
```csharp
await UserPromptBuilder.Configure()
// ... other configuration options here
.WithTitle("Actipro Avalonia UI Controls")
.WithTitle("Actipro Avalonia Controls")
.Show();
```
}
Expand Down
4 changes: 2 additions & 2 deletions Documentation/topics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Several products are **freely available** for anyone to use in their application

![Screenshot](themes/images/welcome.png)

[Actipro Themes](themes/index.md) ensures that a great consistent visual appearance is applied to all controls within your application, regardless of whether they are Actipro Avalonia UI control products or native Avalonia UI controls.
[Actipro Themes](themes/index.md) ensures that a great consistent visual appearance is applied to all controls within your application, regardless of whether they are Actipro Avalonia control products or native Avalonia controls.

### Shared Library

![Screenshot](shared/images/welcome.png)

The [Actipro Shared Library](shared/index.md) is a common control library referenced by all our Actipro Avalonia UI controls. It contains several very useful controls, components, value converters, and utilities that can be used in your projects.
The [Actipro Shared Library](shared/index.md) is a common control library referenced by all our Actipro Avalonia controls. It contains several very useful controls, components, value converters, and utilities that can be used in your projects.

### Core Library

Expand Down
8 changes: 4 additions & 4 deletions Documentation/topics/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ The [Actipro Themes](themes/index.md), [Actipro Shared Library](shared/index.md)
For simplicity, no license registration calls need to be made in applications that only use free Actipro products.

> [!TIP]
> Even customers who only use the free products can still pay for Actipro Avalonia UI Pro to gain access to the XAML source of all control styles/templates in those products and priority support.
> Even customers who only use the free products can still pay for Actipro Avalonia Pro to gain access to the XAML source of all control styles/templates in those products and priority support.
## Paid License Types

Actipro Avalonia UI Pro is available for purchase with several license types.
Actipro Avalonia Pro is available for purchase with several license types.

### Evaluation License

Expand Down Expand Up @@ -52,7 +52,7 @@ Blueprint licenses enable access to product source code. The term of Blueprint
## Free Subscriptions and Free New Products

All of the non-evaluation licenses described above for our paid Avalonia UI products include **one full year** of free upgrades to any new versions that are released within that timeframe.
All of the non-evaluation licenses described above for our paid Avalonia products include **one full year** of free upgrades to any new versions that are released within that timeframe.

In addition, customers with active subscriptions will receive any new products added to the suite for free while the subscription is active.

Expand Down Expand Up @@ -95,7 +95,7 @@ public static AppBuilder BuildAvaloniaApp() {
## Open-Source Project Licensing Considerations

Product licenses may be purchased for developers working with Actipro Avalonia UI Pro in open-source projects. However, this introduces some issues that must be handled with care. Namely, ensuring that "Licensee" and "License Key" values are not committed in any way to an open-source code repository, and that the proper number of developer licenses are purchased.
Product licenses may be purchased for developers working with Actipro Avalonia Pro in open-source projects. However, this introduces some issues that must be handled with care. Namely, ensuring that "Licensee" and "License Key" values are not committed in any way to an open-source code repository, and that the proper number of developer licenses are purchased.

### Developers of Open-Source Projects

Expand Down
8 changes: 4 additions & 4 deletions Documentation/topics/nuget.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,25 @@ The following are Actipro's NuGet packages for @@PlatformName and each one's pac

### ActiproSoftware.Controls.Avalonia Package

This package references most of the Actipro Avalonia UI Free product assemblies ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia)), which can be used at no cost.
This package references most of the Actipro Avalonia Free product assemblies ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia)), which can be used at no cost.

The free themes for the native `ColorPicker` and `DataGrid` controls require separate optional packages listed below.

### ActiproSoftware.Controls.Avalonia.Pro Package

This package references all of the Actipro Avalonia UI Pro product assemblies ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia.Pro)), and is for customers who have licensed the Actipro Avalonia UI Pro controls. Dependencies include:
This package references all of the Actipro Avalonia Pro product assemblies ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia.Pro)), and is for customers who have licensed the Actipro Avalonia Pro controls. Dependencies include:

- `ActiproSoftware.Controls.Avalonia`

### ActiproSoftware.Controls.Avalonia.Themes.ColorPicker Package

This package includes free themes for the native Avalonia `ColorPicker` control that complement other Actipro Avalonia UI control themes ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia.Themes.ColorPicker)). Dependencies include:
This package includes free themes for the native Avalonia `ColorPicker` control that complement other Actipro Avalonia control themes ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia.Themes.ColorPicker)). Dependencies include:

- `ActiproSoftware.Controls.Avalonia`

### ActiproSoftware.Controls.Avalonia.Themes.DataGrid Package

This package includes free themes for the native Avalonia `DataGrid` control that complement other Actipro Avalonia UI control themes ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia.Themes.DataGrid)). Dependencies include:
This package includes free themes for the native Avalonia `DataGrid` control that complement other Actipro Avalonia control themes ([view on nuget.org](https://www.nuget.org/packages/ActiproSoftware.Controls.Avalonia.Themes.DataGrid)). Dependencies include:

- `ActiproSoftware.Controls.Avalonia`

Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 51
---
# GitHub Open-Source

Actipro hosts an open-source Actipro Avalonia UI controls repository on GitHub:
Actipro hosts an open-source Actipro Avalonia controls repository on GitHub:

[https://github.com/Actipro/Avalonia-Controls](https://github.com/Actipro/Avalonia-Controls)

Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 34
---
# Samples

The **Sample Browser** is the main sample project for evaluating Actipro Avalonia UI controls, and the [full source is available on GitHub](open-source.md). It is designed to provide information, comprehensive demos, and detailed samples for all the Actipro @@PlatformName products.
The **Sample Browser** is the main sample project for evaluating Actipro Avalonia controls, and the [full source is available on GitHub](open-source.md). It is designed to provide information, comprehensive demos, and detailed samples for all the Actipro @@PlatformName products.

We pride ourselves in providing more full-source samples than our competition, allowing you to learn about our products more easily and avoid
having to rewrite common logic and design patterns.
Expand Down
20 changes: 10 additions & 10 deletions Documentation/topics/supported-technologies.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ The products have assemblies available for multiple runtime frameworks, includin

- .NET 6 or later

### Avalonia UI Support Matrix
### Avalonia Support Matrix

The assemblies have dependencies on the Avalonia UI framework as follows:
The assemblies have dependencies on the Avalonia framework as follows:

<table>
<thead>

<tr>
<th>Actipro Controls Versions</th>
<th>Avalonia UI Support</th>
<th>Avalonia Support</th>
</tr>

</thead>
Expand All @@ -32,9 +32,9 @@ The assemblies have dependencies on the Avalonia UI framework as follows:
<td>Actipro Controls v24.2</td>
<td>

- Avalonia UI v11.1.0 or later
- Native themes compatible up to Avalonia UI v11.1.0
- *Minor updates to Avalonia UI are expected to be supported and will be verified as they are released*
- Avalonia v11.1.0 or later
- Native themes compatible up to Avalonia v11.1.0
- *Minor updates to Avalonia are expected to be supported and will be verified as they are released*

</td>
</tr>
Expand All @@ -43,8 +43,8 @@ The assemblies have dependencies on the Avalonia UI framework as follows:
<td>Actipro Controls v24.1</td>
<td>

- Avalonia UI v11.0.7 or later
- Native themes compatible up to Avalonia UI v11.0.11
- Avalonia v11.0.7 or later
- Native themes compatible up to Avalonia v11.0.11

</td>
</tr>
Expand All @@ -53,8 +53,8 @@ The assemblies have dependencies on the Avalonia UI framework as follows:
<td>Actipro Controls v23.1</td>
<td>

- Avalonia UI v11.0.5 or later
- Native themes compatible up to Avalonia UI v11.0.7
- Avalonia v11.0.5 or later
- Native themes compatible up to Avalonia v11.0.7

</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/themes/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The following example shows how to load the free Actipro themes for most native
```

> [!NOTE]
> See the "Includes Setting" section below for details on how to include themes for Actipro Avalonia UI Pro and optional native Avalonia controls.
> See the "Includes Setting" section below for details on how to include themes for Actipro Avalonia Pro and optional native Avalonia controls.
> [!IMPORTANT]
> The order of entries in the `Application.Styles` is important. For instance, if the Avalonia Fluent theme is also loaded in `Application.Styles` after the [ModernTheme](xref:@ActiproUIRoot.Themes.ModernTheme) entry, its control themes will take precedence over Actipro's theme.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/third-party.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 55
---
# Third-Party Software

Actipro Avalonia UI controls are built specifically for the Avalonia UI framework and, as such, have a dependency on the following open source libraries:
Actipro Avalonia controls are built specifically for the Avalonia framework and, as such, have a dependency on the following open source libraries:

- [Avalonia](https://github.com/AvaloniaUI/Avalonia) - Provides the cross-platform UI framework.
- [.NET](https://github.com/microsoft/dotnet) - Provides the cross-platform runtime framework.
Expand Down
8 changes: 4 additions & 4 deletions Documentation/topics/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ order: 45
---
# Troubleshooting

This topic provides several tips on common questions or issues that you may encounter while using Actipro Avalonia UI controls.
This topic provides several tips on common questions or issues that you may encounter while using Actipro Avalonia controls.

## Actipro Controls are Blank, Transparent or Missing Content

If a control does not appear the way it should (especially if it is blank), this can be caused by missing themes. Actipro Avalonia UI controls require the [ModernTheme](xref:@ActiproUIRoot.Themes.ModernTheme) to be loaded for control templates and resources to be available for the controls.
If a control does not appear the way it should (especially if it is blank), this can be caused by missing themes. Actipro Avalonia controls require the [ModernTheme](xref:@ActiproUIRoot.Themes.ModernTheme) to be loaded for control templates and resources to be available for the controls.

If [ModernTheme](xref:@ActiproUIRoot.Themes.ModernTheme) is loaded but controls from the `ActiproSoftware.Controls.Avalonia.Pro` NuGet package are still not rendering properly (like the [Fundamentals](fundamentals/index.md) product controls), make sure [ModernTheme](xref:@ActiproUIRoot.Themes.ModernTheme).[Includes](xref:@ActiproUIRoot.Themes.ModernTheme.Includes) property includes the [Pro](xref:@ActiproUIRoot.Themes.ThemeStyleIncludes.Pro) controls.

Expand All @@ -36,7 +36,7 @@ As indicated by a note in the [Customizing String Resources](customizing-string-

## Data Binding Errors at Run-Time

Sometimes there may be some data binding errors that show up in the Visual Studio console window when executing an application that uses an Actipro Avalonia UI control product. Actipro Avalonia UI has some very large and complex templates for its products' controls and these error messages may show up in the Visual Studio console due to the timing between data binding resolution and visual tree creation.
Sometimes there may be some data binding errors that show up in the Visual Studio console window when executing an application that uses an Actipro Avalonia control product. Actipro Avalonia controls have some very large and complex templates and these error messages may show up in the Visual Studio console due to the timing between data binding resolution and visual tree creation.

It is very important to note that the data binding errors are NOT problems in our code. If they were, the bindings would not work at all at run-time and you would see broken UI functionality. This is not the case, everything works correctly at run-time after the visual tree has been fully constructed and the bindings have been re-evaluated. The Avalonia team plans on refactoring the data binding system in the future to prevent these misleading error messages from being logged.

Expand Down Expand Up @@ -84,7 +84,7 @@ The [ModernTheme](xref:@ActiproUIRoot.Themes.ModernTheme).[Includes](xref:@Actip

## WebAssembly (WASM) Performance Issues

Avalonia UI supports running in the browser with WebAssembly. As of v11.0, the Avalonia UI framework documention is clear to indicate the functionality is not ready for production. During testing with Actipro Avalonia UI controls in a browser, you may notice less-than-desired performance compared to running natively. This is expected to improve with .NET 8.
Avalonia supports running in the browser with WebAssembly. As of v11.0, the Avalonia framework documention is clear to indicate the functionality is not ready for production. During testing with Actipro Avalonia controls in a browser, you may notice less-than-desired performance compared to running natively. This is expected to improve with .NET 8.

## Badge Adornments Aren't Clipped Properly

Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/utilities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ See the [Theme Resource Browser](theme-resource-browser.md) topic for informatio

## String Resource Browser

The **String Resource Browser** allows you to view all the string resources that are defined for the various Actipro Avalonia UI control products. It can also generate code to customize or localize any of the string resources in our products.
The **String Resource Browser** allows you to view all the string resources that are defined for the various Actipro Avalonia control products. It can also generate code to customize or localize any of the string resources in our products.

See the [String Resource Browser](string-resource-browser.md) topic for information on this utility.
2 changes: 1 addition & 1 deletion Documentation/topics/utilities/string-resource-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 4
---
# String Resource Browser

The **String Resource Browser** allows you to view all the string resources that are defined for the various Actipro Avalonia UI control products. It can also generate code to customize or localize any of the string resources in our products.
The **String Resource Browser** allows you to view all the string resources that are defined for the various Actipro Avalonia control products. It can also generate code to customize or localize any of the string resources in our products.

It is available from the **View** menu within the **Sample Browser**'s title bar.

Expand Down
Loading

0 comments on commit c49f971

Please sign in to comment.