Skip to content
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
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.
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.
60 changes: 22 additions & 38 deletions Extension/WPF-Extension/Add-Item.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,67 +8,51 @@ documentation: ug
---


# Add Syncfusion window to WPF application
# Add Syncfusion Components to the WPF Application

Visual Studio Item Templates are supported by Syncfusion to add a Syncfusion WPF Window to a WPF application with Syncfusion WPF references. The Syncfusion WPF window allows you to instantly customize the window title bar and includes various pre-installed themes for a more appealing user interface.
Syncfusion supports Visual Studio Item Templates to add Syncfusion WPF Components to a WPF application with Syncfusion WPF references.

I> The Syncfusion WPF item templates are available from v19.1.0.54.

The steps below will guide you to adding the Syncfusion WPF window to your Visual Studio WPF application.
The following steps will guide you to add the Syncfusion WPF Components to your Visual Studio WPF application.

> Check whether the **WPF Extensions - Syncfusion** are installed or not in Visual Studio Extension Manager by going to **Tools -> Extensions and Updates -> Installed** for Visual Studio 2017 or lower, and **Extensions -> Manage Extensions -> Installed** for Visual Studio 2019 by going to Extensions -> Manage Extensions -> Installed. If this extension not installed, please install the extension by follow the steps from the [download and installation](download-and-installation) help topic.
> Check whether the **WPF Extensions - Syncfusion** are installed or not in Visual Studio Extension Manager by going to **Extensions -> Manage Extensions -> Installed** for Visual Studio 2019 or later and Visual Studio 2017 or lower by going to **Tools -> Extensions and Updates -> Installed**. If this extension is not installed, please install the extension by following the steps from the [download and installation](https://help.syncfusion.com/wpf/visual-studio-integration/download-and-installation) help topic.

## Add window using Syncfusion Item Template gallery
## Add Components using Syncfusion Item Template

1. Open a new or existing WPF application.
2. From the **Solution Explorer, right-click** on the WPF application. Choose **Add Syncfusion Item...**

![Choose Add Syncfusion Item option from right click project](Add-Item-images/Add-syncfusion-item.png)
**Option 1:**

3. The Syncfusion WPF Item Template Gallery wizard will be launched as like below.
2. From the **Solution Explorer, right-click** on the WPF application. Choose **Add Syncfusion Item...**.

![Syncfusion WPF Item template Gallery](Add-Item-images/Syncufsion-Item-Template-Gallery.png)
4. Select the required window either Chromeless Window or Ribbon Window in the **Select Window** section.
5. Choose an assembly reference option such as GAC location, Essential Studio installed location, or NuGet packages, to specify where from the required Syncfusion assemblies are added to the project.
![Choose Add Syncfusion Item option from right click project](Add-Item-images/Add-syncfusion-item.png)

> If the Syncfusion Essential WPF build is installed, the Installed location and GAC options will be enabled. Without installing the Syncfusion Essential WPF setup, you can use the NuGet option. When using the Syncfusion WPF window in a .NET Core application, the GAC option will not be available. The Version dropdown lists the installed WPF versions.
6. Provide the **name** for the selected window.
7. Click **Add button** to add the selected window into the WPF application along with required Syncfusion assemblies.
**Option 2:**

![Syncfusion WPF Item template Gallery](Add-Item-images/Added-Item.png)
8. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/license-key#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio.
3. Click **Extensions > Essential Studio for WPF > Add Syncfusion Item…** in Visual Studio.

![Syncfusion WPF Item template Gallery](Add-Item-images/LicensePage.png)
![Choose Add Syncfusion Item option from menu](Add-Item-images/Add-item.png)

## Add window using the Visual Studio Add New Item dialog

The Syncfusion Item Template can also be added from the Visual Studio Add New Item dialog.
4. The Syncfusion WPF Item Template wizard will be launched as follows.

![Syncfusion WPF Item template Components](Add-Item-images/Add-syncfusion-ui.png)

1. To add a Syncfusion WPF window, follow either one of the following options:
5. Select the WPF Components from the Component list within your WPF Item Template. The features associated with the selected Component will be presented. From here, choose the specific features that are essential for your project.

**Option 1:**
6. Choose an assembly reference option such as GAC location, Essential Studio installed location, or NuGet packages to specify where the required Syncfusion assemblies are added to the project.

Click **Extensions >Syncfusion Menu** and choose **Essential Studio for WPF > Add Chromeless Window…** or any other window in Visual Studio.
N> If the Syncfusion Essential WPF build is installed, the Installed location and GAC options will be enabled. Without installing the Syncfusion Essential WPF setup, use the NuGet option. The GAC option will not be available when using the Syncfusion WPF Components in a .NET Core application. The Version drop-down lists the installed WPF versions.

![Syncfusion Menu](Add-Item-images/SyncfusionMenu.png)
7. Click **Add**, and a pop-up will appear providing information about adding Component **files** and **NuGet/Assemblies** details.

> In Visual Studio 2017 or lower, you can see the Syncfusion menu directly in the Visual Studio menu.
![Syncfusion WPF Item template details](Add-Item-images/Add-syncfusion-item-3.png)

**Option 2:**
8. Click **OK** to incorporate the chosen Components into the WPF application, along with the necessary Syncfusion assemblies.

Right-click the WPF application in Solution Explorer, select **Add > New Item**, and then navigate to Visual C# Items or VB Items. Refer to the following screenshot for more information.
![Syncfusion WPF Item template Gallery](Add-Item-images/Add-syncfusion-item-details.png)

![Add New Item Dialog](Add-Item-images/AddNewMenu.png)
9. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/license-key#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio.

> The Syncfusion WPF Item Templates are available under the Syncfusion > WPF tab. It is available for both C# Items and VB Items.

![Add New Item Dialog](Add-Item-images/AddNewItemDialog.png)

2. Click **Add** button and the selected window will be added to the project along with the Syncfusion NuGet references.

![Syncfusion WPF Item template Gallery](Add-Item-images/Added-Item.png)

3. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/license-key#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio.

![Syncfusion WPF Item template Gallery](Add-Item-images/LicensePage.png)
![Syncfusion WPF Item template Gallery](Add-Item-images/LicensePage.png)
28 changes: 11 additions & 17 deletions Extension/WPF-Extension/Create-Project.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,27 @@ The Visual Studio Project Templates for the Syncfusion WPF platform allow you to

I> The Syncfusion WPF templates are available from v16.1.0.24.

> WPF Project Template works seamlessly with Visual Studio 2015 or lower. For the Visual Studio 2017 or later versions, it is recommended to use a [WPF Template Studio](https://help.syncfusion.com/wpf/visual-studio-integration/template-studio).

Create the Syncfusion WPF project using the Visual Studio Project Template by following the steps below:

> Check whether the **WPF Extensions - Syncfusion** are installed or not in Visual Studio Extension Manager by going to **Tools -> Extensions and Updates -> Installed** for Visual Studio 2017 or lower, and **Extensions -> Manage Extensions -> Installed** for Visual Studio 2019 by going to Extensions -> Manage Extensions -> Installed. If this extension not installed, please install the extension by follow the steps from the [download and installation](download-and-installation) help topic.
> Check whether the **WPF Extensions - Syncfusion** are installed or not in Visual Studio 2015 or lower by going to **Tools -> Extensions and Updates -> Installed**. If this extension not installed, please install the extension by follow the steps from the [download and installation](https://help.syncfusion.com/wpf/visual-studio-integration/download-and-installation) help topic.

1. To create a Syncfusion WPF project, follow either one of the options below:

**Option 1:**
Click **Extensions >Syncfusion** Menu and choose **Essential Studio for WPF > Create New Syncfusion Project…** in **Visual Studio**.
Click **Syncfusion** Menu and choose **Essential Studio for WPF > Create New Syncfusion Project…** in **Visual Studio**.

![Choose Syncfusion WPF Application from Visual Studio new project dialog via Syncfusion menu](Project-Template-images/Syncfusion_Menu_ProjectTemplate.png)
![Choose Syncfusion WPF Application from Visual Studio new project dialog via Syncfusion menu](Project-Template-images/Syncfusion-Menu.png)

N> In Visual Studio 2017 or lower, you can see the Syncfusion menu directly in the Visual Studio menu.
N> In Visual Studio 2015 or lower, you can see the Syncfusion menu directly in the Visual Studio menu.

**Option 2:**
Choose **File -> New -> Project**. Opens a new dialog to create a new project. By filtering the project type with Syncfusion or using the Syncfusion keyword in the search option, you can get the templates offered by Syncfusion for WPF.

![Choose Syncfusion WPF Application from Visual Studio new project dialog](Project-Template-images/Syncfusion-Project-Template-Gallery2019-1.png)

In Visual Studio 2017 or lower, Select **File > New > Project** and navigate to **Syncfusion > Windows > Syncfusion WPF Application** in Visual Studio.
In Visual Studio 2015 or lower, Select **File > New > Project** and navigate to **Syncfusion > Windows > Syncfusion WPF Application** in Visual Studio.

![Choose Syncfusion WPF Application from Visual Studio new project dialog](Project-Template-images/Syncfusion-Project-Template-Gallery-1.png)

Expand All @@ -44,20 +46,12 @@ Create the Syncfusion WPF project using the Visual Studio Project Template by fo

![Syncfusion WPF project configuration wizard](Project-Template-images/Syncfusion-Project-Template-Gallery2019-2.png)

In Visual Studio 2017 or lower, Syncfusion WPF Application project configuration wizard.
In Visual Studio 2015 or lower, Syncfusion WPF Application project configuration wizard.

![Syncfusion WPF project configuration wizard](Project-Template-images/Syncfusion-Project-Template-Gallery-2.png)

**Project Configurations**

**Project Type:** Choose .Net 6.0 and .NET 7.0 or .Net Framework as the project type.

N> From Visual Studio 2019, Project type selection option will be available in Syncfusion WPF Project template configuration. The .Net 6.0 and .Net 7.0 option will be listed in project type when only the .Net 6.0 and .Net 7.0 SDK setup has been installed.

> .NET 6.0 version is available from v19.4.0.38 and it support from Visual Studio 2022.

> .NET 7.0 version is available from v20.4.0.38 and it support from Visual Studio 2022.

**Language:** Select the language, either CSharp or VB.

N> VB language is available only when you choose .NET Framework from option in Visual Studio.
Expand All @@ -66,7 +60,7 @@ Create the Syncfusion WPF project using the Visual Studio Project Template by fo

**Reference From:** Choose the assembly location such as NuGet, GAC Location, or Essential Studio installed location, from where the assembly is added to the project.

N> The installed location and GAC options will be available only after the Syncfusion Essential WPF setup has been installed. You can use the NuGet option instead of installing the Syncfusion Essential WPF setup. Also, the GAC option will not be available when you choose .Net 6.0 and .Net 7.0 from project type option in Visual Studio 2022.
N> The installed location and GAC options will be available only after the Syncfusion Essential WPF setup has been installed. You can use the NuGet option instead of installing the Syncfusion Essential WPF setup.

**Installed ES Build Version:** To add the appropriate version assemblies to the project, choose the build version.

Expand All @@ -78,14 +72,14 @@ Create the Syncfusion WPF project using the Visual Studio Project Template by fo

N> Project create option will be enabled only if you have selected the window

4. After choosing above project configuration options in the Project Configuration Wizard, click the create button then Syncfusion WPF project is created with the necessary assembly references and XAML.
4. After choosing above project configuration options in the Project Configuration Wizard, click the create button then Syncfusion WPF project is created with the necessary XAML files and required Syncfusion WPF assemblies/NuGet packages.

![Syncfusion WPF project created with required Syncfusion WPF assemblies](Project-Template-images/Syncfusion-Project-Template-Gallery-7.png)

![Syncfusion WPF project created with required Syncfusion XAML files](Project-Template-images/Syncfusion-Project-Template-Gallery-8.png)

![Syncfusion WPF project created with readme](Project-Template-images/Syncfusion-Project-Template-Gallery-10.png)

5. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/license-key#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio.
5. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio.

![Syncfusion license registration required information dialog in Syncfusion WPF project](Project-Template-images/Syncfusion-Project-Template-Gallery-9.png)
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Extension/WPF-Extension/Overview-images/WPF-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading