In This Article

Sample Code and QuickStarts

The Sample Browser is the main sample project for evaluating Actipro WinForms Studio, and the full source is available on GitHub. It is designed to provide information, comprehensive demos, and detailed samples for all the Actipro WinForms products.

This source code is invaluable for learning how to use the various control products.

Tip

The offline product installer can also be used to install a pre-compiled Sample Browser application and the full source code.

Downloading the Sample Browser

Visit https://github.com/Actipro/WinForms-Controls and download our repository's source code. The repository contains the full source for the Sample Browser project.

GitHub offers several download options including:

  • Cloning the repo with Git using this URL:
    • git clone https://github.com/Actipro/WinForms-Controls.git
  • Downloading a ZIP of the source code's current state.
Tip

It is recommended to clone the repository with the URL so that you can easily pull in future updates.

Running the Sample Browser

Once the repository's source code has been downloaded to a folder, open the Samples/SampleBrowser/SampleBrowser.sln file in Visual Studio.

The projects in that sample are preconfigured to reference our product NuGet packages. Run the solution to open the Sample Browser application.

Important

Our Sample Browser project requires the .NET SDK (even for .NET Framework targets), and this component may not be installed by default.

If the .NET SDK is not installed, a warning similar to "One or more projects in the solution were not loaded correctly." may be displayed with an error message similar to "The project file cannot be opened. Unable to locate the .NET SDK." displayed in the Visual Studio Output Window.

Use the Visual Studio Installer to add the .NET SDK component and reload the solution.

Changing the Actipro Product Version

The Samples/SampleBrowser/ActiproSoftware.References.props file contains an ActiproVersion property that defines the version of the Actipro product NuGet packages to reference. Update that value if you wish to use an alternate version.

Note

The samples always are intended to work with the current Actipro product version, and may not compile if used with other versions. However, adjustments to the Actipro product version can be useful when testing prerelease builds.

Types of Samples

Most samples involve one or more simple examples that are focused on a particular feature area or show how to perform a certain task. These kinds of samples, called QuickStarts, are the place to quickly learn how to get a specific feature working without having to navigate around the unrelated code needed to support other features.

On the other hand, a demo is a large sample that shows the combination of many product features together to create a finished product. Demos are intended to show some ideas of what you can do with our products when you use them in your own applications.

Reusing Sample Source Code

The full source for all samples is located in the sample project and you are free to reuse the sample source code as you wish.

We encourage you to copy what you need to help you get started with using the product in your own applications.