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.

ets_api_shapeset.h

Details

See Ets_Shape_Label_Create() for details about this shape's arguments.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com