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

fz_objt_edit_text_style_run_get_info

Description

Gets style run information from 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.

Plugin Prototype

fzrt_error_td fz_objt_edit_text_style_run_get_info(

fzrt_int

windex,

fz_objt_ptr

obj,

fzrt_int

style_run_index,

fzrt_int *

start_char,

fzrt_int *

end_char,

fz_text_style_ptr

style )

Parameters

windex [Input]

project window index

obj [Input]

text object

style_run_index [Input]

the style run to get. This value must be >= 0 and < the number of runs returned from

start_char [Result]

the starting character of the run's range

end_char [Result]

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