paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-14 03:19:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazUtils/html2textrender. Adds a RenderHTML2Text topic for changes in 28dc8193.

Browse Source
This commit is contained in:
dsiders 2022-02-06 15:14:37 +00:00
parent 86ea0a4a9a
commit 530925a09f
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/xml/lazutils/html2textrender.xml
View File

@ -427,6 +427,27 @@
<seealso/>
</element>
<element name="RenderHTML2Text">
<short>Converts the specified HTML content to a plain text value.</short>
<descr>
<p>
<var>RenderHTML2Text</var> is a <var>String</var> function used to convert the HTML content specified in <var>AHTML</var> to a string with the plain text for the content. RenderHTML2Text creates a temporary <var>THTML2TextRenderer</var> instance (using its default configuration values) to remove any HTML mark-up found in the AHTML argument by calling its <var>Render</var> method.
</p>
<p>
RenderHTML2Text is a convenience routine; use a THTML2TextRenderer instance when the HTML content is stored in a TStream instance, or to override the default configuration settings for the class instance.
</p>
</descr>
<seealso>
<link id="THTML2TextRenderer.Render"/>
</seealso>
</element>
<element name="RenderHTML2Text.Result">
<short>String with the plain text value for the specified HTML content.</short>
</element>
<element name="RenderHTML2Text.AHTML">
<short>String with the HTML content converted in the routine.</short>
</element>
</module>
<!-- html2textrender -->
</package>