php-doc-en/reference/dom/functions/dom-domtext-splittext.xml
2005-01-17 08:41:34 +00:00

74 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id='function.dom-domtext-splittext'>
<refnamediv>
<refname>DOMText->splitText()</refname>
<refpurpose>
Breaks this node into two nodes at the specified offset
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMText</classname></ooclass>
<methodsynopsis>
<type>DOMText</type><methodname>splitText</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Breaks this node into two nodes at the specified <parameter>offset</parameter>,
keeping both in the tree as siblings.
</para>
<para>
After being split, this node will contain all the content up to the
<parameter>offset</parameter>. If the original node had a parent node,
the new node is inserted as the next sibling of the original node.
When the <parameter>offset</parameter> is equal to the length of this node,
the new node has no data.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The offset at which to split, starting from 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The new node of the same type, which contains all the content at and after the
<parameter>offset</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->