📄 wpcomments.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0) on Fri Feb 29 09:23:16 CST 2008 -->
<META http-equiv="Content-Type" content="text/html; charset=GB2312">
<TITLE>
WpComments (永中集成Office二次开发API文档)
</TITLE>
<META NAME="date" CONTENT="2008-02-29">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WpComments (永中集成Office二次开发API文档)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="跳过导航链接"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>概述</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>软件包</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>类</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>树</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>索引</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>帮助</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../application/workbooks/workbook/documents/document/WordCount.html" title="application.workbooks.workbook.documents.document 中的类"><B>上一个类</B></A>
<A HREF="../../../../../application/workbooks/workbook/documents/document/WpPageSetup.html" title="application.workbooks.workbook.documents.document 中的类"><B>下一个类</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?application/workbooks/workbook/documents/document/WpComments.html" target="_top"><B>框架</B></A>
<A HREF="WpComments.html" target="_top"><B>无框架</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>所有类</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>所有类</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
摘要： 嵌套 | 字段 | 构造方法 | <A HREF="#method_summary">方法</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
详细信息： 字段 | 构造方法 | <A HREF="#method_detail">方法</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
application.workbooks.workbook.documents.document</FONT>
<BR>
类 WpComments</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="继承者 "><B>application.workbooks.workbook.documents.document.WpComments</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>WpComments</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
批注管理器，用于管理批注的插入、删除等。 <p> <p>
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>方法摘要</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#deleteComment(long, long)">deleteComment</A></B>(long offset,
long length)</CODE>
<BR>
删除指定区域内的所有批注。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#editComment(long)">editComment</A></B>(long offset)</CODE>
<BR>
批注进入编辑状态。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../application/workbooks/workbook/style/comment/Comment.html" title="application.workbooks.workbook.style.comment 中的类">Comment</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#getAllComments()">getAllComments</A></B>()</CODE>
<BR>
获得所有的批注对象。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../application/workbooks/workbook/style/comment/Comment.html" title="application.workbooks.workbook.style.comment 中的类">Comment</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#getComment(long)">getComment</A></B>(long offset)</CODE>
<BR>
返回指定偏移量的批注</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#getCount()">getCount</A></B>()</CODE>
<BR>
获取批注对象在系统表中的个数。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../application/workbooks/workbook/style/comment/Comment.html" title="application.workbooks.workbook.style.comment 中的类">Comment</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#insertComment(long, long)">insertComment</A></B>(long offset,
long length)</CODE>
<BR>
插入批注。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../application/workbooks/workbook/style/comment/Comment.html" title="application.workbooks.workbook.style.comment 中的类">Comment</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#next(long)">next</A></B>(long offset)</CODE>
<BR>
光标移动到下一个批注。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../application/workbooks/workbook/style/comment/Comment.html" title="application.workbooks.workbook.style.comment 中的类">Comment</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#previous(long)">previous</A></B>(long offset)</CODE>
<BR>
光标移动到上一个批注。</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>从类 java.lang.Object 继承的方法</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>方法详细信息</B></FONT></TH>
</TR>
</TABLE>
<A NAME="deleteComment(long, long)"><!-- --></A><H3>
deleteComment</H3>
<PRE>
public void <B>deleteComment</B>(long offset,
long length)</PRE>
<DL>
<DD>删除指定区域内的所有批注。如果某个批注的起始位置或终止位置包含在指定区域内，那么这个批注不会被删除。 只有批注的起始位置和终止位置都包含在指定的区域内，批注才会被删除。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>offset</CODE> - 批注的起始位置<DD><CODE>length</CODE> - 指定长度 <p> <b>例子:</b> <pre> Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument(); BaseText text = doc.getSection(0).getBaseText(); text.insertText(0,"this is a test!"); WpComments comments = doc.getComments(); Comment comment1 = comments.insert(0,3); comment1.setText("批注信息1"); Comment comment2 = comments.insert(4,3); comment2.setText("批注信息2"); comments.deleteComment(0,8); </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 指定的offset小于0或大于文档长度
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当length小于0或offset + length 大于文档长度<DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/documents/document/WpComments.html#insertComment(long, long)"><CODE>insertComment(long, long)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="editComment(long)"><!-- --></A><H3>
editComment</H3>
<PRE>
public void <B>editComment</B>(long offset)</PRE>
<DL>
<DD>批注进入编辑状态。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>offset</CODE> - 批注的起始位置 <p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -