TextAnnotation

遗产: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation, com.aspose.pdf.MarkupAnnotation

public final class TextAnnotation extends MarkupAnnotation

表示文本注释,它是附加到 PDF 文档中某个点的“便利贴”。

构造函数

构造函数描述
TextAnnotation(IDocument document)在生成器中使用时的注释构造函数。
TextAnnotation(Page page, Rectangle rect)在指定页面上创建新的文本注释。
TextAnnotation()创建 TextAnnotation 实例

方法

方法描述
accept(AnnotationSelector visitor)接受访问者对象以处理注释。
changeAfterResize(Matrix transform)根据矩阵变换更新起点和终点。
createAnnotation(IPdfObject annotEngineObj, Page page)仅供内部使用
deepClone()克隆此实例。
equals(Object arg0)
flatten()直接在页面上放置注释内容,注释对象将被移除。
getActiveState()获取当前注释外观状态。
getAlignment()注释对齐。
getAnnotationType()获取注解类型。
getAppearance()获取注解的外观字典。
getBorder()获取注释边框特征。
getCharacteristics()获取注解特征。
getClass()
getColor()获取注释颜色。
getContents()获取注释文本。
getCreationDate()获取创建注释的日期和时间。
getEngineDict()仅限内部
getEngineObj()仅供内部使用
getFlags()获取注释的标志。
getFullName()获取注释的完整限定名称。
getHeight()获取注释的高度。
getHorizontalAlignment()获取段落的水平对齐方式
getHorizontalAlignment_Annotation_New()获取或设置注释的文本对齐方式。
getHyperlink()获取片段超链接(用于 pdf 生成器)。
getIcon()获取用于显示注释的图标。
getInReplyTo()对该注释“回复”的注释的引用。
getMargin()获取段落的外边距(用于生成 pdf)
getModified()获取最近修改注释的日期和时间。
getModifiedInternal()获取最近修改注释的日期和时间。
getName()获取页面上的注释名称。
getNormalAppearance()获得正常外观。
getOpacity()获取用于绘制注释的常量不透明度值。
getOpen()获取一个标志,该标志指定注释最初是否应显示为打开状态。
getPage()获取与此注释关联的页面对象。
getPageIndex()获取包含注释的页面索引。
getPageIndex(Annotation annotation)获取包含注释的页面索引。
getPdfActions()获取注释操作列表。
getPopup()用于输入或编辑与此注释关联的文本的弹出式注释。
getRect()获取注释矩形。
getRectangle(boolean considerRotation)返回考虑页面旋转的注释矩形。
getReplyType()一个字符串,指定此批注与 InReplyTo 指定的批注之间的关系(“回复类型”)。
getRichText()获取打开注释时在弹出窗口中显示的富文本字符串。
getState()获取应将原始注释设置到的状态。
getStateModel()获取状态模型
getStates()获取标注的外观字典。
getSubject()获取表示对象说明的文本。
getTextHorizontalAlignment()获取注释的文本对齐方式。
getTitle()获取应显示在注释标题栏中的文本。
getVerticalAlignment()获取段落的垂直对齐方式
getWidth()获取注释的宽度。
getZIndex()获取一个 int 值,该值指示图形的 Z 顺序。
hashCode()
initialize(IDocument doc)实例初始化
isFirstParagraphInColumn()获取或设置一个 bool 值,该值指示该段落是否位于下一列。
isInLineParagraph()获取一个段落是内联的。
isInNewPage()获取强制此段落在新页面生成的 bool 值。
isKeptWithNext()获取一个布尔值,该值指示当前段落是否与下一段保持在同一页面中。
isUpdateAppearanceOnConvert()如果为真,注释外观将在将 PF 文档转换为图像之前更新。
isUseFontSubset()如果此属性设置为 true,字体将作为子集添加到文档中。
notify()
notifyAll()
setActiveState(String value)设置当前注释外观状态。
setAlignment(int value)注释对齐。
setBorder(Border value)设置注释边框特征。
setColor(Color value)设置注释颜色。
setContents(String value)设置注释文本。
setFirstParagraphInColumn(boolean value)获取或设置一个 bool 值,该值指示该段落是否位于下一列。
setFlags(int value)设置注释的标志。
setHeight(double value)设置注释的高度。
setHorizontalAlignment(int value)设置段落的水平对齐方式
setHorizontalAlignment_Annotation_New(int value)获取或设置注释的文本对齐方式。
setHyperlink(Hyperlink value)设置超链接(用于 pdf 生成器)。
setIcon(int value)设置用于显示注释的图标。
setInLineParagraph(boolean value)设置一个段落是内联的。
setInNewPage(boolean value)设置一个布尔值,强制此段落在新页面生成。
setInReplyTo(Annotation value)对该注释“回复”的注释的引用。
setKeptWithNext(boolean value)设置一个布尔值,指示当前段落是否与下一段保持在同一页面中。
setMargin(MarginInfo value)设置段落的外边距(用于生成 pdf)
setModified(Date value)设置最近修改注释的日期和时间。
setModifiedInternal(System.DateTime value)设置最近修改注释的日期和时间。
setName(String value)在页面上设置注释名称。
setOpacity(double value)设置用于绘制注释的常量不透明度值。
setOpen(boolean value)设置一个标志,指定注释最初是否应该显示为打开状态。
setPopup(PopupAnnotation value)用于输入或编辑与此注释关联的文本的弹出式注释。
setRect(Rectangle value)设置注释矩形。
setReplyType(int value)一个字符串,指定此批注与 InReplyTo 指定的批注之间的关系(“回复类型”)。
setRichText(String value)设置打开注释时在弹出窗口中显示的富文本字符串。
setState(int value)设置应设置原始注释的状态。
setSubject(String value)设置表示对象描述的文本。
setTextHorizontalAlignment(int value)设置注释的文本对齐方式。
setTitle(String value)设置应显示在注释标题栏中的文本。
setUpdateAppearanceOnConvert(boolean value)如果为真,注释外观将在将 PF 文档转换为图像之前更新。
setUseFontSubset(boolean value)如果此属性设置为 true,字体将作为子集添加到文档中。
setVerticalAlignment(int value)设置段落的垂直对齐方式
setWidth(double value)设置注释的宽度。
setZIndex(int value)设置一个指示图形 Z 顺序的 int 值。
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

TextAnnotation(IDocument document)

public TextAnnotation(IDocument document)

在生成器中使用时的注释构造函数。

参数:

范围类型描述
documentIDocument将在其中创建文本注释的文档。

TextAnnotation(Page page, Rectangle rect)

public TextAnnotation(Page page, Rectangle rect)

在指定页面上创建新的文本注释。

参数:

范围类型描述
pagePage应在其中创建注释的文档页面。
rectRectangle注释矩形,定义注释在页面上的位置。

TextAnnotation()

public TextAnnotation()

创建 TextAnnotation 实例

accept(AnnotationSelector visitor)

public void accept(AnnotationSelector visitor)

接受访问者对象以处理注释。

参数:

范围类型描述
visitorAnnotationSelector访客对象。

changeAfterResize(Matrix transform)

public void changeAfterResize(Matrix transform)

根据矩阵变换更新起点和终点。

参数:

范围类型描述
transformMatrix指定转换的矩阵。

createAnnotation(IPdfObject annotEngineObj, Page page)

public static Annotation createAnnotation(IPdfObject annotEngineObj, Page page)

仅供内部使用

从描述注释的 PDF 对象初始化注释。

参数:

范围类型描述
annotEngineObjIPdfObject描述注释的 PDF 对象
pagePage页面对象

退货: Annotation 创建适当类型的注释对象

deepClone()

public Object deepClone()

克隆此实例。虚拟方法。始终返回空值。

退货: java.lang.Object - 空

equals(Object arg0)

public boolean equals(Object arg0)

参数:

范围类型描述
arg0java.lang.Object

退货: 布尔值

flatten()

public void flatten()

直接在页面上放置注释内容,注释对象将被移除。

getActiveState()

public String getActiveState()

获取当前注释外观状态。

退货: java.lang.String - 字符串值

getAlignment()

public int getAlignment()

注释对齐。此属性已过时。使用 getHorizontalAlignment_注解_New 代替。

退货: int - TextAlignment 元素

getAnnotationType()

public int getAnnotationType()

获取注解类型。

退货: int - AnnotationType 值

getAppearance()

public AppearanceDictionary getAppearance()

获取注解的外观字典。

退货: AppearanceDictionary AppearanceDictionary 对象

getBorder()

public Border getBorder()

获取注释边框特征。边界

退货: Border 边框对象

getCharacteristics()

public Characteristics getCharacteristics()

获取注解特征。

退货: Characteristics 特征对象

getClass()

public final native Class<?> getClass()

退货: java.lang.Class

getColor()

public Color getColor()

获取注释颜色。

退货: Color 颜色对象

getContents()

public String getContents()

获取注释文本。

退货: java.lang.String - 字符串值

getCreationDate()

public Date getCreationDate()

获取创建注释的日期和时间。

退货: Date - 日期对象

getEngineDict()

public IPdfDictionary getEngineDict()

仅限内部

退货: IPdfDictionary IPdfDictionary 对象

getEngineObj()

public IPdfObject getEngineObj()

仅供内部使用

退货: IPdfObject 内部项目

getFlags()

public int getFlags()

获取注释的标志。

退货: int - 注释的标志

getFullName()

public String getFullName()

获取注释的完整限定名称。

退货: java.lang.String - 字符串值

getHeight()

public double getHeight()

获取注释的高度。

退货: 注释的双倍高度

getHorizontalAlignment()

public int getHorizontalAlignment()

获取段落的水平对齐方式

退货: int - HorizontalAlignment 值

getHorizontalAlignment_Annotation_New()

public final int getHorizontalAlignment_Annotation_New()

获取或设置注释的文本对齐方式。

退货: int - 注释的文本对齐方式。

public Hyperlink getHyperlink()

获取片段超链接(用于 pdf 生成器)。

退货: Hyperlink - 片段超链接(用于 pdf 生成器)。

getIcon()

public int getIcon()

获取用于显示注释的图标。

退货: int - TextIcon 值

getInReplyTo()

public Annotation getInReplyTo()

对该注释“回复”的注释的引用。两个注释必须在文档的同一页上。

退货: Annotation - 注释值

getMargin()

public MarginInfo getMargin()

获取段落的外边距(用于生成 pdf)

退货: MarginInfo - 保证金信息值

getModified()

public Date getModified()

获取最近修改注释的日期和时间。

退货: Date 最近修改注释的日期和时间。

getModifiedInternal()

public System.DateTime getModifiedInternal()

获取最近修改注释的日期和时间。

退货: com.aspose.ms.System.DateTime - 日期时间对象

getName()

public String getName()

获取页面上的注释名称。

退货: java.lang.String - 字符串值

getNormalAppearance()

public XForm getNormalAppearance()

获得正常外观。

退货: XForm 变形对象

getOpacity()

public double getOpacity()

获取用于绘制注释的常量不透明度值。

退货: 双倍价值

getOpen()

public boolean getOpen()

获取一个标志,该标志指定注释最初是否应显示为打开状态。

退货: boolean - 布尔值

getPage()

public Page getPage()

获取与此注释关联的页面对象。

退货: Page 页面对象

getPageIndex()

public int getPageIndex()

获取包含注释的页面索引。

退货: int - 整数值

getPageIndex(Annotation annotation)

public int getPageIndex(Annotation annotation)

获取包含注释的页面索引。

参数:

范围类型描述
annotationAnnotation注释对象

退货: int - 整数值

getPdfActions()

public PdfActionCollection getPdfActions()

获取注释操作列表。

退货: PdfActionCollection PdfActionCollection 实例

getPopup()

public PopupAnnotation getPopup()

用于输入或编辑与此注释关联的文本的弹出式注释。

退货: PopupAnnotation PopupAnnotation 值

getRect()

public Rectangle getRect()

获取注释矩形。

退货: Rectangle - 矩形对象

getRectangle(boolean considerRotation)

public Rectangle getRectangle(boolean considerRotation)

返回考虑页面旋转的注释矩形。

参数:

范围类型描述
considerRotationboolean如果为真,则考虑页面旋转。

退货: Rectangle - 矩形对象

getReplyType()

public int getReplyType()

一个字符串,指定此批注与 InReplyTo 指定的批注之间的关系(“回复类型”)。

退货: int - 回复类型值

getRichText()

public String getRichText()

获取打开注释时在弹出窗口中显示的富文本字符串。

退货: java.lang.String - 字符串值

getState()

public int getState()

获取应将原始注释设置到的状态。

退货: int - AnnotationState 值

getStateModel()

public int getStateModel()

获取状态模型

退货: int - AnnotationStateModel 值

getStates()

public AppearanceDictionary getStates()

获取标注的外观字典。

退货: AppearanceDictionary AppearanceDictionary 对象

getSubject()

public String getSubject()

获取表示对象说明的文本。

退货: java.lang.String - 字符串值

getTextHorizontalAlignment()

public int getTextHorizontalAlignment()

获取注释的文本对齐方式。

退货: int - 注释的文本对齐方式。

getTitle()

public String getTitle()

获取应显示在注释标题栏中的文本。

退货: java.lang.String - 字符串值

getVerticalAlignment()

public int getVerticalAlignment()

获取段落的垂直对齐方式

退货: int - VerticalAlignment 元素

getWidth()

public double getWidth()

获取注释的宽度。

退货: double - double 值,注释的宽度。

getZIndex()

public int getZIndex()

获取一个 int 值,该值指示图形的 Z 顺序。具有较大 ZIndex 的图形将被放置在具有较小 ZIndex 的图形之上。 ZIndex 可以是负数。具有负 ZIndex 的图形将放置在页面中文本的后面。

退货: int - 整数值

hashCode()

public native int hashCode()

退货: 整数

initialize(IDocument doc)

public void initialize(IDocument doc)

实例初始化

参数:

范围类型描述
docIDocument文档对象

isFirstParagraphInColumn()

public boolean isFirstParagraphInColumn()

获取或设置一个 bool 值,该值指示该段落是否位于下一列。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isInLineParagraph()

public boolean isInLineParagraph()

获取一个段落是内联的。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isInNewPage()

public boolean isInNewPage()

获取强制此段落在新页面生成的 bool 值。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isKeptWithNext()

public boolean isKeptWithNext()

获取一个布尔值,该值指示当前段落是否与下一段保持在同一页面中。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isUpdateAppearanceOnConvert()

public static synchronized boolean isUpdateAppearanceOnConvert()

如果为真,注释外观将在将 PF 文档转换为图像之前更新。这允许正确转换字段,但可能需要更多时间。

退货: boolean - 布尔值

isUseFontSubset()

public static synchronized boolean isUseFontSubset()

如果此属性设置为 true,字体将作为子集添加到文档中。默认值为真。

退货: boolean - 布尔值

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setActiveState(String value)

public void setActiveState(String value)

设置当前注释外观状态。

参数:

范围类型描述
valuejava.lang.String字符串值

setAlignment(int value)

public void setAlignment(int value)

注释对齐。此属性已过时。使用 getHorizontalAlignment_注解_New 代替。

参数:

范围类型描述
valueintTextAlignment 元素

setBorder(Border value)

public void setBorder(Border value)

设置注释边框特征。边界

参数:

范围类型描述
valueBorder边界值

setColor(Color value)

public void setColor(Color value)

设置注释颜色。

参数:

范围类型描述
valueColor色值

setContents(String value)

public void setContents(String value)

设置注释文本。

参数:

范围类型描述
valuejava.lang.String字符串值

setFirstParagraphInColumn(boolean value)

public void setFirstParagraphInColumn(boolean value)

获取或设置一个 bool 值,该值指示该段落是否位于下一列。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setFlags(int value)

public void setFlags(int value)

设置注释的标志。

参数:

范围类型描述
valueint注释的标志

setHeight(double value)

public void setHeight(double value)

设置注释的高度。

参数:

范围类型描述
valuedouble注释的高度

setHorizontalAlignment(int value)

public void setHorizontalAlignment(int value)

设置段落的水平对齐方式

参数:

范围类型描述
valueintHorizontalAlignment 值

setHorizontalAlignment_Annotation_New(int value)

public final void setHorizontalAlignment_Annotation_New(int value)

获取或设置注释的文本对齐方式。

参数:

范围类型描述
valueint注释的文本对齐方式。
public void setHyperlink(Hyperlink value)

设置超链接(用于 pdf 生成器)。

参数:

范围类型描述
valueHyperlink超链接(用于 pdf 生成器)。

setIcon(int value)

public void setIcon(int value)

设置用于显示注释的图标。

参数:

范围类型描述
valueint文本图标值

setInLineParagraph(boolean value)

public void setInLineParagraph(boolean value)

设置一个段落是内联的。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setInNewPage(boolean value)

public void setInNewPage(boolean value)

设置一个布尔值,强制此段落在新页面生成。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setInReplyTo(Annotation value)

public void setInReplyTo(Annotation value)

对该注释“回复”的注释的引用。两个注释必须在文档的同一页上。

参数:

范围类型描述
valueAnnotation注释值

setKeptWithNext(boolean value)

public final void setKeptWithNext(boolean value)

设置一个布尔值,指示当前段落是否与下一段保持在同一页面中。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setMargin(MarginInfo value)

public void setMargin(MarginInfo value)

设置段落的外边距(用于生成 pdf)

参数:

范围类型描述
valueMarginInfoMarginInfo 对象

setModified(Date value)

public void setModified(Date value)

设置最近修改注释的日期和时间。

参数:

范围类型描述
valuejava.util.Date日期对象

setModifiedInternal(System.DateTime value)

public void setModifiedInternal(System.DateTime value)

设置最近修改注释的日期和时间。

参数:

范围类型描述
valuecom.aspose.ms.System.DateTime日期时间对象

setName(String value)

public void setName(String value)

在页面上设置注释名称。

参数:

范围类型描述
valuejava.lang.String字符串值

setOpacity(double value)

public void setOpacity(double value)

设置用于绘制注释的常量不透明度值。

参数:

范围类型描述
valuedouble双倍价值

setOpen(boolean value)

public void setOpen(boolean value)

设置一个标志,指定注释最初是否应该显示为打开状态。

参数:

范围类型描述
valueboolean布尔值

setPopup(PopupAnnotation value)

public void setPopup(PopupAnnotation value)

用于输入或编辑与此注释关联的文本的弹出式注释。

参数:

范围类型描述
valuePopupAnnotationPopupAnnotation值

setRect(Rectangle value)

public void setRect(Rectangle value)

设置注释矩形。

参数:

范围类型描述
valueRectangle矩形值

setReplyType(int value)

public void setReplyType(int value)

一个字符串,指定此批注与 InReplyTo 指定的批注之间的关系(“回复类型”)。

参数:

范围类型描述
valueint回复类型值

setRichText(String value)

public void setRichText(String value)

设置打开注释时在弹出窗口中显示的富文本字符串。

参数:

范围类型描述
valuejava.lang.String字符串值

setState(int value)

public void setState(int value)

设置应设置原始注释的状态。

参数:

范围类型描述
valueintAnnotationState值

setSubject(String value)

public void setSubject(String value)

设置表示对象描述的文本。

参数:

范围类型描述
valuejava.lang.String字符串值

setTextHorizontalAlignment(int value)

public void setTextHorizontalAlignment(int value)

设置注释的文本对齐方式。

参数:

范围类型描述
valueint注释的文本对齐方式。

setTitle(String value)

public void setTitle(String value)

设置应显示在注释标题栏中的文本。

参数:

范围类型描述
valuejava.lang.String字符串值

setUpdateAppearanceOnConvert(boolean value)

public static synchronized void setUpdateAppearanceOnConvert(boolean value)

如果为真,注释外观将在将 PF 文档转换为图像之前更新。这允许正确转换字段,但可能需要更多时间。

参数:

范围类型描述
valueboolean布尔值

setUseFontSubset(boolean value)

public static synchronized void setUseFontSubset(boolean value)

如果此属性设置为 true,字体将作为子集添加到文档中。默认值为真。

参数:

范围类型描述
valueboolean布尔值

setVerticalAlignment(int value)

public void setVerticalAlignment(int value)

设置段落的垂直对齐方式

参数:

范围类型描述
valueintVerticalAlignment 元素

setWidth(double value)

public void setWidth(double value)

设置注释的宽度。

参数:

范围类型描述
valuedouble注释的宽度。

setZIndex(int value)

public void setZIndex(int value)

设置一个指示图形 Z 顺序的 int 值。具有较大 ZIndex 的图形将被放置在具有较小 ZIndex 的图形之上。 ZIndex 可以是负数。具有负 ZIndex 的图形将放置在页面中文本的后面。

参数:

范围类型描述
valueint整数值

toString()

public String toString()

退货: java.lang.字符串

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

参数:

范围类型描述
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

参数:

范围类型描述
arg0long
arg1int