Shown below is a summary of the conventions used, with an example of the Caption property. The conventions are the same for properties, methods, and events.
|
Components of the topic |
Description |
|||||||||
|
Caption Property |
The name of the property. |
|||||||||
|
Returns or sets the text displayed... |
The description of the property. |
|||||||||
Syntax |
"Syntax" label |
|||||||||
|
Object.Caption [ = String] |
The syntax of the property. If the object description says "Returns or sets...", the result is shown on the right, for example: Object.Caption [ = String]. This applies at run time. If the description says "Returns...", the result is shown on the left, for example: [ String = ] Object.Caption. This applies at design time. |
|||||||||
|
The Caption property syntax has the following parts:
|
The components of the syntax are described in the first column in italics. |
|||||||||
Comments |
"Comments" label |
|||||||||
|
When you create a new object, its... |
Further details about the property are explained under "Comments". |
|||||||||
Example |
"Example" label |
|||||||||
|
The following statement changes the ACheckBox Caption: |
An example is described for most properties. |
|||||||||
|
chk1.Caption="Use..." |
Example code is given. |
|||||||||
Applies to |
"Applies to" label |
|||||||||
|
The controls or classes this property applies to are listed, as links to each object. |
||||||||||
See Also |
"See Also" label |
|||||||||
|
* used in Property value table |
Indicates default property value |
|||||||||
|
References are provided to topics that may be of interest. |