Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::annots::Line类 参考
类 foxit::pdf::annots::Line 继承关系图:

## Public 类型
enum | CapPos { e_CapPosInline = 0, e_CapPosTop = 1 }
| 标题位置类型的枚举。 更多...
Public 类型 继承自 foxit::pdf::annots::Markup
enum | EndingStyle { e_EndingStyleNone = 0, e_EndingStyleSquare = 1, e_EndingStyleCircle = 2, e_EndingStyleDiamond = 3, e_EndingStyleOpenArrow = 4, e_EndingStyleClosedArrow = 5, e_EndingStyleButt = 6, e_EndingStyleROpenArrow = 7, e_EndingStyleRClosedArrow = 8, e_EndingStyleSlash = 9 }
| 线条端点样式的枚举。 更多...
enum | MeasureType { e_MeasureTypeX = 0, e_MeasureTypeY = 1, e_MeasureTypeD = 2, e_MeasureTypeA = 3, e_MeasureTypeT = 4, e_MeasureTypeS = 5 }
| 注释测量类型的枚举。 更多...
enum | State { e_StateNone = 0, e_StateMarked = 1, e_StateUnmarked = 2, e_StateAccepted = 3, e_StateRejected = 4, e_StateCancelled = 5, e_StateCompleted = 6, e_StateDeferred = 7, e_StateFuture = 8 }
| 标记注释状态的枚举。 更多...
enum | StateModel { e_StateModelMarked = 1, e_StateModelReview = 2 }
| 标记注释状态模型的枚举。 更多...
Public 类型 继承自 foxit::pdf::annots::Annot
enum | AppearanceType { e_AppearanceTypeNormal = 0, e_AppearanceTypeRollover = 1, e_AppearanceTypeDown = 2 }
| 注释外观类型的枚举。 更多...
enum | Flags { e_FlagInvisible = 0x0001, e_FlagHidden = 0x0002, e_FlagPrint = 0x0004, e_FlagNoZoom = 0x0008, e_FlagNoRotate = 0x0010, e_FlagNoView = 0x0020, e_FlagReadOnly = 0x0040, e_FlagLocked = 0x0080, e_FlagToggleNoView = 0x0100, e_FlagLockedContents = 0x0200 }
| PDF注释标志的枚举。 更多...
enum | HighlightingMode { e_HighlightingNone = 0, e_HighlightingInvert = 1, e_HighlightingOutline = 2, e_HighlightingPush = 3, e_HighlightingToggle = 4 }
| PDF注释高亮模式的枚举。 更多...
enum | MKEntry { e_MKEntryRotation = 0, e_MKEntryBorderColor = 1, e_MKEntryBackgroundColor = 2, e_MKEntryNormalCaption = 3, e_MKEntryRolloverCaption = 4, e_MKEntryDownCaption = 5, e_MKEntryNormalIcon = 6, e_MKEntryRolloverIcon = 7, e_MKEntryDownIcon = 8, e_MKEntryIconFit = 9, e_MKEntryIconCaptionRelation = 10 }
| 注释MK字典（外观特征）条目的枚举。 更多...
enum | MKIconCaptionRelation { e_MKRelationNoIcon = 0, e_MKRelationNoCaption = 1, e_MKRelationCaptionBelowIcon = 2, e_MKRelationCaptionAboveIcon = 3, e_MKRelationCaptionRight = 4, e_MKRelationCaptionLeft = 5, e_MKRelationCaptionOvrlayOnIcon = 6 }
| 注释MK字典中图标和标题相对位置的枚举。 更多...
enum | Property { e_PropertyModifiedDate = 0, e_PropertyCreationDate = 1, e_PropertyBorderColor = 2, e_PropertyFillColor = 3 }
| 某些PDF注释属性的枚举。 更多...
enum | Type { e_UnknownType = 0, e_Note = 1, e_Link = 2, e_FreeText = 3, e_Line = 4, e_Square = 5, e_Circle = 6, e_Polygon = 7, e_PolyLine = 8, e_Highlight = 9, e_Underline = 10, e_Squiggly = 11, e_StrikeOut = 12, e_Stamp = 13, e_Caret = 14, e_Ink = 15, e_PSInk = 16, e_FileAttachment = 17, e_Sound = 18, e_Movie = 19, e_Widget = 20, e_Screen = 21, e_PrinterMark = 22, e_TrapNet = 23, e_Watermark = 24, e_3D = 25, e_Popup = 26, e_Redact = 27, e_RichMedia = 28, e_PagingSeal = 29 }
| PDF注释类型的枚举。 更多...

## Public 成员函数
| Line ()
| 构造函数。
| Line (const Annot &annot)
| 构造函数，使用父类对象。 更多...
| ~Line ()
| 析构函数。
void | EnableCaption (bool cap)
| 设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。 更多...
Offset | GetCaptionOffset () const
| 获取标题偏移值。 更多...
CapPos | GetCaptionPositionType () const
| 获取标题的位置类型。 更多...
PointF | GetEndPoint () const
| 获取终点。 更多...
float | GetLeaderLineExtensionLength () const
| 获取引导线延伸的长度。 更多...
float | GetLeaderLineLength () const
| 获取引导线的长度。 更多...
float | GetLeaderLineOffset () const
| 获取引导线偏移的长度。 更多...
EndingStyle | GetLineEndStyle () const
| 获取终点的线条结束样式。 更多...
EndingStyle | GetLineStartStyle () const
| 获取起点的线条结束样式。 更多...
float | GetMeasureConversionFactor (MeasureType measure_type)
| 获取用于测量的转换因子。 更多...
String | GetMeasureRatio ()
| 获取用于测量的比例比率字符串。 更多...
WString | GetMeasureRatioW ()
| 获取用于测量的比例比率Unicode字符串。 更多...
String | GetMeasureUnit (MeasureType measure_type)
| 获取用于测量的单位显示标签。 更多...
WString | GetMeasureUnitW (MeasureType measure_type)
| 获取用于测量的单位显示标签（Unicode字符串格式）。 更多...
PointF | GetStartPoint () const
| 获取起点。 更多...
RGB | GetStyleFillColor () const
| Get fill color for ending styles. 更多...
bool | HasCaption () const
| 检查当前直线注释的内容是否应该在外观中复制为标题。 更多...
void | SetCaptionOffset (const Offset &offset)
| 设置标题偏移值。 更多...
void | SetCaptionPositionType (CapPos cap_position)
| 设置标题的位置类型。 更多...
void | SetEndPoint (const PointF &point)
| 设置终点。 更多...
void | SetLeaderLineExtensionLength (float extension_length)
| 设置引导线延伸的长度。 更多...
void | SetLeaderLineLength (float length)
| 设置引导线的长度。 更多...
void | SetLeaderLineOffset (float offset)
| 设置引导线偏移的长度。 更多...
void | SetLineEndStyle (EndingStyle ending_style)
| 设置终点的线条结束样式。 更多...
void | SetLineStartStyle (EndingStyle ending_style)
| 设置起点的线条结束样式。 更多...
void | SetMeasureConversionFactor (MeasureType measure_type, float factor)
| 设置用于测量的转换因子。 更多...
void | SetMeasureRatio (const String &ratio)
| 设置用于测量的比例比率字符串。 更多...
void | SetMeasureUnit (MeasureType measure_type, const String &unit)
| 设置用于测量的单位显示标签。 更多...
void | SetStartPoint (const PointF &point)
| 设置起点。 更多...
void | SetStyleFillColor (RGB color)
| 设置结束样式的填充颜色。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Markup
| Markup (const Annot &annot)
| 构造函数，使用父类对象。 更多...
| Markup ()
| 构造函数
| ~Markup ()
| 析构函数。
Note | AddReply ()
| 在回复列表的末尾添加新回复。 更多...
void | AddRichText (const WString &content, const RichTextStyle &style)
| 在末尾添加新的富文本字符串。 更多...
Note | AddStateAnnot (const WString &title, StateModel model, State state)
| 添加新的状态注释。 更多...
float | GetBorderOpacity () const
| 获取注释的边框透明度。 更多...
DateTime | GetCreationDateTime () const
| 获取创建日期时间。 更多...
float | GetFillOpacity () const
| 获取注释的填充透明度。 更多...
MarkupArray | GetGroupElements ()
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多...
Markup | GetGroupHeader ()
| 获取当前标记注释所属组的头注释（作为主注释）。 更多...
String | GetIntent () const
| 获取意图名称。 更多...
float | GetOpacity () const
| 获取不透明度值。 更多...
Popup | GetPopup ()
| 获取相关的弹出注释。 更多...
Note | GetReply (int index) const
| 按索引获取回复。 更多...
int | GetReplyCount ()
| 计算所有回复。 更多...
WString | GetRichTextContent (int32 index)
| 获取指定索引的富文本字符串的文本字符串。 更多...
int32 | GetRichTextCount ()
| 获取富文本字符串的数量。 更多...
RichTextStyle | GetRichTextStyle (int32 index)
| 获取指定索引的富文本字符串的样式数据。 更多...
NoteArray | GetStateAnnots (StateModel model)
| 获取指定状态模型中的所有状态注释。 更多...
WString | GetSubject () const
| 获取主题字符串。 更多...
WString | GetTitle () const
| 获取标题字符串。 更多...
void | InsertRichText (int32 index, const WString &content, const RichTextStyle &style)
| 在指定索引位置插入新的富文本字符串。 更多...
bool | IsGrouped ()
| 检查当前标记注释是否在组中。 更多...
bool | RemoveAllReplies ()
| 删除所有回复。 更多...
bool | RemoveAllStateAnnots ()
| 移除所有状态注释。 更多...
bool | RemovePopup ()
| 删除相关的弹出注释。 更多...
bool | RemoveReply (int index)
| 按索引删除回复。 更多...
void | RemoveRichText (int index)
| 移除指定索引的富文本字符串。 更多...
void | SetBorderOpacity (float opacity)
| 设置注释的边框透明度。 更多...
void | SetCreationDateTime (const DateTime &date_time)
| 设置创建日期时间。 更多...
void | SetFillOpacity (float opacity)
| 设置注释的填充透明度。 更多...
void | SetIntent (const String &intent)
| 设置意图名称。 更多...
void | SetOpacity (float opacity)
| 设置不透明度值。 更多...
void | SetPopup (const Popup &popup)
| 设置相关的弹出注释。 更多...
void | SetRichTextContent (int32 index, const WString &content)
| 设置指定索引的富文本字符串的文本字符串。 更多...
void | SetRichTextStyle (int32 index, const RichTextStyle &style)
| 设置指定索引的富文本字符串的样式数据。 更多...
void | SetSubject (const WString &subject)
| 设置主题字符串。 更多...
void | SetTitle (const WString &title)
| 设置标题字符串。 更多...
bool | Ungroup ()
| 将当前标记注释从其所属的组中解组。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Annot
| Annot (const PDFPage &page, objects::PDFDictionary *annot_dict)
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
| Annot (const Annot &annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot ()
| 构造函数。
virtual | ~Annot ()
| 析构函数。
objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const
| 获取具有指定类型和状态的注释外观流。 更多...
RGB | GetBorderColor () const
| 获取边框颜色。 更多...
BorderInfo | GetBorderInfo () const
| 获取边框信息。 更多...
WString | GetContent () const
| 获取内容。 更多...
RectI | GetDeviceRect (const Matrix &matrix)
| 获取设备坐标系统中的注释矩形。 更多...
objects::PDFDictionary * | GetDict () const
| 获取注释的字典对象。 更多...
Matrix | GetDisplayMatrix (const Matrix &page_display_matrix)
| 获取显示矩阵，从PDF坐标系统到 目标设备坐标系统。 更多...
uint32 | GetFlags () const
| 获取注释标志。 更多...
int | GetIndex () const
| 获取当前注释在其所属页面中的索引。 更多...
DateTime | GetModifiedDateTime () const
| 获取最后修改日期时间。 更多...
objects::PDFDictionary * | GetOptionalContent () const
| 获取注释可选内容的PDF字典。 更多...
PDFPage | GetPage () const
| 获取相关的PDF页面。 更多...
RectF | GetRect () const
| 获取矩形，以PDF坐标系统表示。 更多...
Type | GetType () const
| 获取当前注释的实际注释类型。 更多...
WString | GetUniqueID () const
| 获取唯一ID。 更多...
bool | HasProperty (Property property) const
| 当前注释是否具有指定的注释属性。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsMarkup () const
| 检查当前注释是否为标记注释。 更多...
bool | Move (const RectF &rect)
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多...
bool | Move (const RectF &rect, bool is_reset_appearance)
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多...
bool | operator != (const Annot &other) const
| 不等于运算符。 更多...
Annot & | operator= (const Annot &annot)
| 赋值运算符。 更多...
bool | operator== (const Annot &other) const
| 等于运算符。 更多...
bool | RemoveProperty (Property property)
| 删除指定的注释属性。 更多...
bool | ResetAppearanceStream ()
| 重置外观流。 更多...
bool | ResetAppearanceStream (bool is_generate_new_appearance_obj)
| 重置外观流。 更多...
void | SetBorderColor (RGB color)
| 设置边框颜色。 更多...
void | SetBorderInfo (const BorderInfo &border)
| 设置边框信息。 更多...
void | SetContent (const WString &content)
| 设置内容。 更多...
void | SetFlags (uint32 flags)
| 设置注释标志。 更多...
void | SetModifiedDateTime (const DateTime &date_time)
| 设置最后修改日期时间。 更多...
void | SetUniqueID (const WString &unique_id)
| 设置唯一ID。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

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

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

参见
  Markup

## 成员枚举类型说明

## ◆ CapPos

enum foxit::pdf::annots::Line::CapPos

标题位置类型的枚举。

此枚举的值应单独使用。

枚举值
e_CapPosInline | 标题应居中于线条内
e_CapPosTop | 标题应在线条上方

## 构造及析构函数说明

## ◆ Line()

foxit::pdf::annots::Line::Line | ( | const Annot & | annot | ) |
| explicit

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

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ EnableCaption()

void foxit::pdf::annots::Line::EnableCaption | ( | bool | cap | ) |

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

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

参数

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

返回
  无。

## ◆ GetCaptionOffset()

Offset foxit::pdf::annots::Line::GetCaptionOffset | ( |  | ) | const

获取标题偏移值。

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

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

## ◆ GetCaptionPositionType()

CapPos foxit::pdf::annots::Line::GetCaptionPositionType | ( |  | ) | const

获取标题的位置类型。

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

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

## ◆ GetEndPoint()

PointF foxit::pdf::annots::Line::GetEndPoint | ( |  | ) | const

获取终点。

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

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

## ◆ GetLeaderLineExtensionLength()

float foxit::pdf::annots::Line::GetLeaderLineExtensionLength | ( |  | ) | const

获取引导线延伸的长度。

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

返回
  引导线延伸的长度。

## ◆ GetLeaderLineLength()

float foxit::pdf::annots::Line::GetLeaderLineLength | ( |  | ) | const

获取引导线的长度。

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

返回
  引导线的长度。

## ◆ GetLeaderLineOffset()

float foxit::pdf::annots::Line::GetLeaderLineOffset | ( |  | ) | const

获取引导线偏移的长度。

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

返回
  引导线偏移的长度。

## ◆ GetLineEndStyle()

EndingStyle foxit::pdf::annots::Line::GetLineEndStyle | ( |  | ) | const

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

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

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

## ◆ GetLineStartStyle()

EndingStyle foxit::pdf::annots::Line::GetLineStartStyle | ( |  | ) | const

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

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

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

## ◆ GetMeasureConversionFactor()

float foxit::pdf::annots::Line::GetMeasureConversionFactor | ( | MeasureType | measure_type | ) |

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

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

参数

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

返回
  转换因子。

## ◆ GetMeasureRatio()

String foxit::pdf::annots::Line::GetMeasureRatio | ( |  | ) |

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

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

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

## ◆ GetMeasureRatioW()

WString foxit::pdf::annots::Line::GetMeasureRatioW | ( |  | ) |

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

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

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

## ◆ GetMeasureUnit()

String foxit::pdf::annots::Line::GetMeasureUnit | ( | MeasureType | measure_type | ) |

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

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

参数

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

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

## ◆ GetMeasureUnitW()

WString foxit::pdf::annots::Line::GetMeasureUnitW | ( | MeasureType | measure_type | ) |

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

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

参数

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

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

## ◆ GetStartPoint()

PointF foxit::pdf::annots::Line::GetStartPoint | ( |  | ) | const

获取起点。

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

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

## ◆ GetStyleFillColor()

RGB foxit::pdf::annots::Line::GetStyleFillColor | ( |  | ) | const

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()

bool foxit::pdf::annots::Line::HasCaption | ( |  | ) | const

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

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

## ◆ SetCaptionOffset()

void foxit::pdf::annots::Line::SetCaptionOffset | ( | const Offset & | offset | ) |

设置标题偏移值。

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

参数

  [in] | offset | 新的偏移值。

返回
  无。

## ◆ SetCaptionPositionType()

void foxit::pdf::annots::Line::SetCaptionPositionType | ( | CapPos | cap_position | ) |

设置标题的位置类型。

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

参数

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

返回
  无。

## ◆ SetEndPoint()

void foxit::pdf::annots::Line::SetEndPoint | ( | const PointF & | point | ) |

设置终点。

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

参数

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

返回
  无。

## ◆ SetLeaderLineExtensionLength()

void foxit::pdf::annots::Line::SetLeaderLineExtensionLength | ( | float | extension_length | ) |

设置引导线延伸的长度。

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

参数

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

返回
  无。

## ◆ SetLeaderLineLength()

void foxit::pdf::annots::Line::SetLeaderLineLength | ( | float | length | ) |

设置引导线的长度。

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

参数

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

返回
  无。

## ◆ SetLeaderLineOffset()

void foxit::pdf::annots::Line::SetLeaderLineOffset | ( | float | offset | ) |

设置引导线偏移的长度。

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

参数

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

返回
  None.

## ◆ SetLineEndStyle()

void foxit::pdf::annots::Line::SetLineEndStyle | ( | EndingStyle | ending_style | ) |

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

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

参数

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

返回
  无。

## ◆ SetLineStartStyle()

void foxit::pdf::annots::Line::SetLineStartStyle | ( | EndingStyle | ending_style | ) |

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

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

参数

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

返回
  无。

## ◆ SetMeasureConversionFactor()

void foxit::pdf::annots::Line::SetMeasureConversionFactor | ( | MeasureType | measure_type,
|  | float | factor
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetMeasureRatio()

void foxit::pdf::annots::Line::SetMeasureRatio | ( | const String & | ratio | ) |

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

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

参数

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

返回
  无。

## ◆ SetMeasureUnit()

void foxit::pdf::annots::Line::SetMeasureUnit | ( | MeasureType | measure_type,
|  | const String & | unit
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetStartPoint()

void foxit::pdf::annots::Line::SetStartPoint | ( | const PointF & | point | ) |

设置起点。

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

参数

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

返回
  无。

## ◆ SetStyleFillColor()

void foxit::pdf::annots::Line::SetStyleFillColor | ( | RGB | color | ) |

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

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

参数

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

返回
  无。