formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Text Object
Description
Creates a solid or surface text object between two lines.
If do_solid is TRUE, the text is extruded by "depth". Otherwise a
surface object is created.
The text is made up of unicode (utf16) characters (two bytes per character).
The string must terminated with two NULL bytes (one NULL character).
Only one text style can be applied to the object during creation.
If other styles need to be applied this can be done using
after the object is created.
If NULL is passed in for the style, the default font (as set in
the Project: Fonts section of the Preferences dialog) will be
used.
Plugin Prototype
fzrt_error_td fz_objt_cnstr_text_unistr_between_lines(
fzrt_int | windex, |
str, | |
style, | |
path_obj1, | |
path_obj2, | |
double | depth, |
do_solid, | |
model_type, | |
refn_opts, | |
opts, | |
obj ) |
Parameters
windex [Input]
project window index
str [Input]
unicode (utf16) text string
style [Input, Optional]
the style to apply to the text
path_obj1 [Input]
object path 1
path_obj2 [Input]
object path 2
depth [Input]
depth of text object
Range: depth > 0.0
do_solid [Input]
if TRUE, extrudes by depth, otherwise creates a surface object.
model_type [Input]
model type
refn_opts [Input, Optional]
display resolution options. For defaults see see fz_attr_refn_parm_enum
opts [Input, Optional]
construction options. For defaults see fz_objt_text_parm_enum
obj [Result]
text object
Returns
Error codes
Availability
5.5.0.0
Example Files
See Also
Function Set
Defined in