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.

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

Licensing: Add licensing documentation. Initial commit. Will need rew… #3009

Merged
merged 13 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1009,7 +1009,10 @@ navigation:
title: "Installation"
position: 8
"getting-started/installation/nuget":
title: "NuGet Installation"
title: "NuGet Installation"
"getting-started/licensing":
title: "Activating Your License"
position: 7
"getting-started/adding-telerik-ui-to-an-application":
title: "Adding Telerik UI to an Application"
position: 9
Expand Down Expand Up @@ -1042,7 +1045,7 @@ navigation:
title: "Style and Appearance"
position: 4
"licensing":
title: "Distribution and Licensing"
title: "Redistribution"
position: 5
"upgrade":
title: "Upgrade"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ site_name: WPF

The following topic describes all controls from UI for WPF and the assemblies they require when deploying your application.

>Note that the assembly __Telerik.Windows.Controls__ must always be part of your application.
The following two assemblies should be always referenced in the project:

* `Telerik.Windows.Controls.dll`
* `Telerik.Licensing.Runtime.dll`—The licensing assembly can be installed also via the `Telerik.Licensing` NuGet package.

Controls | Assembly
--- | ---
Expand Down Expand Up @@ -126,7 +129,7 @@ RadTreeView | Telerik.Windows.Controls.Navigation, Telerik.Windows.Data
RadVirtualGrid | Telerik.Windows.Controls.VirtualGrid, Telerik.Windows.Controls, Telerik.Windows.Data
RadVirtualKeyboard | Telerik.Windows.Controls.Navigation
RadWatermarkTextBox | Telerik.Windows.Controls
RadWebCam | Telerik.Windows.Controls, Telerik.Windows.Controls.Media, Telerik.Windows.MediaFoundation, MediaFoundation, SharpDX, SharpDX.Direct3D9
RadWebCam | Telerik.Windows.Controls, Telerik.Windows.Controls.Media, Telerik.Windows.MediaFoundation, MediaFoundation, the SkiaSharp NuGet package
RadWindow | Telerik.Windows.Controls.Navigation
RadWizard | Telerik.Windows.Controls, Telerik.Windows.Data, Telerik.Windows.Controls.Navigation
RadWordsProcessing | Telerik.Windows.Documents.Core, Telerik.Windows.Documents.Flow, Telerik.Windows.Zip, Telerik.Windows.Documents.Flow.FormatProviders.Pdf, Telerik.Windows.Documents.Fixed
Expand Down
32 changes: 12 additions & 20 deletions getting-started/explore-control-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,50 +10,42 @@ position: 3

# Explore UI for WPF Control Features

Once you have the controls [working in your project]({%slug getting-started-first-steps%}), it's time to see what they can do. This article provides a short overview of how to get started with finding control functionality so you can use it.
Once you have the controls [working in your project]({%slug nuget-setup-lifecycle%}), it's time to see what they can do. This article provides a short overview of how to get started with finding control functionality so you can use it.

## Demos

To get an overview of what each control offers, the fastest approach is download the [WFP Demos Application](http://demos.telerik.com/wpf).

You can also [download the source code of the demo application]({%slug installing-wpf-demos%}#getting-the-source-code) from your [telerik.com account](https://www.telerik.com/account/downloads/product-download?product=RCWPF) as a Visual Studio project and play around with the demos in the comfort of your IDE. The `Telerik_UI_for_WPF_[version]_Demos.zip` archive contains the respective source code.
You can also [download the source code of the demo application]({%slug installing-wpf-demos%}#getting-the-source-code) from your [telerik.com account](https://www.telerik.com/account/downloads/product-download?product=RCWPF) as a Visual Studio project and play around with the demos in the comfort of your IDE.

## Explore properties and tags
## Properties and Tags

You can **explore** the available properties, events and inner tags of any control through the VS **intellisense** to get a quick glimpse of their concepts and availability.

>caption Figure 1: Explore Intellisense in the markup

![Explore Intellisense in the markup](adding-telerik-ui-to-an-application/images/installation-adding-application-using-intellisense-vs-wpf-0.png "Explore Intellisense in the markup")

>caption Figure 2: Explore Intellisense in the code-behind

![Explore Intellisense in the code-behind](adding-telerik-ui-to-an-application/images/installation-adding-application-using-intellisense-vs-wpf-2.png "Explore Intellisense in the code-behind")

## Documentation

In addition to that, the **documentation** provides a section for each control that contains help articles **on distinct features and API reference**.

>caption Figure 3: Typical control documentation structure
__Typical control documentation structure__

![Typical control documentation structure](images/typical-control-docs-structure.png "Typical control documentation structure")

## Design-time

Last, but not least, some most common tasks and configuration options are available in the control's [Smart Tag in Design Mode]({%slug common-smart-tags%}). You will also find **design-time wizards** and **links** that can be useful when you are getting started with a feature, or even for advanced users who want to save time with setting up collections, data sources or properties.
Some of the most common tasks and configuration options are available in the control's [Smart Tag in Design Mode]({%slug common-smart-tags%}). You will also find **design-time wizards** and **links** that can be useful when you are getting started with a feature, or even for advanced users who want to save time with setting up collections, data sources or properties.

>caption Figure 4: Smart Tag features
__Smart Tag features__

![Smart Tag features](images/smart-tag-features.png "Smart Tag features")

## SDK Examples

The SDK Examples (also known as Developer Focused Examples) are a good source with runnable project showing different features of the Telerik UI for WPF controls. Find the SDK Examples in the [corresponding GitHub repository](https://github.com/telerik/xaml-sdk).

## Next Steps

Now that you have the Telerik UI for WPF controls running in your project, you may want to explore their features, customize their behavior or change their appearance. Below you can find guidance on getting started with such tasks:

* [Change control appearance]({%slug getting-started-change-control-appearance%})
* [Further information]({%slug getting-started-next-steps%})

## See Also
* [Change Control Appearance]({%slug getting-started-change-control-appearance%})
* [Further Information]({%slug getting-started-next-steps%})

* [First Steps]({%slug getting-started-first-steps%})
* [Progress Virtual Classroom](https://www.telerik.com/account/support/virtual-classroom)
6 changes: 5 additions & 1 deletion getting-started/first-steps-msi-or-zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ position: 2

This article describes the lifecycle of a Telerik application. This includes creating, deploying, redistributing, and upgrading an application with referenced Telerik dlls.

The topic shows what is the lifecycle when using the __.msi__ or __.zip__ file to get the dlls. As an alternative, you can use [NuGet packages]({%slug nuget-setup-lifecycle%}) or [Telerik UI for WPF Extension]({%slug getting-started-first-steps%}) as shown in the corresponding articles in this documentation section.
The topic shows what is the lifecycle when using the __.msi__ or __.zip__ file to get the dlls. As an alternative, you can use [NuGet packages]({%slug nuget-setup-lifecycle%}) or [Telerik UI for WPF Extension]({%slug getting-started-first-steps%}).

## Creating a Project

Expand Down Expand Up @@ -40,6 +40,10 @@ Use the Visual Studio's Reference Manager to browse and reference the Telerik dl

If you need to set a [Telerik theme]({%slug common-styling-appearance-available-themes%}) different than the default one check the [Xaml vs. NoXaml]({%slug xaml-vs-noxaml%}) and the [Setting a Theme]({%slug styling-apperance-implicit-styles-overview%}) articles.

## Installing a License Key

To use the Telerik WPF product you will need to install a valid license key. Otherwise, you will see warning messages and banners related to the licensing. See how to activate a license in the [Installing License Key]({%slug installing-license-key%}) article.

## Adding Telerik Controls

After you create the WPF project and reference the Telerik assemblies, add any UI and related code-behind, models, and styles. This example will show a fundamental setup, including a RadTabControl with few tabs defined in XAML.
Expand Down
4 changes: 1 addition & 3 deletions getting-started/first-steps-nuget.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ position: 0

# First Steps With Nuget Packages

This article describes the lifecycle of a Telerik application. This includes creating, deploying, redistributing, and upgrading an application with referenced Telerik dlls.

The topic shows what is the lifecycle when using the Telerik __nuget packages__ to get dlls. As an alternative, you can use [MSI or Zip files]({%slug msi-or-zip-setup-lifecycle%}), or [Telerik UI for WPF Extension]({%slug getting-started-first-steps%}) as shown in the corresponding articles in this documentation section.
This article describes the lifecycle of a Telerik application when using NuGet packages. This includes creating, deploying, redistributing, and upgrading an application with referenced Telerik dlls.

## Creating a Project

Expand Down
75 changes: 39 additions & 36 deletions getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,19 @@ position: 1

This article explains how to get the Telerik UI for WPF controls in your project and start using them quickly.

Once you have your first simple control up and running, take a look at the [next steps](#next-steps) section to start exploring the control functionality in more details.
The topic shows what is the lifecycle when using the Telerik Visual Studio Extension. As an alternative, you can use [NuGet packages]({%slug nuget-setup-lifecycle%}).

For additional resources you can also review the Related Articles section on the right.
## Downloading the Extension

## Download the Controls
To download the Telerik Visual Studio Extenion, you can either download the `.msi` installer from the Telerik UI for WPF [download page](https://www.telerik.com/account/product-download?product=RCWPF) or use the __Extensions__ menu of Visual Studio to download the extension from the marketplace (*"Progress Telerik UI for WPF Extension"*).

The easiest way to get the controls to your development machine is to use the [Progress Control Panel](https://www.telerik.com/download-trial-file/v2/control-panel) or to download the automated MSI installer from [your telerik.com account](https://www.telerik.com/account/product-download?product=RCWPF).
__Download automated (.msi) installer__

>caption Figure 1: Download automated (.msi) installer
![Download automated installer Telerik_UI_for_WPF_<version>_Dev.msi](images/download-msi.png")

![Download automated installer Telerik_UI_for_WPF_<version>_Dev.msi](images/download-msi.png "Telerik_UI_for_WPF_<version>_Dev.msi")
If you are not a customer, you can [download a free, fully functional trial](https://www.telerik.com/try/ui-for-wpf) and the same options will apply to you as well.

> If you are not a customer, you can [download a free, fully functional trial](https://www.telerik.com/try/ui-for-wpf) and the same options will apply to you as well.

>tip The following article can help you choose the installation type that is most suitable for your needs and preferences: [Installation Approaches]({%slug installation-installing-which-file-do-i-need%}).
The following article can help you choose the installation type that is most suitable for your needs and preferences: [Installation Approaches]({%slug installation-installing-which-file-do-i-need%}).

## Creating Application with Telerik Visual Studio Extensions

Expand All @@ -38,25 +36,39 @@ The Visual Studio Extensions can be accessed through the Extensions | Telerik |

2. Create new Telerik WPF application.

#### __Figure 2: Go to Telerik > Telerik UI for WPF > Create New Telerik Project__
![Run Create Project Wizard](../integration/visual-studio-extensions/images/VSExtentions_WPF_OverviewMenuCreate.png "Run Create Project Wizard")
__Go to Telerik > Telerik UI for WPF > Create New Telerik Project__

![Run Create Project Wizard](../integration/visual-studio-extensions/images/VSExtentions_WPF_OverviewMenuCreate.png)

__Creating new Telerik application__

#### __Figure 3: Creating new Telerik application__
![Creating new Telerik application](images/installation-adding-to-application-create-application-and-adding-control-1.png)

3. Choose the project template and the corresponding settings. For an empty project without any Telerik controls added to the view, choose the Blank option.

#### __Figure 4: Choosing an application template__
__Choosing an application template__

![Choosing an application template](images/installation-adding-to-application-create-application-and-adding-control-2.png)

At this point the project references only the common Telerik.Windows.Controls.dll and you can start adding controls in the UI.
At this point the project references only the common `Telerik.Windows.Controls.dll` and `Telerik.Licensing.Runtime.dll`, and you can start adding controls in the UI.

You can further configure the project using the Project Configuration Wizard. You can do that by going to the __Extensions > Telerik > Telerik UI for WPF > Configure Project__ menu in Visual Studio. When you open the wizard you can select the controls you are going to use from the list (or search them in the search box). Once you have selected them, click Finish. This will add the required dlls and references to your project.
4. In case you haven't installed a license key already, you can download one using the License Validation screen.

__License validation screen (license not found)__

![License validation screen](images/installation-adding-to-application-create-application-and-adding-control-license-validation.png)

__License validation screen (successfully downloaded a license)__

![License validation screen - successfull download](images/installation-adding-to-application-create-application-and-adding-control-successfull-download.png)

You can further configure the project using the Project Configuration Wizard. You can do that by going to the __Extensions > Telerik > Telerik UI for WPF > Configure Project__ menu in Visual Studio. When you open the wizard you can select the controls you are going to use from the list (or search them in the search box). Once you have selected them, click Finish. This will add the required dlls and references to your project.

#### __Figure 5: Adding references to the charting controls__
![Common Installing Creating Application 013 WPF](images/installation-adding-to-application-create-application-and-adding-control-3.png)
__Adding references to the charting controls__

![Common Installing Creating Application 013 WPF](images/installation-adding-to-application-create-application-and-adding-control-3.png)

> This step is optional and you will only need it if you use controls that are not defined in Telerik.Windows.Controls.dll.
This step is optional and you will only need it if you use controls that are not defined in `Telerik.Windows.Controls.dll`.

## Add a Telerik Control to the Project

Expand All @@ -75,24 +87,22 @@ In order to use the __RadGridView__ control in your projects, you have to add re

You can add __RadGridView__ manually by writing the XAML code in __Example 1__ or you can also add the control by dragging it from the Visual Studio Toolbox and dropping it over the XAML view.

#### __[XAML] Example 1: Adding RadGridView in XAML__

#### __[XAML] Adding RadGridView in XAML__
{{region xaml-gridview-getting-started2_0}}
<telerik:RadGridView />
{{endregion}}

If you run the application, you will see an empty grid with no columns and rows as demonstrated in __Figure 6__.

#### __Figure 6: The empty grid generated by the code in Example 1__
__The empty grid generated by the code in Example 1__

![Telerik {{ site.framework_name }} DataGrid GettingStarted 2](images/RadGridView_GettingStarted_2.png)

### Populating with Data

In order to populate the __RadGridView__ control with data, you should create a collection of business objects. Create a new class named __Profile__ and add several different type properties to it, as shown in __Example 2__.

#### __[C#] Example 2: Simple business class__

#### __[C#] Simple business class__
{{region cs-gridview-getting-started2_0}}
public class Profile
{
Expand All @@ -103,8 +113,7 @@ In order to populate the __RadGridView__ control with data, you should create a
}
{{endregion}}

#### __[VB.NET] Example 2: Simple business class__

#### __[VB.NET] Simple business class__
{{region vb-gridview-getting-started2_0}}
Public Class Profile
Public Property ID As Integer
Expand All @@ -116,8 +125,7 @@ End Class

Next, create a collection of Profile objects in the MainWindow and set the RadGridView ItemSource.

#### __[C#] Example 3: Simple business class__

#### __[C#] Simple business class__
{{region cs-gridview-getting-started2_0}}
public MainWindow()
{
Expand All @@ -133,9 +141,7 @@ Next, create a collection of Profile objects in the MainWindow and set the RadGr
}
{{endregion}}


#### __[VB.NET] Example 3: Simple business class__

#### __[VB.NET] Simple business class__
{{region vb-gridview-getting-started2_0}}
Public Sub New()
Me.InitializeComponent()
Expand All @@ -159,8 +165,7 @@ Next, create a collection of Profile objects in the MainWindow and set the RadGr

Now that you have prepared the needed sample data, you need to bind it to each column in XAML as shown in the Example 4 below.

#### __[XAML] Example 4: Define RadGridView in XAML__

#### __[XAML] Define RadGridView in XAML__
{{region xaml-gridview-getting-started2_1}}
<Grid>
<telerik:RadGridView x:Name="gridView"
Expand All @@ -177,7 +182,7 @@ Now that you have prepared the needed sample data, you need to bind it to each c

Run the project and you should see something like this:

#### __Figure 7: The final result__
__The final result__

![Main window with RadGridView](images/main-window-with-radgridview.png "Main window with RadGridView")

Expand All @@ -189,9 +194,7 @@ Now that you have the Telerik UI for WPF controls running in your project, you m
* [Change control appearance]({%slug getting-started-change-control-appearance%})
* [Further information]({%slug getting-started-next-steps%})

## See Also

## See Also
* [System Requirements]({%slug installation-system-requirements-wpf%})
* [Download Product Files]({%slug download-product-files-wpf%})
* [Add Telerik Namespace]({%slug installation-adding-application-namespace-declaration%})
* [Progress Virtual Classroom](https://www.telerik.com/account/support/virtual-classroom)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed getting-started/images/main-page-with-radlistbox.png
Binary file not shown.
Binary file modified getting-started/images/msi-or-zip-setup-lifecyle-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified getting-started/images/msi-or-zip-setup-lifecyle-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified getting-started/images/msi-or-zip-setup-lifecyle-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified getting-started/installation/images/progress-control-panel-2.png
Binary file modified getting-started/installation/images/progress-control-panel-4.png
Loading