birichedit.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 79 行

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>

<class name="BiRichEdit" extends="BiIframe">

	<description>
		This control is used to to provide rich text editing of HTML documents
	</description>

	<arguments/>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="execCommand">
			<description>
				Executes a command on the rich text editor.
				For a list of supported commands see
				<link href="http://msdn.microsoft.com/workshop/author/dhtml/reference/commandids.asp">MSDN</link>.
				The method returns <code>true</code> if the command was successful.
			</description>
			<arguments>
				<argument name="sCommand" type="String" description="The command to execute"/>
				<argument name="bUi" type="Boolean" description="Whether to show a dialog where extra arguments can be entered"
					optional="true" default="false"/>
				<argument name="oCommandValue" type="Object" description="Some commands takes an argument. In those cases this argument is used"
					optional="true"/>
			</arguments>
			<returns type="Boolean"/>
		</method>
		<method name="queryCommandValue">
			<description>
				Returns the current value for the given command.
			</description>
			<arguments>
				<argument name="sCommand" type="String" description="The command to get the value for"/>
			</arguments>
			<returns type="Object"/>
		</method>
		<method name="queryCommandState">
			<description>
				Returns a boolean value that represents the state of the given command.
			</description>
			<arguments>
				<argument name="sCommand" type="String" description="The command to get the state for"/>
			</arguments>
			<returns type="Boolean"/>
		</method>
		<method name="queryCommandEnabled">
			<description>
				Returns a boolean value that tells whether the given command will succeed if executed.
			</description>
			<arguments>
				<argument name="sCommand" type="String" description="The command to get check whether enabled"/>
			</arguments>
			<returns type="Boolean"/>
		</method>
	</methods>

	<properties>
		<property name="contentHtml" set="true" get="true" type="String">
			<description>
				The HTML code inside the rich editor frame. This does not include
				the doctype nor any comments outside the root element.
			</description>
		</property>
	</properties>

	<events/>

	<remarks>
		Do not confuse the command methods with the <link class="BiCommand">Bindows command</link>
		concept. The command methods are used to change the content of the
		editor.
	</remarks>

</class>