This repository was archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 223
Expand file tree
/
Copy pathHTMLText.lcdoc
More file actions
310 lines (244 loc) · 12.1 KB
/
Copy pathHTMLText.lcdoc
File metadata and controls
310 lines (244 loc) · 12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
Name: HTMLText
Type: property
Syntax: set the HTMLText of [<chunk> of] <field> to <htmlString>
Syntax: get the [effective] HTMLText of [<chunk> of] <field>
Summary:
Specifies the contents of a <field>, including all text
<textStyle|styles> and paragraph <format|formatting>, represented as
<HTML> tags and special characters represented as <HTML> entities.
Associations: field
Introduced: 1.0
OS: mac, windows, linux, ios, android
Platforms: desktop, server, mobile
Example:
set the HTMLText of field "White Paper" to "<b><i>Click here!</i></b>"
Example:
set the HTMLText of field "Dest" to the HTMLText of field "Source"
Example:
write the HTMLText of field "Story" to file myWebFile
Example:
put the effective htmlText of field "description"
Example:
set the HTMLText of field "display" to URL "http://www.server.com/somepage.html"
Description:
Use the <HTMLText> <property> to copy or export a
<field(object)|field's> contents with the text and paragraph
<format|formatting> intact. Setting the <HTMLText> of a field can also
be a way of displaying simple <HTML>-formatted text from a web page or
external file. It should be emphasized that the <HTMLText> property is
not a complete <HTML> rendering engine. Instead, it can be understood as
a way to faithfully represent the entire contents of a field, including
text and paragraph formatting, using HTML-style tags and attributes.
The <HTMLText> of a <field(object)> or <chunk> is a <string>.
If the <effective> keyword is specified the <HTMLText> property returns
the <HTML> of the field with explicit formatting. For example if the
<textFont> of the stack is set this is not included in the <HTMLText>
but is included in the <effective> <HTMLText>.
The <HTMLText> <property> is a representation of the styled text and
paragraph formatting of the <field(object)>. LiveCode uses a subset of
<HTML> tags that includes font, size, style, and text color information,
along with paragraph alignment, indentation, spacing, padding and other
information.
<set(command)|Setting> the <HTMLText> of a <field(object)> (or a <chunk>
of a <field(object)>) sets both the text contents and the style
attributes corresponding to the tags listed below. (Other tags are
ignored.)
<get(command)|Getting> the <HTMLText> <property> reports a <string>
consisting of the text of the <field(object)> (or <chunk> of a
<field(object)>), with any font, size, style, or color <properties>
embedded in the text in the form of the tags listed below.
The tags translate as follows:
<p> </p>
Encloses a line of text. (Blank lines are also enclosed in <p>
</p>.) These properties are represented as attributes of the
<p> tag:
* align="left|center|right" appears if an <textAlign|alignment> has been
applied to the line.
* firstindent="N" (where N is an integer representing number of pixels)
appears if the <firstIndent> has been set for the line.
* leftindent="N" appears if the <leftIndent> has been set for the line.
* rightindent="N" appears if the <rightIndent> has been set for the
line.
* spaceabove="N" appears if the <spaceAbove> has been set for the line.
* spacebelow="N" appears if the <spaceBelow> has been set for the line.
* tabstops="N" appears if <tabStops> have been set for the line.
* tabAlign="left|center|right[,left|center|right...]" appears if <tabAlign> has been set for the line.
* borderwidth="N" if a <borderWidth> has been set for the line.
* hgrid="true|false" if the <vGrid> property has been set for the line.
* vgrid="true|false" if the <hGrid> property has been set for the line.
* dontwrap="true|false" if the <dontWrap> property has been set for the
line.
* padding="N" if the <padding> has been set for the line.
* hidden="true|false" if the <hidden> property has been set for the
line.
* bgcolor="#NNNNNN" if a <backgroundColor> has been set for the line.
* bordercolor="#NNNNNN" if a <borderColor> has been set for the line.
>*Note:* An <HTML>-style color definition consists of a hash mark (#)
> followed by three 2-digit hexadecimal numbers,
one each for red, green, and blue. E.g., "#FF9900" represents an orange
color.
<sub> </sub>
Encloses text whose <textShift> is a positive <integer>.
(The <sub> tag is not nested for additional levels of
subscription: it appears once for a run of subscripted text, regardless
of the value of the <textShift>.)
* shift="N" where N is the number of pixels text is subscripted.
<sup> </sup>
Encloses text whose <textShift> is a <negative> <integer>. (The
<sup> tag is not nested for additional levels of superscription:
it appears once for a run of superscripted text, regardless of the value
of the <textShift>.)
* shift="-N" where N is the number of pixels text is superscripted.
<i> </i>
Encloses text whose <textStyle> is "italic".
>*Note:* If a field is set to <HTML> text that includes text enclosed by
> <em> </em>,
the tag will be converted to <i> </i>.
<b> </b>
Encloses text whose <textStyle> is "bold".
>*Note:* If a field is set to <HTML> text that includes text enclosed by
> <strong> </strong>,
the tag will be converted to <b> </b>.
<strike> </strike>
Encloses text whose <textStyle> is "strikeout".
<u> </u>
Encloses text whose <textStyle> is "underline".
<box> </box>
Encloses text whose <textStyle> is "box".
<threedbox> </threedbox>
Encloses text whose <textStyle> is "threeDBox".
<font> </font>
Encloses text whose <textFont>, <textSize>, <foregroundColor>, or
<backgroundColor> is different from the <field(object)|field's>
<default>. These five <property|properties> are represented as
attributes of the <font> tag.
* face="fontName" appears in the <font> tag if the <textFont> is
not the <default>.
* size="N" (where N is the point size of the font) appears if the
<textSize> is not the <default>.
* lang="languageName" appears if the <textFont> includes a
<fontLanguage|language> specification.
* color="#NNNNNN" appears if the <foregroundColor> is not the <default>.
* bgcolor="#NNNNNN" appears if the <backgroundColor> is not the
> <default>.
>*Note:* An <HTML>-style color definition consists of a hash mark (#)
> followed by three 2-digit hexadecimal numbers,
one each for red, green, and blue. E.g., "#FF9900" represents an orange
color.
<ol type="lower latin|upper latin|lower roman|upper roman">
</ol> Encloses lines of text whose <listStyle> <property> is one
of the following:
* lower latin
* upper latin
* lower roman
* upper roman
<ul type="disc|circle|square|skip"> </ul>
Encloses lines of text whose <listStyle> <property> is one of the
following:
* "disc"
* "circle"
* "square"
* "skip"
<li> </li>
Encloses a line of text whose <listStyle> <property> has been set to one
of the <listStyle|listStyles> listed above.
<a> </a>
Encloses text whose <textStyle> is "link" or whose <linkText> <property>
is not empty. If the <textStyle> of the text contains "link", the
<linkText> is included as the value of the "href" attribute. Otherwise,
it is included as the value of the "name" attribute.
<img src="imageSpecifier">
Replaces a character whose <imageSource> <property> is not empty. The
value of the <imageSource> <property> is included as the value of the
"src" attribute.
<span metadata="string"> </span>
Encloses a run of text whose <metadata> property is set to the string
indicated.
When you set the <HTMLText> of a <field(object)>, all tags other than
those above are ignored, except heading tags (<h1>--<h6>),
which change the size of the text in the heading element:
tag | textSize
:----:|:---------:
<h1> | 34 point
<h2> | 24 point
<h3> | 18 point
<h4> | 14 point
<h5> | 12 point
<h6> | 10 point
When <set|setting> the <HTMLText> of a <field(object) to an
<HTML>-formatted string, you can use LiveCode color references for the
"color" and "bgcolor" attributes. LiveCode translates these into
standard HTML-style color specifications.
If a chunk of text includes more than one of the above styles, LiveCode
encloses the text in the tags corresponding to each style, from the
inside out. For example, if the word "Flail" in a field is underlined
and bold, its corresponding <HTMLText> is
"<u><b>Flail</b></u>".
Special characters (whose ASCII value is greater than 127) are encoded
as <HTML> entities. Named <HTML> entities are enclosed by a leading
ampersand and trailing semicolon; e.g. &agrave; for à and
&euro; for €. LiveCode recognizes all 253 entities defined in
the XHTML specification at
<http://www.w3.org/TR/html4/sgml/entities.html>.
Unicode characters whose decimal numeric value is greater than 255 are
encoded as "bignum" entities, with a leading ampersand and trailing
semicolon. For example, the Japanese character whose numeric value is
12387 is encoded as an entity like this:&#12387;.
>*Note:* The <HTMLText> of a <field(object)> or <chunk> includes
> formatting information for the text, but does not include information
about the text <properties> of the <field(object)> itself. If you use
the <HTMLText> <property> to transfer text between
<field(object)|fields>, you must make sure that the destination
<field(object)|field's> <textFont> and other text <properties> match the
settings of the source field, if you want the text in both
<field(object)|fields> to look identical.
>*Important:* The <HTMLText> <property> uses a tag structure that is
> HTML-like, but is not completely standard <HTML>,
in order to accommodate the full range of text styling available in
LiveCode. Specifically:
* The link, box and threedbox tags, as well as the bgColor attribute of
the font tag, have been added to accommodate styles that don't exist
in standard HTML.
* The size attribute of the font tag can encode the font's point size,
in addition to the standard 7 HTML sizes.
* The <HTMLText> reports entities whose <ASCII|ASCII value> is between
129 and 159. These correspond to characters in the <Windows>
<character set> (Code Page 1252) that are not legal <HTML> entities.
Changes:
The lang attribute, and the ability to encode Unicode characters, was
added in version 2.0.
The following enhancements were added in version 5.5:
* Support for fully representing paragraph formatting by means of
<p> tag attributes;
* Support for representing ordered and unordered lists and list styles
by means of <ul> and <ol> tags, and list items by means of
<li> tag attributes;
* Support for representing metadata in text runs by means of a
<span> tag and metadata attribute;
* Complete support for HTML entities;
* Complete support for representing all LiveCode text styles in HTML
tags;
* Improved representation of linkText and imageSource by means of
<a> tag attributes and <img> tag attributes respectively.
Support was added for <strong> and <em> tags in version 6.0.
Support for the <tabAlign> property was added in version 8.1.2
References: get (command), set (command), charToNum (function),
colorNames (function), format (function), numToChar (function),
ASCII (glossary), character set (glossary), chunk (glossary),
default (glossary), encode (glossary), format (glossary),
hexadecimal (glossary), HTML (glossary), integer (glossary),
negative (glossary), property (glossary), string (glossary),
Windows (glossary), effective (keyword), field (keyword), URL (keyword),
field (object), backgroundColor (property), borderColor (property),
borderWidth (property), dontWrap (property), dragData (property),
firstIndent (property), fontLanguage (property),
foregroundColor (property), hGrid (property), hidden (property),
HTMLText (property), imageSource (property), leftIndent (property),
linkText (property), listStyle (property), metadata (property),
mimeText (property), padding (property), rightIndent (property),
RTFText (property), spaceAbove (property), spaceBelow (property),
tabAlign (property),
tabStops (property), textAlign (property), textFont (property),
textShift (property), textSize (property), textStyle (property),
unicodeText (property), vGrid (property)
Tags: text processing