Article

description

Displays multiple lines of text.

Overview

The description element contains text used to describe a displayed element. This element is often used to provide descriptions that are significantly longer than those contained in the text element. Here's an example that uses the descriptiveAlertTemplate to list an app's Terms of Service.

<descriptiveAlertTemplate>
   <title>Terms of Service</title>
   <description>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum</description>
   <row>
      ...
   </row>
</descriptiveAlertTemplate>

Contained In

Topics

Valid TVML Styles

background-color

Changes the background color of an element.

color

Changes the color of an element.

font-family

Specifies the font used for the text in an element.

font-size

Specifies the font size for the text in an element.

font-weight

Specifies the font weight for the text in an element.

margin

Specifies the spacing around an element.

max-height

Specifies the maximum height for an element.

max-width

Specifies the maximum width for an element.

min-height

Specifies the minimum height for an element.

min-width

Specifies the minimum width for an element.

padding

Specifies the padding between the border and contents of an element.

text-align

Aligns text horizonally in an element.

text-shadow

Adds a shadow effect to displayed text.

tv-highlight-color

Changes an element's color when it comes into focus.

tv-minimum-scale-factor

Sets the minimum size for text.

tv-text-max-lines

Specifies the maximum number of lines of text in an element.

tv-text-style

Sets a predefined size and style for text.

width

Specifies how wide an element is.

Valid TVML Attributes

accessibilityText

Adds hidden text to an element that is used when VoiceOver is enabled.

binding

Associates information in a data item with an element.

handlesOverflow

Adds the "MORE" label to a description.

prototype

Associates a data item type with an element.

showsScrollIndicator

Shows a scroll indicator along the side of an element appropriate for the user’s specified language.

theme

Sets the color scheme for an element.

See Also

Text Elements

decorationLabel

Displays text that describes a displayed element.

date

Displays a date.

monogram

Displays information below a monogramLockup element.

ordinal

Displays a number.

strike

Draws a line through the designated text.

subtitle

Displays text below the subtitle's containing element.

text

Displays text on the screen.

title

Displays a short amount of text.