| RMC_AddCaption function. | ||
| Add a caption to a region of an existing chart | ||
| Syntax | ||
| nResult (LONG) = RMC_AddCaption( ByVal nCtrlId (LONG), ByVal nRegion (LONG), ByRefsCaption (ASCIIZ), Optional ByVal nBackColor (LONG), Optional ByVal nTextColor (LONG), Optional ByVal nFontsize (LONG), Optional ByVal nFontbold (LONG) ) |
||
| Parameter | ||
| nCtrlId (LONG) | ||
| Unique ID of the chart control, to which the caption belongs. | ||
| nRegion (LONG) | ||
| Region to which the caption belongs. | ||
| sCaption (ASCIIZ) | ||
| The caption's text with a maximum length of 200 chars. | ||
| nBackColor (LONG) | ||
| Background color of the caption as a Color... constant or as a RGB value. If omitted or 0, no backcolor will be drawn. | ||
| nTextColor (LONG) | ||
| Textcolor of the caption as a Color... constant or as a RGB value. If omitted or 0: ColorBlack. | ||
| nFontsize (LONG) | ||
| Font size in points, which is used to draw the caption. If omitted or 0: 9 points. | ||
| nFontbold (LONG) | ||
| If TRUE, font is bold. If omitted or 0: FALSE. | ||
| Return value | ||
| 0 | ||
| No error, function succeeded. | ||
| RMC_ERROR_CTRLID | ||
| Wrong control ID (0 or no chart with this control ID was found). | ||
| RMC_ERROR_MAXREGION | ||
| The region index exceeds the maximum possible numbers of regions (6) within a chart control. | ||
| RMC_ERROR_WRONGREGION | ||
| The region index is inexistent in the chart control. | ||