Public 成员函数
def	EnableCaption (cap)
	设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。更多...

def	GetCaptionOffset ()
	获取标题偏移值。更多...

def	GetCaptionPositionType ()
	获取标题的位置类型。更多...

def	GetEndPoint ()
	获取终点。更多...

def	GetLeaderLineExtensionLength ()
	获取引导线延伸的长度。更多...

def	GetLeaderLineLength ()
	获取引导线的长度。更多...

def	GetLeaderLineOffset ()
	获取引导线偏移的长度。更多...

def	GetLineEndStyle ()
	获取终点的线条结束样式。更多...

def	GetLineStartStyle ()
	获取起点的线条结束样式。更多...

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

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

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

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

def	GetMeasureUnitW (measure_type)
	获取用于测量的单位显示标签（Unicode字符串格式）。更多...

def	GetStartPoint ()
	获取起点。更多...

def	GetStyleFillColor ()
	Get fill color for ending styles. 更多...

def	HasCaption ()
	检查当前直线注释的内容是否应该在外观中复制为标题。更多...

def	SetCaptionOffset (offset)
	设置标题偏移值。更多...

def	SetCaptionPositionType (cap_position)
	设置标题的位置类型。更多...

def	SetEndPoint (point)
	设置终点。更多...

def	SetLeaderLineExtensionLength (extension_length)
	设置引导线延伸的长度。更多...

def	SetLeaderLineLength (length)
	设置引导线的长度。更多...

def	SetLeaderLineOffset (offset)
	设置引导线偏移的长度。更多...

def	SetLineEndStyle (ending_style)
	设置终点的线条结束样式。更多...

def	SetLineStartStyle (ending_style)
	设置起点的线条结束样式。更多...

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

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

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

def	SetStartPoint (point)
	设置起点。更多...

def	SetStyleFillColor (color)
	设置结束样式的填充颜色。更多...

详细描述

直线注释在页面上显示一条直线。
直线注释是一种标记注释，所以类Line 派生自类Markup ，并且还提供了获取/设置直线注释属性和重置直线注释外观流的函数。
对于直线注释，需要起点和终点。因此，在重置其外观流之前，请确保直线注释具有有效的起点和终点；否则直线注释无法重置外观流。

注解: 对于新创建的直线注释，如果用户在设置必需的起点和终点属性后直接调用函数 fsdk.Annot.ResetAppearanceStream 而不设置任何其他属性，将使用默认外观：
边框宽度 = 2.0，边框样式 = fsdk.BorderInfoE_Solid ，边框颜色 = 0xFFFF0000（红色），不透明度 = 1，直线起始/结束样式 = "None"，未启用标题。

参见: Markup

成员函数说明

◆ EnableCaption()

def fsdk.Line.EnableCaption ( cap )

设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。

此属性对直线注释的外观有影响。如果用户希望效果在注释外观中显示，请在此函数后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in] cap true表示内容应该在当前直线注释的外观中复制为标题，而false表示不这样做。

返回: 无。

◆ GetCaptionOffset()

def fsdk.Line.GetCaptionOffset ( )

获取标题偏移值。

标题偏移是标题从其正常位置的偏移。
只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数fsdk.Line.HasCaption 可用于检查当前直线注释是否应该有标题，函数fsdk.Line.EnableCaption 可用于更改状态。

返回: 接收标题水平偏移和垂直偏移的Offset对象。
值为(0, 0)的Offset对象也可能意味着找不到标题偏移值。

◆ GetCaptionPositionType()

def fsdk.Line.GetCaptionPositionType ( )

获取标题的位置类型。

只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数fsdk.Line.HasCaption 可用于检查当前直线注释是否应该有标题，函数fsdk.Line.EnableCaption 可用于更改状态。

返回: 标题的位置类型。请参考从fsdk.LineE_CapPosInline 开始的值，这将是这些值中的一个。

◆ GetEndPoint()

def fsdk.Line.GetEndPoint ( )

获取终点。

直线注释需要起点和终点。它们对直线注释的外观有影响。

返回: 终点。值为(0, 0)的点也可能意味着找不到起点。

◆ GetLeaderLineExtensionLength()

def fsdk.Line.GetLeaderLineExtensionLength ( )

获取引导线延伸的长度。

引导线延伸从直线本身沿与引导线相对180度的方向延伸。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

返回: 引导线延伸的长度。

◆ GetLeaderLineLength()

def fsdk.Line.GetLeaderLineLength ( )

获取引导线的长度。

引导线从直线的每个端点垂直于直线本身延伸。正值表示引导线出现在从起点到终点遍历直线时顺时针方向；负值表示相反方向。特别地，即使引导线长度为0，直线注释仍然可以有引导线延伸和引导线偏移。在这种情况下，引导线的方向与正长度值相同，以便仍然可以判断引导线延伸和偏移的方向或位置。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

返回: 引导线的长度。

◆ GetLeaderLineOffset()

def fsdk.Line.GetLeaderLineOffset ( )

获取引导线偏移的长度。

引导线偏移是直线注释端点与引导线开始之间的空白间距。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

返回: 引导线偏移的长度。

◆ GetLineEndStyle()

def fsdk.Line.GetLineEndStyle ( )

获取终点的线条结束样式。

此属性对直线注释的外观有影响。

返回: 终点的线条结束样式。请参考从fsdk.MarkupE_EndingStyleNone 开始的值，这将是这些值中的一个。

◆ GetLineStartStyle()

def fsdk.Line.GetLineStartStyle ( )

获取起点的线条结束样式。

此属性对直线注释的外观有影响。

返回: 起点的线条结束样式。请参考从fsdk.MarkupE_EndingStyleNone 开始的值，这将是这些值中的一个。

◆ GetMeasureConversionFactor()

def fsdk.Line.GetMeasureConversionFactor ( measure_type )

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

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

参数

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

返回: 转换因子。

◆ GetMeasureRatio()

def fsdk.Line.GetMeasureRatio ( )

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

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

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

◆ GetMeasureRatioW()

def fsdk.Line.GetMeasureRatioW ( )

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

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

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

◆ GetMeasureUnit()

def fsdk.Line.GetMeasureUnit ( measure_type )

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

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

参数

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

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

◆ GetMeasureUnitW()

def fsdk.Line.GetMeasureUnitW ( measure_type )

获取用于测量的单位显示标签（Unicode字符串格式）。

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

参数

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

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

◆ GetStartPoint()

def fsdk.Line.GetStartPoint ( )

获取起点。

直线注释需要起点和终点。它们对直线注释的外观有影响。

返回: 起点。值为(0, 0)的点也可能意味着找不到起点。

◆ GetStyleFillColor()

def fsdk.Line.GetStyleFillColor ( )

Get fill color for ending styles.

This property has effect on line annotation's appearance. Fill color is used for some line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".

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

◆ HasCaption()

def fsdk.Line.HasCaption ( )

检查当前直线注释的内容是否应该在外观中复制为标题。

返回: true表示内容应该在当前直线注释的外观中复制为标题。 false表示不在当前直线注释的外观中复制内容为标题。

◆ SetCaptionOffset()

def fsdk.Line.SetCaptionOffset ( offset )

设置标题偏移值。

标题偏移是标题从其正常位置的偏移。
只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数fsdk.Line.HasCaption 可用于检查当前直线注释是否应该有标题，函数fsdk.Line.EnableCaption 可用于更改状态。
如果用户希望效果在注释外观中显示，请在此函数后调用函数 fsdk.Annot.ResetAppearanceStream 。

参数

[in] offset 新的偏移值。

返回: 无。

◆ SetCaptionPositionType()

def fsdk.Line.SetCaptionPositionType ( cap_position )

设置标题的位置类型。

只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数fsdk.Line.HasCaption 可用于检查当前直线注释是否应该有标题，函数fsdk.Line.EnableCaption 可用于更改状态。
如果用户希望效果在注释外观中显示，请在此函数后调用函数 fsdk.Annot.ResetAppearanceStream 。

参数

[in] cap_position 标题的位置类型。请参考从fsdk.LineE_CapPosInline 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetEndPoint()

def fsdk.Line.SetEndPoint ( point )

设置终点。

直线注释需要起点和终点。它们对直线注释的外观有影响。
如果用户希望新的终点对注释外观产生效果，请在设置新终点后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in] point 指定终点的新点。

返回: 无。

◆ SetLeaderLineExtensionLength()

def fsdk.Line.SetLeaderLineExtensionLength ( extension_length )

设置引导线延伸的长度。

引导线延伸从直线本身沿与引导线相对180度的方向延伸。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

参数

[in] extension_length 引导线延伸的长度。它应该是非负值。 0表示没有引导线延伸。

返回: 无。

◆ SetLeaderLineLength()

def fsdk.Line.SetLeaderLineLength ( length )

设置引导线的长度。

引导线从直线的每个端点垂直于直线本身延伸。正值表示引导线出现在从起点到终点遍历直线时顺时针方向；负值表示相反方向。特别地，即使引导线长度为0，直线注释仍然可以有引导线延伸和引导线偏移。在这种情况下，引导线的方向与正长度值相同，以便仍然可以判断引导线延伸和偏移的方向或位置。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

参数

[in] length 引导线的长度。有关更多详细信息，请参阅详细信息部分。 0表示没有引导线。

返回: 无。

◆ SetLeaderLineOffset()

def fsdk.Line.SetLeaderLineOffset ( offset )

设置引导线偏移的长度。

引导线偏移是直线注释端点与引导线开始之间的空白间距。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

参数

[in] offset 引导线偏移的长度。它应该是非负值。 0表示没有引导线延伸。

返回: None.

◆ SetLineEndStyle()

def fsdk.Line.SetLineEndStyle ( ending_style )

设置终点的线条结束样式。

此属性对直线注释的外观有影响。如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in] ending_style 要设置的终点线条结束样式。请参考从 fsdk.MarkupE_EndingStyleNone 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetLineStartStyle()

def fsdk.Line.SetLineStartStyle ( ending_style )

设置起点的线条结束样式。

此属性对直线注释的外观有影响。如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in] ending_style 要设置的起点线条结束样式。请参考从 fsdk.MarkupE_EndingStyleNone 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetMeasureConversionFactor()

def fsdk.Line.SetMeasureConversionFactor	(	measure_type,
		factor
	)

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

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

参数

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

返回: 无。

◆ SetMeasureRatio()

def fsdk.Line.SetMeasureRatio ( ratio )

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

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

参数

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

返回: 无。

◆ SetMeasureUnit()

def fsdk.Line.SetMeasureUnit	(	measure_type,
		unit
	)

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

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

参数

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

返回: 无。

◆ SetStartPoint()

def fsdk.Line.SetStartPoint ( point )

设置起点。

直线注释需要起点和终点。它们对直线注释的外观有影响。
如果用户希望新的起点对注释外观产生效果，请在设置新起点后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in] point 指定起点的新点。

返回: 无。

◆ SetStyleFillColor()

def fsdk.Line.SetStyleFillColor ( color )

设置结束样式的填充颜色。

此属性对直线注释的外观有影响。填充颜色用于某些线条结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。
如果用户希望新的填充颜色对注释外观产生效果，请在设置新填充颜色后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in] color 结束样式的新填充颜色。格式：0xRRGGBB。

返回: 无。

Public 成员函数

详细描述

成员函数说明

◆ EnableCaption()

◆ GetCaptionOffset()

◆ GetCaptionPositionType()

◆ GetEndPoint()

◆ GetLeaderLineExtensionLength()

◆ GetLeaderLineLength()

◆ GetLeaderLineOffset()

◆ GetLineEndStyle()

◆ GetLineStartStyle()

◆ GetMeasureConversionFactor()

◆ GetMeasureRatio()

◆ GetMeasureRatioW()

◆ GetMeasureUnit()

◆ GetMeasureUnitW()

◆ GetStartPoint()

◆ GetStyleFillColor()

◆ HasCaption()

◆ SetCaptionOffset()

◆ SetCaptionPositionType()

◆ SetEndPoint()

◆ SetLeaderLineExtensionLength()

◆ SetLeaderLineLength()

◆ SetLeaderLineOffset()

◆ SetLineEndStyle()

◆ SetLineStartStyle()

◆ SetMeasureConversionFactor()

◆ SetMeasureRatio()

◆ SetMeasureUnit()

◆ SetStartPoint()

◆ SetStyleFillColor()