fsdk.BorderInfo类 参考

Public 成员函数
def	GetCloud_intensity ()
	Get 云状效果的强度。 更多...
def	GetDash_phase ()
	Get 虚线相位。 更多...
def	GetDashes ()
	Get 表示虚线模式的虚线数组。 更多...
def	GetStyle ()
	Get 边框样式。请参考 fsdk.BorderInfoE_Solid 及相关值，应为这些值中的一个。 更多...
def	GetWidth ()
	Get 边框宽度，以点为单位。 更多...
def	Set (width, style, intensity, dash_phase, dashes)
	设置边框信息。 更多...
def	SetCloud_intensity (value)
	Set 云状效果的强度。 更多...
def	SetDash_phase (value)
	Set 虚线相位。 更多...
def	SetDashes (value)
	Set 表示虚线模式的虚线数组。 更多...
def	SetStyle (value)
	Set 边框样式。请参考 fsdk.BorderInfoE_Solid 及相关值，应为这些值中的一个。 更多...
def	SetWidth (value)
	Set 边框宽度，以点为单位。 更多...

详细描述

此类表示注释边框信息。

成员函数说明

GetCloud_intensity()

fsdk.BorderInfo.GetCloud_intensity

(

)

Get 云状效果的强度。

仅对自由文本、正方形、圆形和多边形注释有用，当前对象的 style 为 fsdk.BorderInfoE_Cloudy 时。
建议值范围：0 到 2。0 表示无云状边框效果。
其他值的效果为：

• 如果值小于 0，将与值 0 具有相同效果。

• 如果值大于 2，将与值 2 具有相同效果。

返回

云状效果的强度。

GetDash_phase()

fsdk.BorderInfo.GetDash_phase

(

)

Get 虚线相位。

仅在当前对象的 style 为 fsdk.BorderInfoE_Dashed 时有用。

返回

虚线相位。

GetDashes()

fsdk.BorderInfo.GetDashes

(

)

Get 表示虚线模式的虚线数组。

仅在当前对象的 style 为 fsdk.BorderInfoE_Dashed 时有用。
此数组中元素的值不应为负数。

返回

表示虚线模式的虚线数组。

GetStyle()

fsdk.BorderInfo.GetStyle

(

)

Get 边框样式。请参考 fsdk.BorderInfoE_Solid 及相关值，应为这些值中的一个。

返回

边框样式。请参考 fsdk.BorderInfoE_Solid 及相关值，应为这些值中的一个。

GetWidth()

fsdk.BorderInfo.GetWidth

(

)

Get 边框宽度，以点为单位。

此值不应为负数。如果此值为 0，则不会绘制边框。

返回

边框宽度，以点为单位。

Set()

def fsdk.BorderInfo.Set	(		width,
			style,
			intensity,
			dash_phase,
			dashes
	)

设置边框信息。

参数

[in]	width	边框宽度（单位：点）。应为非负值。为0时不绘制边框。
[in]	style	边框样式。请参考从fsdk.BorderInfoE_Solid 开始的值，这应该是这些值中的一个。
[in]	intensity	云状效果强度，仅当style为fsdk.BorderInfoE_Cloudy 时有效。有效范围0~2。 0表示无云状效果。小于0等同于0，大于2等同于2。
[in]	dash_phase	虚线起始相位，仅当style为fsdk.BorderInfoE_Dashed 时有效。
[in]	dashes	虚线数组，表示虚线模式。数组中每个元素都应为非负值，仅当style为fsdk.BorderInfoE_Dashed 时有效。

返回

无。

SetCloud_intensity()

fsdk.BorderInfo.SetCloud_intensity

(

value

)

Set 云状效果的强度。

仅对自由文本、正方形、圆形和多边形注释有用，当前对象的 style 为 fsdk.BorderInfoE_Cloudy 时。
建议值范围：0 到 2。0 表示无云状边框效果。
其他值的效果为：

• 如果值小于 0，将与值 0 具有相同效果。

• 如果值大于 2，将与值 2 具有相同效果。

参数

[in]

value

云状效果的强度。

返回

None.

SetDash_phase()

fsdk.BorderInfo.SetDash_phase

(

value

)

Set 虚线相位。

仅在当前对象的 style 为 fsdk.BorderInfoE_Dashed 时有用。

参数

[in]

value

虚线相位。

返回

None.

SetDashes()

fsdk.BorderInfo.SetDashes

(

value

)

Set 表示虚线模式的虚线数组。

仅在当前对象的 style 为 fsdk.BorderInfoE_Dashed 时有用。
此数组中元素的值不应为负数。

参数

[in]

value

表示虚线模式的虚线数组。

返回

None.

SetStyle()

fsdk.BorderInfo.SetStyle

(

value

)

Set 边框样式。请参考 fsdk.BorderInfoE_Solid 及相关值，应为这些值中的一个。

参数

[in]

value

边框样式。请参考 fsdk.BorderInfoE_Solid 及相关值，应为这些值中的一个。

返回

None.

SetWidth()

fsdk.BorderInfo.SetWidth

(

value

)

Set 边框宽度，以点为单位。

此值不应为负数。如果此值为 0，则不会绘制边框。

参数

[in]

value

边框宽度，以点为单位。

返回

None.