SnapObjects .NET API Doc List
Click the following link to view the API reference document.
|Doc Name||NuGet Packages||Product|
|SnapObjects .NET API Reference (2.1.0)||SnapObjects.Data 2.1.0
|RapidSharp 2019 R2 product bundle|
|SnapObjects .NET API Reference (2.0.0)||SnapObjects.Data 2.0.0
|PowerBuilder 2019 R2 product bundle|
|SnapObjects .NET API Reference (1.0.x)||SnapObjects.Data 1.0.x
This readme page will prepare you for getting a better usage of this API Reference document. It contains the recommendation for acquiring a basic understanding of the C# language, and also brief instructions for understanding the document structure.
If you have done development before, but are new to C#, we recommend you thoroughly read through the following Microsoft .NET documents first to get a basic understanding of the C# language and .NET development.
A Tour of the C# Language: It provides an overview of the language. It covers the elements that make up C# programs and the capabilities of the language. It shows small samples of all the syntax elements of C# and discussions of the major C# language topics. After reading this, you will have answers to the following questions:
- What is an attribute? What is the difference between an attribute and a property?
- What is the difference between List, Array, and Dictionary?
- What is Data Context?
- What are the differences between a class and a structure?
- What is a namespace? What is an assembly?
- What is a delegate? How to use delegate with events?
- What is the difference between “int” and “system.Int32”
Introduction to C# Tutorials: It provides interactive tutorials for brand-new developers to explore and learn the C# language in the browser using a Read-Eval-Print Loop (REPL) interface. The tutorials provide a step-by-step process to create C# programs. They show the language concepts and how to build C# programs on your own. After you finish the interactive lessons, you can improve your coding skills by practicing the same lessons on your machine.
How the API Reference is organized
The APIs are listed in the following order: first the package by alphabetical order, then the category for the frequently-used objects of the same type or functionalities (such as Attributes for Model Class and Property, SqlModelMapper, SqlBuilder, SqlExecutor etc.), and finally the public APIs by alphabetical order (such as DatabaseType, DataContext ...).
So if you want to view all APIs related with SqlModelMapper, you expand the SqlModelMapper tree item to view the list; and you will find not only SqlModelMapper and ISqlModelMapper under the tree item, but also IDetailTracker, IEmbeddedLoadable, and ILoadable which are subsidiary APIs for implementing SqlModelMapper.
Some base classes/interfaces are for internal use only, so the only available documentation for it is its derived classes/interfaces.
ISqlModelMapper (interface) vs. SqlModelMapper (class)
When you explore the APIs, you often find two categories with similar name, for example, ISqlModelMapper vs. SqlModelMapper, IModelStore vs. ModelStore, IDataStore vs. DataStore. The APIs starting with the letter “I” is an interface (“I” short for “interface”); and the ones without the “I” are classes. The class (e.g. SqlModelMapper) implements the interface (e.g. ISqlModelMapper). So normally the class only contains documentation for constructors, while the interface contains documentation for methods and properties.
.NET-style page layout
The API Reference presents a page layout which is consistent with the Microsoft .NET API documents, for example, each API page has the same sections as the Microsoft .NET API page; if a method has no return value, the Return section does not appear in the document either.
Filter or Search
There are two ways to search in the API Reference:
- Filter: You input the API name in the Filter text box on top of the left navigation pane, to let the navigation list filter out the APIs matching with your input. The filter function works better when you know the API name (or part of the API name).
- Search: If you want to search for any keyword (not just API names), then you would need to use the Search box on the top right corner. The search function will search all Appeon C# documents (not just API Reference).