Ets_Shape_Label_Info_Get()
Note: Requires OPNET Development Kit
Abstract
Obtains the shape properties of a label.
Syntax
Ets_Shape_Label_Info_Get (label_shape_hndl, text_lines_lptr, label_box, font_str, fg_color, bg_color, line_spacing, alignment, angle)
| Argument | Type | Description |
|---|---|---|
label_shape_hndl |
EtsT_Shape_Handle |
Handle to the label shape of interest. |
text_lines_lptr |
PrgT_List ** |
Pointer to list of text strings for the label. |
label_box |
EtsT_Shape_Rect * |
A rectangle defining the area of the label. See Shape Data Types for details on the box coordinates. |
font_str |
EtsT_Shape_Font_Name * |
The name of a font for the text. |
fg_color |
EtsT_Color * |
Foreground color (used for text characters). See Shape Colors for details. |
bg_color |
EtsT_Color * |
Background color (used to fill the label box). See Shape Colors for details. For no fill, use EtsT_Shape_Color_None. |
line_spacing |
double * |
Spacing between lines, based on text size. |
alignment |
EtsT_Shape_Align * |
Horizontal position of the text within the label box, either left, center, or right (use the text alignment constants in Table 26). |
angle |
double * |
Rotation angle for the label, measured in degrees counter-clockwise from horizontal. 0.0 means no rotation. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success, or EtsC_Compcode_Failure if the shape handle passed is not for a label.
Header
ets_api_shapeset.h
Details
See Ets_Shape_Label_Create() for details about this shape's arguments.