类 foxit.pdf.annots.Square 继承关系图:

Public 成员函数
	Square ()
	构造函数。

	Square (Annot annot)
	构造函数，使用父类对象。更多...

int	GetFillColor ()
	获取填充颜色。更多...

RectF	GetInnerRect ()
	获取内部矩形。更多...

float	GetMeasureConversionFactor (Markup.MeasureType measure_type)
	获取用于测量的转换因子。更多...

string	GetMeasureRatio ()
	获取用于测量的比例比率字符串。更多...

string	GetMeasureRatioW ()
	获取用于测量的比例比率 Unicode 字符串。更多...

string	GetMeasureUnit (Markup.MeasureType measure_type)
	获取用于显示测量单位的标签。更多...

string	GetMeasureUnitW (Markup.MeasureType measure_type)
	获取用于显示测量单位的标签。更多...

void	SetFillColor (int fill_color)
	设置填充颜色。更多...

void	SetInnerRect (RectF inner_rect)
	设置内部矩形。更多...

void	SetMeasureConversionFactor (Markup.MeasureType measure_type, float factor)
	设置用于测量的转换因子。更多...

void	SetMeasureRatio (string ratio)
	设置用于测量的比例比率字符串。更多...

void	SetMeasureUnit (Markup.MeasureType measure_type, string unit)
	设置用于显示测量单位的标签。更多...

Public 成员函数继承自 foxit.pdf.annots.Markup
	Markup (Annot annot)
	构造函数，使用父类对象。更多...

	Markup ()
	构造函数

Note	AddReply ()
	在回复列表的末尾添加新回复。更多...

void	AddRichText (string content, RichTextStyle style)
	在末尾添加新的富文本字符串。更多...

Note	AddStateAnnot (string title, Markup.StateModel model, Markup.State state)
	添加新的状态注释。更多...

float	GetBorderOpacity ()
	获取注释的边框透明度。更多...

DateTime	GetCreationDateTime ()
	获取创建日期时间。更多...

float	GetFillOpacity ()
	获取注释的填充透明度。更多...

MarkupArray	GetGroupElements ()
	从当前标记注释所属的组中获取一个元素（作为标记注释）。更多...

Markup	GetGroupHeader ()
	获取当前标记注释所属组的头注释（作为主注释）。更多...

string	GetIntent ()
	获取意图名称。更多...

float	GetOpacity ()
	获取不透明度值。更多...

Popup	GetPopup ()
	获取相关的弹出注释。更多...

Note	GetReply (int index)
	按索引获取回复。更多...

int	GetReplyCount ()
	计算所有回复。更多...

string	GetRichTextContent (int index)
	获取指定索引的富文本字符串的文本字符串。更多...

int	GetRichTextCount ()
	获取富文本字符串的数量。更多...

RichTextStyle	GetRichTextStyle (int index)
	获取指定索引的富文本字符串的样式数据。更多...

NoteArray	GetStateAnnots (Markup.StateModel model)
	获取指定状态模型中的所有状态注释。更多...

string	GetSubject ()
	获取主题字符串。更多...

string	GetTitle ()
	获取标题字符串。更多...

void	InsertRichText (int index, string content, RichTextStyle style)
	在指定索引位置插入新的富文本字符串。更多...

bool	IsGrouped ()
	检查当前标记注释是否在组中。更多...

bool	RemoveAllReplies ()
	删除所有回复。更多...

bool	RemoveAllStateAnnots ()
	移除所有状态注释。更多...

bool	RemovePopup ()
	删除相关的弹出注释。更多...

bool	RemoveReply (int index)
	按索引删除回复。更多...

void	RemoveRichText (int index)
	移除指定索引的富文本字符串。更多...

void	SetBorderOpacity (float opacity)
	设置注释的边框透明度。更多...

void	SetCreationDateTime (DateTime date_time)
	设置创建日期时间。更多...

void	SetFillOpacity (float opacity)
	设置注释的填充透明度。更多...

void	SetIntent (string intent)
	设置意图名称。更多...

void	SetOpacity (float opacity)
	设置不透明度值。更多...

void	SetPopup (Popup popup)
	设置相关的弹出注释。更多...

void	SetRichTextContent (int index, string content)
	设置指定索引的富文本字符串的文本字符串。更多...

void	SetRichTextStyle (int index, RichTextStyle style)
	设置指定索引的富文本字符串的样式数据。更多...

void	SetSubject (string subject)
	设置主题字符串。更多...

void	SetTitle (string title)
	设置标题字符串。更多...

bool	Ungroup ()
	将当前标记注释从其所属的组中解组。更多...

Public 成员函数继承自 foxit.pdf.annots.Annot
	Annot (PDFPage page, PDFDictionary annot_dict)
	构造函数，使用PDF页面和注释的PDF字典。更多...

	Annot (Annot annot)
	构造函数，使用另一个注释对象。更多...

	Annot ()
	构造函数。

PDFStream	GetAppearanceStream (Annot.AppearanceType type, string appearance_state)
	获取具有指定类型和状态的注释外观流。更多...

int	GetBorderColor ()
	获取边框颜色。更多...

BorderInfo	GetBorderInfo ()
	获取边框信息。更多...

string	GetContent ()
	获取内容。更多...

RectI	GetDeviceRect (Matrix2D matrix)
	获取设备坐标系统中的注释矩形。更多...

PDFDictionary	GetDict ()
	获取注释的字典对象。更多...

Matrix2D	GetDisplayMatrix (Matrix2D page_display_matrix)
	获取显示矩阵，从到目标设备坐标系统。更多...

int	GetFlags ()
	获取注释标志。更多...

int	GetIndex ()
	获取当前注释在其所属页面中的索引。更多...

DateTime	GetModifiedDateTime ()
	获取最后修改日期时间。更多...

PDFDictionary	GetOptionalContent ()
	获取注释可选内容的PDF字典。更多...

PDFPage	GetPage ()
	获取相关的PDF页面。更多...

RectF	GetRect ()
	获取矩形，以表示。更多...

Annot.Type	GetType ()
	获取当前注释的实际注释类型。更多...

string	GetUniqueID ()
	获取唯一ID。更多...

bool	HasProperty (Annot.Property property)
	当前注释是否具有指定的注释属性。更多...

bool	IsEmpty ()
	检查当前对象是否为空。更多...

bool	IsMarkup ()
	检查当前注释是否为标记注释。更多...

bool	Move (RectF rect)
	将当前注释移动到新位置，由中的新矩形指定。更多...

bool	Move (RectF rect, bool is_reset_appearance)
	将当前注释移动到新位置，由中的新矩形指定。更多...

bool	RemoveProperty (Annot.Property property)
	删除指定的注释属性。更多...

bool	ResetAppearanceStream ()
	重置外观流。更多...

bool	ResetAppearanceStream (bool is_generate_new_appearance_obj)
	重置外观流。更多...

void	SetBorderColor (int color)
	设置边框颜色。更多...

void	SetBorderInfo (BorderInfo border)
	设置边框信息。更多...

void	SetContent (string content)
	设置内容。更多...

void	SetFlags (int flags)
	设置注释标志。更多...

void	SetModifiedDateTime (DateTime date_time)
	设置最后修改日期时间。更多...

void	SetUniqueID (string unique_id)
	设置唯一ID。更多...

额外继承的成员函数
Public 类型继承自 foxit.pdf.annots.Markup
enum	EndingStyle { EndingStyle.e_EndingStyleNone = 0, EndingStyle.e_EndingStyleSquare = 1, EndingStyle.e_EndingStyleCircle = 2, EndingStyle.e_EndingStyleDiamond = 3, EndingStyle.e_EndingStyleOpenArrow = 4, EndingStyle.e_EndingStyleClosedArrow = 5, EndingStyle.e_EndingStyleButt = 6, EndingStyle.e_EndingStyleROpenArrow = 7, EndingStyle.e_EndingStyleRClosedArrow = 8, EndingStyle.e_EndingStyleSlash = 9 }
	线条端点样式的枚举。更多...

enum	MeasureType { MeasureType.e_MeasureTypeX = 0, MeasureType.e_MeasureTypeY = 1, MeasureType.e_MeasureTypeD = 2, MeasureType.e_MeasureTypeA = 3, MeasureType.e_MeasureTypeT = 4, MeasureType.e_MeasureTypeS = 5 }
	注释测量类型的枚举。更多...

enum	State { State.e_StateNone = 0, State.e_StateMarked = 1, State.e_StateUnmarked = 2, State.e_StateAccepted = 3, State.e_StateRejected = 4, State.e_StateCancelled = 5, State.e_StateCompleted = 6, State.e_StateDeferred = 7, State.e_StateFuture = 8 }
	标记注释状态的枚举。更多...

enum	StateModel { StateModel.e_StateModelMarked = 1, StateModel.e_StateModelReview = 2 }
	标记注释状态模型的枚举。更多...

Public 类型继承自 foxit.pdf.annots.Annot
enum	AppearanceType { AppearanceType.e_AppearanceTypeNormal = 0, AppearanceType.e_AppearanceTypeRollover = 1, AppearanceType.e_AppearanceTypeDown = 2 }
	注释外观类型的枚举。更多...

enum	Flags { Flags.e_FlagInvisible = 0x0001, Flags.e_FlagHidden = 0x0002, Flags.e_FlagPrint = 0x0004, Flags.e_FlagNoZoom = 0x0008, Flags.e_FlagNoRotate = 0x0010, Flags.e_FlagNoView = 0x0020, Flags.e_FlagReadOnly = 0x0040, Flags.e_FlagLocked = 0x0080, Flags.e_FlagToggleNoView = 0x0100, Flags.e_FlagLockedContents = 0x0200 }
	PDF注释标志的枚举。更多...

enum	HighlightingMode { HighlightingMode.e_HighlightingNone = 0, HighlightingMode.e_HighlightingInvert = 1, HighlightingMode.e_HighlightingOutline = 2, HighlightingMode.e_HighlightingPush = 3, HighlightingMode.e_HighlightingToggle = 4 }
	PDF注释高亮模式的枚举。更多...

enum	MKEntry { MKEntry.e_MKEntryRotation = 0, MKEntry.e_MKEntryBorderColor = 1, MKEntry.e_MKEntryBackgroundColor = 2, MKEntry.e_MKEntryNormalCaption = 3, MKEntry.e_MKEntryRolloverCaption = 4, MKEntry.e_MKEntryDownCaption = 5, MKEntry.e_MKEntryNormalIcon = 6, MKEntry.e_MKEntryRolloverIcon = 7, MKEntry.e_MKEntryDownIcon = 8, MKEntry.e_MKEntryIconFit = 9, MKEntry.e_MKEntryIconCaptionRelation = 10 }
	注释MK字典（外观特征）条目的枚举。更多...

enum	MKIconCaptionRelation { MKIconCaptionRelation.e_MKRelationNoIcon = 0, MKIconCaptionRelation.e_MKRelationNoCaption = 1, MKIconCaptionRelation.e_MKRelationCaptionBelowIcon = 2, MKIconCaptionRelation.e_MKRelationCaptionAboveIcon = 3, MKIconCaptionRelation.e_MKRelationCaptionRight = 4, MKIconCaptionRelation.e_MKRelationCaptionLeft = 5, MKIconCaptionRelation.e_MKRelationCaptionOvrlayOnIcon = 6 }
	注释MK字典中图标和标题相对位置的枚举。更多...

enum	Property { Property.e_PropertyModifiedDate = 0, Property.e_PropertyCreationDate = 1, Property.e_PropertyBorderColor = 2, Property.e_PropertyFillColor = 3 }
	某些PDF注释属性的枚举。更多...

enum	Type { Type.e_UnknownType = 0, Type.e_Note = 1, Type.e_Link = 2, Type.e_FreeText = 3, Type.e_Line = 4, Type.e_Square = 5, Type.e_Circle = 6, Type.e_Polygon = 7, Type.e_PolyLine = 8, Type.e_Highlight = 9, Type.e_Underline = 10, Type.e_Squiggly = 11, Type.e_StrikeOut = 12, Type.e_Stamp = 13, Type.e_Caret = 14, Type.e_Ink = 15, Type.e_PSInk = 16, Type.e_FileAttachment = 17, Type.e_Sound = 18, Type.e_Movie = 19, Type.e_Widget = 20, Type.e_Screen = 21, Type.e_PrinterMark = 22, Type.e_TrapNet = 23, Type.e_Watermark = 24, Type.e_3D = 25, Type.e_Popup = 26, Type.e_Redact = 27, Type.e_RichMedia = 28, Type.e_PagingSeal = 29 }
	PDF注释类型的枚举。更多...

详细描述

方形注释是页面上的一个矩形。尽管名称为"方形"，方形注释可以表示方形或矩形，这意味着注释矩形的宽度和高度不需要相等。
方形注释是一种标记注释，所以类 Square 派生自类 Markup ，并且还提供了获取/设置方形注释属性和重置方形注释外观流的函数。

注解: 对于新创建的方形注释，如果用户在没有设置任何属性的情况下直接调用函数 Annot.ResetAppearanceStream ，将使用默认外观：
边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0，边框宽度 = 2.0，边框样式 = foxit.pdf.annots.BorderInfo.Style.e_Solid 。

参见: Markup

构造及析构函数说明

◆ Square()

foxit.pdf.annots.Square.Square ( Annot annot )

inline

构造函数，使用父类对象。

参数

[in] annot 父类对象。

成员函数说明

◆ GetFillColor()

int foxit.pdf.annots.Square.GetFillColor ( )

inline

获取填充颜色。

返回: 填充颜色。格式：0xRRGGBB。如果找不到填充颜色，将返回 0x000000。

◆ GetInnerRect()

RectF foxit.pdf.annots.Square.GetInnerRect ( )

inline

获取内部矩形。

对于方形注释，内部矩形表示底层圆形的实际边界。内部矩形可能与注释的矩形相同或小于注释的矩形，但永远不应大于注释的矩形。

返回: 内部矩形。

◆ GetMeasureConversionFactor()

float foxit.pdf.annots.Square.GetMeasureConversionFactor ( Markup.MeasureType measure_type )

inline

获取用于测量的转换因子。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] measure_type 测量类型。请参考从 foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX 开始的值，这将是这些值中的一个。

返回: 转换因子。

◆ GetMeasureRatio()

string foxit.pdf.annots.Square.GetMeasureRatio ( )

inline

获取用于测量的比例比率字符串。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。比例比率字符串表示该区域中绘图的比例比率。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回: 表示比例比率的 UTF-8 字节字符串。

◆ GetMeasureRatioW()

string foxit.pdf.annots.Square.GetMeasureRatioW ( )

inline

获取用于测量的比例比率 Unicode 字符串。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。比例比率字符串表示该区域中绘图的比例比率。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回: 表示比例比率的 Unicode 字符串。

◆ GetMeasureUnit()

string foxit.pdf.annots.Square.GetMeasureUnit ( Markup.MeasureType measure_type )

inline

获取用于显示测量单位的标签。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] measure_type 测量类型。请参考从 foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX 开始的值，这应该是这些值中的一个。

返回: 表示用于显示单位的标签的 UTF-8 文本字符串。

◆ GetMeasureUnitW()

string foxit.pdf.annots.Square.GetMeasureUnitW ( Markup.MeasureType measure_type )

inline

获取用于显示测量单位的标签。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] measure_type 测量类型。请参考从 foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX 开始的值，这将是这些值中的一个。

返回: 表示用于显示单位的标签的 Unicode 字符串。

◆ SetFillColor()

void foxit.pdf.annots.Square.SetFillColor ( int fill_color )

inline

设置填充颜色。

参数

[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。

返回: 无。

◆ SetInnerRect()

void foxit.pdf.annots.Square.SetInnerRect ( RectF inner_rect )

inline

设置内部矩形。

对于方形注释，内部矩形表示底层圆形的实际边界。内部矩形可能与注释的矩形相同或小于注释的矩形，但永远不应大于注释的矩形。

参数

[in] inner_rect 要设置的新内部矩形。它应该与注释的矩形相同或小于注释的矩形。

返回: 无。

◆ SetMeasureConversionFactor()

void foxit.pdf.annots.Square.SetMeasureConversionFactor	(	Markup.MeasureType	measure_type,
		float	factor
	)

inline

设置用于测量的转换因子。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]	measure_type	测量类型。请参考从 foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX 开始的值，这将是这些值中的一个。
[in]	factor	转换因子。

返回: 无。

◆ SetMeasureRatio()

void foxit.pdf.annots.Square.SetMeasureRatio ( string ratio )

inline

设置用于测量的比例比率字符串。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。比例比率字符串表示该区域中绘图的比例比率。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] ratio 表示比例比率的 UTF-8 字节字符串。字符串应该类似于："1/4 in = 1 ft"，表示默认用户空间中的 1/4 英寸等于实际测量中的 1 英尺。

返回: 无。

◆ SetMeasureUnit()

void foxit.pdf.annots.Square.SetMeasureUnit	(	Markup.MeasureType	measure_type,
		string	unit
	)

inline

设置用于显示测量单位的标签。

方形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]	measure_type	测量类型。请参考从 foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX 开始的值，这应该是这些值中的一个。
[in]	unit	指定用于显示单位的标签的 UTF-8 文本字符串。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ Square()

成员函数说明

◆ GetFillColor()

◆ GetInnerRect()

◆ GetMeasureConversionFactor()

◆ GetMeasureRatio()

◆ GetMeasureRatioW()

◆ GetMeasureUnit()

◆ GetMeasureUnitW()

◆ SetFillColor()

◆ SetInnerRect()

◆ SetMeasureConversionFactor()

◆ SetMeasureRatio()

◆ SetMeasureUnit()