Try OpenEdge Now
skip to main content
Online Help
Introducing the Class Browser : Reference : Summary pane
 

Summary pane

The Summary pane displays a description for the selected resource, package, namespace, type, or member. For members of a type, the pane includes sample ABL syntax that you can use to access the selected member. If there is a mapped data type, it is shown in parentheses.
The pane also displays extent information for methods, properties, and variables that are arrays. In addition, abstract classes, methods, properties, and events are identified as such in the description of the element.
You can select any text in the Summary pane and copy it to the clipboard for use outside of the Class Browser. If you select multiple types in the Browser pane or the Content pane, the Summary pane is empty.
The information that the Summary pane displays for .NET types is extracted from the .xml file associated with the assembly file. For example, the documentation for the types in mscorlib.dll is included in mscorlib.xml.
When you select this item in the Browser pane . . .
The Summary pane displays. . .
An assembly, procedure library, or path entry
*The name of the resource.
*The location of (path to) the resource.
*For an external resource, internal resource, or if selected by project: a list of project names that reference the resource.
*A summary (description) of the resource, if available.
A project
*The name of the project.
*Path to the project directory.
A package or a namespace
*The name of the package or namespace.
*The list of resources for which the package or namespace is a member.
*A summary (description) of the package or namespace.
A type
*The name of the type.
*Whether it is FINAL or ABSTRACT.
*The list of packages or namespaces for which the type is a member.
*The name of the base type it inherits from.
*The list of interfaces being implemented.
*A summary (description) of the type, if available.
*Examples of ABL syntax using the type.
A data member
*The type of data member.
*The name of the data member.
*ABL syntax showing the data member definition, which includes access modifier and type.
*The name of the type that contains the data member.
*A summary (description) of the data member, if available.
A method
*The name of the method and details about it, including PUBLIC, PROTECTED, FINAL, OVERRIDE, STATIC, or ABSTRACT.
*ABL syntax showing the method definition, which includes the access modifier, the method name, the method's parameters, and the return value.
*The name of the type that contains the method.
*A summary (description) of the method, if available.
Also shown if applicable:
*A description of the return values of the method (if available).
*Parameters (if available).
An event
*The name of the event, including an indication of whether the event is abstract.
*ABL syntax showing the event definition, which includes the access modifier, event name, and the event's parameters, as well as a method definition for a method handler.
*The name of the type that contains the event.
*A summary (description) of the event, if available.
*Examples of ABL syntax using the event.
*The signature of the event. The SIGNATURE keyword appears for ABL events that include a signature, and the DELEGATE keyword appears for ABL events that use a delegate.
Summary information for .NET events is the same in structure as for ABL events and also shows the signature of the event.
Also shown if applicable:
*A description of the parameters (if available)
A property
*The name of the property, including an indication of whether the property is abstract.
*The data type.
*The parameters, if applicable, shown in brackets for an indexed property.
*Accessor-access-mode (if valid).
*The name of the type that contains the property.
*A summary (description) of the property, if available.
*A note that indicates if a property is an indexed property.
*Examples of ABL syntax using the property.
Also shown if applicable:
*A description of the parameters (if available).