fsdk.Square类 参考

Public 成员函数
def	GetFillColor ()
	获取填充颜色。 更多...
def	GetInnerRect ()
	获取内部矩形。 更多...
def	GetMeasureConversionFactor (measure_type)
	获取用于测量的转换因子。 更多...
def	GetMeasureRatio ()
	获取用于测量的比例比率字符串。 更多...
def	GetMeasureRatioW ()
	获取用于测量的比例比率 Unicode 字符串。 更多...
def	GetMeasureUnit (measure_type)
	获取用于显示测量单位的标签。 更多...
def	GetMeasureUnitW (measure_type)
	获取用于显示测量单位的标签。 更多...
def	SetFillColor (fill_color)
	设置填充颜色。 更多...
def	SetInnerRect (inner_rect)
	设置内部矩形。 更多...
def	SetMeasureConversionFactor (measure_type, factor)
	设置用于测量的转换因子。 更多...
def	SetMeasureRatio (ratio)
	设置用于测量的比例比率字符串。 更多...
def	SetMeasureUnit (measure_type, unit)
	设置用于显示测量单位的标签。 更多...

详细描述

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

注解

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

参见

Markup

成员函数说明

GetFillColor()

def fsdk.Square.GetFillColor

(

)

获取填充颜色。

返回

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

GetInnerRect()

def fsdk.Square.GetInnerRect

(

)

获取内部矩形。

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

返回

内部矩形。

GetMeasureConversionFactor()

def fsdk.Square.GetMeasureConversionFactor

(

measure_type

)

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

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

参数

[in]

measure_type

测量类型。请参考从 fsdk.MarkupE_MeasureTypeX 开始的值， 这将是这些值中的一个。

返回

转换因子。

GetMeasureRatio()

def fsdk.Square.GetMeasureRatio

(

)

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

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

返回

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

GetMeasureRatioW()

def fsdk.Square.GetMeasureRatioW

(

)

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

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

返回

表示比例比率的 Unicode 字符串。

GetMeasureUnit()

def fsdk.Square.GetMeasureUnit

(

measure_type

)

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

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

参数

[in]

measure_type

测量类型。请参考从 fsdk.MarkupE_MeasureTypeX 开始的值， 这应该是这些值中的一个。

返回

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

GetMeasureUnitW()

def fsdk.Square.GetMeasureUnitW

(

measure_type

)

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

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

参数

[in]

measure_type

测量类型。请参考从 fsdk.MarkupE_MeasureTypeX 开始的值， 这将是这些值中的一个。

返回

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

SetFillColor()

def fsdk.Square.SetFillColor

(

fill_color

)

设置填充颜色。

参数

[in]

fill_color

要设置的新填充颜色。格式：0xRRGGBB。

返回

无。

SetInnerRect()

def fsdk.Square.SetInnerRect

(

inner_rect

)

设置内部矩形。

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

参数

[in]

inner_rect

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

返回

无。

SetMeasureConversionFactor()

def fsdk.Square.SetMeasureConversionFactor	(		measure_type,
			factor
	)

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

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

参数

[in]	measure_type	测量类型。请参考从 fsdk.MarkupE_MeasureTypeX 开始的值， 这将是这些值中的一个。
[in]	factor	转换因子。

返回

无。

SetMeasureRatio()

def fsdk.Square.SetMeasureRatio

(

ratio

)

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

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

参数

[in]

ratio

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

返回

无。

SetMeasureUnit()

def fsdk.Square.SetMeasureUnit	(		measure_type,
			unit
	)

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

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

参数

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

返回

无。