AddCaretAnnotation

註解與熱點連結

Description

在所選頁面加入插入符標記註解（PDF /Subtype /Caret）。Caret 註解是一種視覺符號，慣例上用來標示頁面中插入、省略文字或內容，或需要審閱者注意的位置。提供兩種符號形狀：單純插入符（None）與段落號（Paragraph）。顏色成分與不透明度以 0–1 表示；Transparency 以 0–100 表示（0 = 完全不透明，100 = 完全透明）。在較低的最低版本鎖定下輸出 Caret 註解時，程式庫會把文件版本提升到 PDF 1.5。定義於 ISO 32000-1 §12.5.6.11

語法

Delphi

Function TPDFlib.AddCaretAnnotation(Left, Top, Width, Height: Double; SymbolType: Integer; ColorRed, ColorGreen, ColorBlue: Double; Const Title, Contents: WideString; Transparency: Integer): Integer;

參數

Left — 註解矩形左下角的水平座標，以目前單位計

Top — 註解矩形左下角的垂直座標，以目前單位計。

Width — 註解矩形的寬度。

Height — 註解矩形的高度

SymbolType — Caret 符號樣式：

0 = None (plain caret "^")

1 = 段落（段落號 "¶"）

其他任何值都視為 0（None）

ColorRed、ColorGreen、ColorBlue — 插入符顏色的 RGB 成分（0–1），寫入 /C

Title — 寫入註解 /T 項目的作者名稱。傳入空字串可略過。

Contents — 與註解關聯的彈出視窗內文。傳入空字串可略過

Transparency — 以百分比透明度表示（0–100）。程式庫會換算成 PDF /CA = 1 - Transparency/100 並夾限到有效範圍。

Return Value

成功傳回 1；若未選取任何文件或無法建立註解則傳回 0

Remarks

註解輸出時帶有 /Type /Annot、/Subtype /Caret、/Rect、/Sy（符號名稱）、/C、/CA、/F = 4（可列印）、/M、/CreationDate、/NM、/T、/Contents、/Subj = "Caret" 與 /P。選配的 /RD 欄位（插入符在 /Rect 內的偏移）不會輸出；閱讀器預設為全零，插入符因此佔滿整個註解矩形

若要在建立後覆寫註解的矩形、色彩或內容，請使用 SetAnnotRect、SetAnnotBorderColor 與 SetAnnotContents