formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Text Object

# fz_objt_edit_text_set_style_run

Description

Sets a style run information for a text object. The range of the style run is specified by start_char and end_char. This range is inclusive. The range represents characters in the text string which use the style. This function replaces the style previously applied to the text range. This works much like selecting text in a text editor and applying a style to the selected text. Styles outside the specified range are not affected, however, any ranges which overlap the range specified to this function are adjusted to the start and end of this range.

Plugin Prototype

fzrt_error_td fz_objt_edit_text_set_style_run(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | start_char,
fzrt_int | end_char,
fz_text_style_ptr | style )

Parameters

windex [Input]

project window index

obj [Input]

text object

start_char [Input]

the starting character of the run's range

end_char [Input]

the end character of the run's range

style [Result]

the style applied to the run

Returns

Error codes

Availability

5.5.0.0

Example Files

util_objt_unistr_text.fsl

Function Set

fz_model_fset

Defined in

fz_objt_text_api.h