All docs
V19.2
20.1 (EAP/Beta)
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

API Reference Topics Structure

  • 2 minutes to read

General Sections

Summary

This section is placed after the document title and provides a short description of the API, a link to the current namespace and the assembly file name (for .NET APIs only).

Declaration

Includes an auto-generated code snippet with API declaration code. The documentation generator adds C# and VB.NET snippets for .NET APIs.

Remarks

Contains additional descriptions, screenshots, and examples.

See Also

Contains links to related topics.

Sections for Types

Returned By

An auto-generated section displayed for classes, interfaces, and structures. Provides links to methods and properties that return the type instances. This section is displayed if there are documented APIs to link to.

Passed To

An auto-generated section displayed for enumerations. Provides links to properties that take the enumeration values (property return type is equal to the current enumeration type and the property's set accessor is public). This section is displayed if there are documented properties to link to.

The documentation generator hides creates the "Passed To" section for enumerations with more than 20 related properties.

Displayed for classes that provide arguments for events (contain event data). This auto-generated section lists events that receive class instances as an event handler argument.

Implements

Displayed for classes. This auto-generated section lists the supported interfaces.

Inheritance

Displayed for classes. Provides an auto-generated tree list of the class' ancestors and descendants.

Sections for Properties

Property Value

Shows the return type, default value specified by the DefaultValueAttribute (if the attribute is applied), and description of the property.

Property Paths

This section lists property paths you can use to access the property from different objects. The documentation generator adds property paths only for properties of parameter objects - classes that contain a group of control or component options. Names of parameter objects include "Parameters" or "Options".

For instance, gridView1.OptionsSelection.MultiSelectMode is a property path you can use to access the GridOptionsSelection.MultiSelectMode property from the GridView control. This control has the OptionsSelection property that returns the GridOptionsSelection parameter object. This object contains grid selection options including MultiSelectMode.

Sections for Methods and Constructors

Parameters

Includes an auto-generated table with the names, types, and descriptions of method's parameters.

Optional Parameters

Includes an auto-generated table with the names, types, default values, and descriptions of method's optional parameters.

Returns

Shows the type and description of the method's return value.

Sections for Events

Event Data

Displays a list of the event argument object's properties.