TextString
TextString[expr]
gives a human-readable string representation of expr.
Details and Options
- TextString converts expressions to a single string, formatting expressions with the following heads specially:
-
String formats unchanged Integer,Real,Rational formats using decimal notation Quantity formats using decimal notation with unit DateObject formats according to DateFormat TimeObject formats according to TimeFormat GeoPosition formats using degrees latitude and longitude Entity formats using CommonName Symbol formats using SymbolName Missing formats according to MissingString List formats elements, combining as specified by ListFormat Association formats keys and values, combining as specified by AssociationFormat - TextString[Row[list]] formats as a concatenation of elements of list.
- TextString[Row[list,sep]] uses separator sep to combine formatted elements.
- TextString[Column[list]] formats each element on a separate line.
- TextString[TableForm[list]] formats a list of lists as space-separated columns.
- Expressions that match patterns in the list given as the setting for ElidedForms are formatted in an elided way.
- In other cases, expressions are formatted using InputForm.
- TextString supports the following options:
-
AssociationFormat Automatic format to use when formatting associations BooleanStrings {"True","False"} strings to use for True and False DateFormat $DateStringFormat format to use for dates ElidedForms Automatic list of heads whose contents should be elided ListFormat Automatic format to use when formatting lists MissingString "" string to use for Missing objects TimeFormat Automatic format to use for times TimeZone $TimeZone time zone used to convert times before formatting
Examples
open all close allBasic Examples (3)
TextString[10]//InputFormTextString[10.]//InputFormConvert a GeoPosition:
TextString[Here]//InputFormConvert a DateObject:
TextString[Now]//InputFormConvert a TimeObject:
TextString[TimeObject[]]//InputFormConvert a Quantity:
TextString[Quantity[3, "Joules"]]//InputFormTextString[{Yesterday, Today, Tomorrow}]//InputFormScope (4)
By default, TextString converts certain built-in expressions to an elided string:
TextString[RandomImage[]]//InputFormTextString recurses arbitrarily through lists and associations to convert an expression:
TextString[{{1, 2}, {3, 4, 5}, <|a -> {b, 6, 7}|>}]//InputFormTypically, expressions that satisfy NumericQ are formatted as real numbers:
TextString[{1 / 2, Sqrt[2], Exp[3]}]//InputFormRow formats as a concatenation of its contents:
TextString[Row[{"a", "b", "c", "d"}]]//InputFormColumn formats each element on a new line:
TextString[Column[Range[5]]]TableForm formats elements as a table in which columns are space-separated:
TextString[TableForm[RandomInteger[1000, {10, 5}]]]Options (8)
AssociationFormat (1)
By default, TextString formats associations as they normally appear in the Wolfram Language:
TextString[<|a -> 1, b -> 2|>]//InputFormTextString[<|a -> 1, b -> 2|>, AssociationFormat -> {"{", ", ", "}", ":"}]//InputFormBooleanStrings (1)
DateFormat (1)
TextString uses the same default format as DateString:
TextString[{Today, Tomorrow}]//InputFormOverride the default date format:
TextString[{Today, Tomorrow}, DateFormat -> {"Year", "-", "Month", "-", "Day"}]//InputFormElidedForms (1)
The default value ElidedForms->Automatic elides certain complex symbolic expressions:
TextString[RandomImage[], ElidedForms -> Automatic]//InputFormOrdinary symbolic expressions are formatted normally:
TextString[{f[10], g[20], h[30]}]//InputFormElide specific symbolic expressions:
TextString[{f[10], g[20], h[30]}, ElidedForms -> {f, h}]//InputFormElide all symbolic expressions for which specific formatting rules do not exist:
TextString[{f[10], g[20], h[30]}, ElidedForms -> All]//InputFormListFormat (1)
By default, TextString formats lists as they normally appear in the Wolfram Language:
TextString[{1, 2, 3, 4}]//InputFormTextString[{1, 2, 3, 4}, ListFormat -> {"[", ", ", "]"}]//InputFormMissingString (1)
By default, expressions with head Missing are ignored:
TextString[{1, 2, Missing[]}]//InputFormTextString[{1, 2, Missing[]}, MissingString -> "?"]//InputFormUse the given reason, if available:
TextString[{1, 2, Missing["NotAvailable"]}, MissingString -> Automatic]//InputFormTimeFormat (1)
TextString uses the same default format as DateString:
TextString[{TimeObject[], TimeObject[] + Quantity[36, "Minutes"]}]//InputFormOverride the default date format:
TextString[{TimeObject[], TimeObject[] + Quantity[36, "Minutes"]}, TimeFormat -> {"Hour", ":", "Minute"}]//InputFormTimeZone (1)
TextString defaults to using $TimeZone for the output strings:
TextString[{Now, DateObject[TimeZone -> "Asia/Tokyo"]}]//InputFormOverride the default time zone to use GMT instead:
TextString[{Now, DateObject[TimeZone -> "Asia/Tokyo"]}, TimeZone -> "GMT"]//InputFormProperties & Relations (1)
UpValues can be defined for custom objects to determine how they should be formatted by TextString:
quoted/:TextString[quoted[str_]] := "\"" <> str <> "\"";TextString[{1, 2, quoted["foo"], 3, 4}]
An Elementary Introduction to the Wolfram LanguageText
Wolfram Research (2014), TextString, Wolfram Language function, https://reference.wolfram.com/language/ref/TextString.html.
CMS
Wolfram Language. 2014. "TextString." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/TextString.html.
APA
Wolfram Language. (2014). TextString. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/TextString.html