Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
No Matches
Text Box

Used to show a multi-page piece of text.

The text box is used for showing a large multipage piece of text in Kodi. You can choose the position, size, and look of the text.


<control type="textbox" id="2">
<description>My first text box control</description>
<autoscroll delay="3000" time="1000" repeat="10000">!Control.HasFocus(13)</autoscroll>
<label>Text to display goes here [CR] next line...</label>
NSString * text
Definition SpeechRecognitionDarwin.mm:32
int64_t time
Definition addons/kodi-dev-kit/include/kodi/c-api/addon-instance/audiodecoder.h:118
@ center
Definition cc_decoder708.h:78
@ CR
Definition cc_decoder708.h:23
const char const uint8_t size_t unsigned int unsigned int * height
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/imagedecoder.h:417
const char const uint8_t size_t unsigned int * width
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/imagedecoder.h:416
Definition modules_cpp_peripheral_lifetime_diagram_1.dox:147

Available tags

In addition to the Default Control Tags the following tags are available. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

Tag Description
height <height>auto</height> is supported in textbox controls
font Font used for the items first label. From fonts.xml.
textcolor Color used for displaying the text. In AARRGGBB hex format, or a name from the colour theme.
shadowcolor Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the colour theme.
pagecontrol Specifies the <id> of the page control used to control this textbox. The page control can either be a Spin Control or a Scroll Bar Control.
scrolltime The time (in ms) to scroll from one item to another. By default, this is 200ms. The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling.
align possible values for text alignment: left, right, center, justify
autoscroll Specifies the timing and conditions of any autoscrolling this textbox should have. Times are in milliseconds. The content is delayed for the given delay, then scrolls at a rate of one line per time interval until the end. If the repeat tag is present, it then delays for the repeat time, fades out over 1 second, and repeats. It does not wrap or reset to the top at the end of the scroll. You can use any bool condition to specify when autoscrolling should be allowed.

See also