Skip to content
Open
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
101 changes: 101 additions & 0 deletions Extension/Document-SDK-Extension/Visual-Studio/Sample-Creator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
layout: post
title: Sample Creator | Document SDK | Syncfusion
description: Sample Creator is the utility that allows you to create Syncfusion ASP.NET Core or ASP.NET MVC Projects along with the samples based on Syncfusion Document SDK Controls and Features selection
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Sample Creator

The Syncfusion® Document SDK Sample Creator is a tool that lets you make Syncfusion® ASP.NET Core or ASP.NET MVC projects based on the platform selection with sample code for required Syncfusion® Document SDK component features and control configuration.

I> The Syncfusion® Document SDK Sample Creator utility is available from v30.1.37

## Create Syncfusion® ASP.NET Core or ASP.NET MVC Web Application from Sample Creator

The following steps help you to create the Syncfusion® ASP.NET Core or ASP.NET MVC Web Application via the Sample Creator utility.

1. To launch Syncfusion® ASP.NET Core or ASP.NET MVC application, follow either one of the options below:

Click **Syncfusion® Menu** and choose **Essential Studio® for Document SDK > Launch Sample Creator…** in **Visual Studio**.

![launch the Sample Creator via Syncfusion<sup style="font-size:70%">&reg;</sup> menu](images/Syncfusion_Menu_SampleCreator.png)

N> In Visual Studio 2019, Syncfusion® menu available under Extension in Visual Studio menu.

2. Syncfusion® Sample Creator Wizard displaying the Syncfusion® Document SDK **Controls and its Feature Selection** section

![Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Sample Creator wizard](images/SampleCreator-img2.png)


### Controls Selection

Listed here are the Syncfusion® Document SDK controls so you can choose the required controls.

![Syncfusion<sup style="font-size:70%">&reg;</sup> Document Sdk Sample Creator Controls selection](images/SampleCreator-img3.png)

### Project Configuration

1. You can configure the following project details in the Sample Creator.

- Platform Type – Select the type of platform either ASP.NET Core or MVC.

- ASP.NET Core:

- Select the VS Version - Choose the Visual Studio Version
- .NET Core – Choose the .NET Core version
- Assets From – Load the Syncfusion® assets to either CDN or NPM.

![Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Sample Creator project configuration section](images/SampleCreator-core.png)

- ASP .NET MVC:

- Select the VS Version - Choose the Visual Studio Version
- .NET Framework – Choose the .NET Framework version
- Assets From – Load the Syncfusion® assets to either CDN or NuGet.

![Syncfusion<sup style="font-size:70%">&reg;</sup> Document SDK Sample Creator project configuration section](images/SampleCreator-mvc.png)

- Name – Name your Syncfusion® ASP.NET Core or ASP.NET MVC Application.

- Location – Choose the target location of your project.

- Theme Selection – Choose the required theme.The Theme Preview section shows the controls preview before create the Syncfusion® project.

2. Click **Create** button. After creating the project, open the project by clicking **Yes**. If you click **No**, the corresponding location of the project will be opened. Refer to the following screenshot for more information.

![create](images/sample-creator-create.png)

3. The new Syncfusion® project is created with the resources.

- Added the required Controllers and View files in the project.

- ASP.NET Core:

![required controllers](images/required-controllers.png)

- ASP.NET MVC:

![required controllers](images/required-controllers1.png)

- Included the required Syncfusion® scripts and theme files.

- ASP.NET Core:

![script-theme references](images/scripts-theme.png)

- ASP.NET MVC:

![script-theme references](images/scripts-theme1.png)

- The required Syncfusion® assemblies are added for selected controls under Project Reference.

- ASP.NET Core:

![syncfusion<sup style="font-size:70%">&reg;</sup> assemblies](images/syncfusion-assemblies.png)

- ASP .NET MVC:

![syncfusion<sup style="font-size:70%">&reg;</sup> assemblies](images/syncfusion-assemblies1.png)
52 changes: 52 additions & 0 deletions Extension/Document-SDK-Extension/Visual-Studio/code-generator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: post
title: Code Generator in Document SDK | Syncfusion
description: Learn here about adding the Document SDK Component using Code Generator of Syncfusion Document SDK Extension for Visual Studio.
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Add Blazor Document SDK component code

Syncfusion® provides a Code Generator component for the Blazor platform, allowing you to quickly insert Syncfusion® Document SDK component code into the desired location within a Razor file. The Syncfusion® extension automatically adds the necessary Syncfusion® Document SDK components along with the required namespaces, styles, and NuGet references. The Code Generator is a simple wizard that interacts with data models and integrates Syncfusion® Document SDK components with the required features into your application.

The steps below will assist you to add the Syncfusion® Document SDK components code in your Blazor application through **Visual Studio 2022**:

N> Before using the Syncfusion® Blazor Document SDK Code Generator, check whether the Syncfusion® Blazor Document SDK Extension is installed or not in Visual Studio Extension Manager by clicking on the Extensions -> Manage Extensions -> Installed. If this extension not installed, install the extension by follow the steps from the [download and installation](download-and-installation) help topic.

1. Open your existing Blazor application or create a new Blazor application in the Visual Studio 2019 or Visual Studio 2022.

2. To open the Syncfusion® Blazor Document SDK Code Generator Wizard, select one of the options below in the Razor file, and then add Syncfusion® Document SDK components:

**Option 1:**

To generate a specific component code, right-click on the editor of the Razor file at the required line and Select the **Syncfusion® Blazor Document SDK Code Generator...**

![CodeGeneratorCommand](images/Code-Generator-Command.png)

**Option 2:**

Open the .razor file and place the cursor at the required line then choose **Extension -> Syncfusion® -> Essential Studio® for Document SDK -> Syncfusion® Blazor Document SDK Code Generator…** from the Visual Studio menu.

![CodeGeneratorMenu](images/Code-Generator-Menu.png)

3. The wizard for the Syncfusion® Blazor Document SDK Code Generator will appear. Choose a required control.

![CodeGeneratorWizard](images/Code-Generator-MainWizard.png)

**Feature:** Selected Syncfusion® Document SDK component features are listed. You can select the required features.

**Control requirements:** Contains the required user input fields for the selected component. You can provide the required value for those fields to add the component code.

Click **Insert**. It generates the selected Syncfusion® Document SDK component render code and inserts it wherever the cursor is positioned.

![ComponentRenderCode](images/Code-Generator-ComponentRenderCode.png)

4. In the Output window, select the **Syncfusion® Blazor Document SDK Code Generator** from the **“Show output from”** drop-down to see the changes made to your application.

![OutputWindow](images/Code-Generator-OutputWindow.png)

5. The selected Syncfusion® Blazor Document SDK component code is inserted into the active Razor file, and the application is configured with the latest NuGet package, styles, and namespaces required for the selected component.

6. If you have installed the trial setup or NuGet packages from nuget.org, you must register the Syncfusion® license key to your application as Syncfusion® has 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) to generate and register the Syncfusion® license key to your application. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2) post to know more about the licensing changes introduced in Essential Studio®.
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
layout: post
title: Download and Installation of Document SDK | Syncfusion
description: Check out the documentation for download and installation of Syncfusion Document SDK for Visual Studio.
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Download and Installation

Syncfusion® publishes the Visual Studio extension in the below Visual Studio marketplace link. You can either install it directly from Visual Studio or download and install it from the Visual Studio marketplace.

[Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.BlazorVSExtension)


## Prerequisites

The following software prerequisites must be installed to install the Syncfusion® Document SDK extension, as well as to create and add snippet in Syncfusion® Document SDK applications.

* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/).

* [.NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet).

* [.NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet).

## Install through the Visual Studio Manage Extensions

The steps below assist you to how to install the Syncfusion® Document SDK extensions from **Visual Studio Manage Extensions**.

1. Open the Visual Studio 2022.

2. Navigate to **Extension ->Manage Extensions** and open the Manage Extensions.

3. On the left, click the **Online** tab and type **"Syncfusion® Document SDK"** in the **search box**.

![Online-Manage-Extension-window](images/OnlineExtension.png)

4. Click the **Download** button in the **“Syncfusion® Document SDK Template Studio”** extensions.

5. Close all Visual Studio instances after downloading the extensions to begin the installation process. You will see the following VSIX installation prompt.

![VSIX-Installation-Window](images/VSIXinstallation.png)

6. Click the **Modify** button.

7. After the installation is complete, open Visual Studio.

8. Now, under the menu **Extensions**, you can use the Syncfusion® extensions from the Visual Studio.

![SyncfusionMenu](images/SyncfusionMenu.png)

## Install from the Visual Studio Marketplace

The steps below illustrate how to download and install the Syncfusion® Document SDK extension from the Visual Studio Marketplace.

1. Download the Syncfusion® Document SDK Extensions from the below Visual Studio Marketplace.

[Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.BlazorVSExtension)

2. Close all Visual Studio instances running, if any.

3. Double-click to install the downloaded VSIX file. You will see the VSIX installation prompts with the corresponding installed Visual Studio version checkbox for select the Visual Studio to install extension.

![VSIX-Installation-Window](images/VSIXinstallation1.png)

4. Click the **Install** button.

5. After the installation is complete, open Visual Studio. You can now use Syncfusion® extensions from the Visual Studio under the **Extensions** menu.

![SyncfusionMenu](images/SyncfusionMenu.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.
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.
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.
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.
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.
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.
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.
20 changes: 20 additions & 0 deletions Extension/Document-SDK-Extension/Visual-Studio/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: post
title: Overview of Syncfusion Document SDK Extension for Visual Studio | Syncfusion
description: Learn here all about introduction on Syncfusion Document SDK for Visual Studio which made integration ease.
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Overview of Document SDK for Visual Studio

The Syncfusion® Document SDK for Visual Studio is used to integrate Syncfusion® Documenet processing components into the applications by configuring the Syncfusion® NuGet packages and themes.

The Syncfusion® Document SDK provides the following add-ins in Visual Studio:

[Template Studio](template-studio): Creates Syncfusion® Blazor applications with required configuration for development with Syncfusion® Document SDK components.

[Code Generator](code-generator): Adds Syncfusion® Document SDK component code in razor file of Blazor Application at required place.

[Creator Sample](sample-creator): Creates Syncfusion® ASP.NET Core or MVC application with the sample code of required Syncfusion® Document SDK controls and features.
Loading