?? birichedit.html
字號:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--
Generated using api.website.xsl version 2003-07-17
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>BiRichEdit</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">
function showDerivedClasses() {
var ul = document.getElementById("api-derived-classes");
var lis = ul.childNodes;
var l = lis.length;
for (var i = 1; i < l; i++)
lis[i].style.display = "";
lis[0].style.display = "none";
}
</script></head>
<body>
<h1 id="BiRichEdit">BiRichEdit</h1>
<p>
This control is used to to provide rich text editing of HTML documents
</p>
<p>This class extends
<code><a href="BiIframe.html">BiIframe</a></code>
and therefore all methods and fields available for
<code><a href="BiIframe.html">BiIframe</a></code>
are also available for <code>BiRichEdit</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code><a href="BiComponent.html">BiComponent</a></code><ul><li><code><a href="BiIframe.html">BiIframe</a></code><ul><li><code>BiRichEdit</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiRichEdit()</code></p>
<h3>Parameters</h3>
<p>No parameters.</p>
<h2>Properties</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="get-header">get</td>
<td class="set-header">set</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="contentHtml"></a><code>contentHtml</code></td>
<td><code class="type">String</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>
The HTML code inside the rich editor frame. This does not include
the doctype nor any comments outside the root element.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#execCommand">execCommand</a></code></td>
<td>
Executes a command on the rich text editor.
For a list of supported commands see
<a href="http://msdn.microsoft.com/workshop/author/dhtml/reference/commandids.asp">MSDN</a>.
The method returns <code>true</code> if the command was successful.
</td>
</tr>
<tr>
<td><code><a href="#queryCommandEnabled">queryCommandEnabled</a></code></td>
<td>
Returns a boolean value that tells whether the given command will succeed if executed.
</td>
</tr>
<tr>
<td><code><a href="#queryCommandState">queryCommandState</a></code></td>
<td>
Returns a boolean value that represents the state of the given command.
</td>
</tr>
<tr>
<td><code><a href="#queryCommandValue">queryCommandValue</a></code></td>
<td>
Returns the current value for the given command.
</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<p>None.</p>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
Do not confuse the command methods with the <code><a href="BiCommand.html">Bindows command</a></code>
concept. The command methods are used to change the content of the
editor.
</p>
<h2>Method Details</h2>
<h3><a name="execCommand"></a>execCommand</h3>
<p>
Executes a command on the rich text editor.
For a list of supported commands see
<a href="http://msdn.microsoft.com/workshop/author/dhtml/reference/commandids.asp">MSDN</a>.
The method returns <code>true</code> if the command was successful.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.execCommand(<span class="methodArgument">sCommand</span> [, <span class="methodArgument">bUi</span> [, <span class="methodArgument">oCommandValue</span>]])</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sCommand</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The command to execute</td>
</tr>
<tr>
<td><code>bUi</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>false</code></td>
<td>Whether to show a dialog where extra arguments can be entered</td>
</tr>
<tr>
<td><code>oCommandValue</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>Some commands takes an argument. In those cases this argument is used</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="queryCommandEnabled"></a>queryCommandEnabled</h3>
<p>
Returns a boolean value that tells whether the given command will succeed if executed.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.queryCommandEnabled(<span class="methodArgument">sCommand</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sCommand</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The command to get check whether enabled</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="queryCommandState"></a>queryCommandState</h3>
<p>
Returns a boolean value that represents the state of the given command.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.queryCommandState(<span class="methodArgument">sCommand</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sCommand</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The command to get the state for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="queryCommandValue"></a>queryCommandValue</h3>
<p>
Returns the current value for the given command.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.queryCommandValue(<span class="methodArgument">sCommand</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sCommand</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The command to get the value for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
</body>
</html>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -