THPDFPage.AddGoToRStructureDestinationLink Method
外部 PDF 内の構造要素をその要素のバイト文字列 /ID でターゲットとする GoToR アクションを持つリンク注釈を追加し、リモートファイルに必要な /D フォールバックページ宛先を保持する
宣言
procedure AddGoToRStructureDestinationLink(Rectangle: TRect; const FileName: AnsiString;
const RemoteStructElemID: AnsiString; FallbackTargetPageIndex: Integer= 0;
YPos: Single= - 1; NewWindow: boolean= false; const Description: AnsiString= '');
ユニット
HPDFDoc
パラメータ
| 名前 | 目的 |
|---|---|
Rectangle | リンクがアクティブなページ単位のホットスポット矩形 |
FileName | 外部 PDF への空でないパス。バックスラッシュはフォワードスラッシュに正規化される |
RemoteStructElemID | 空でないバイト文字列の /ID。FileName 内の対象 StructElem を指し、その要素に付与された /ID と一致している必要があります(付与には IDStr オーバーロードを持つ AddStructureElement を使用します) |
FallbackTargetPageIndex | /D フォールバック宛先が使うリモートファイル内の必須の 0 始まりページインデックス。>= 0 でなければならない |
YPos | /XYZ フィット用の任意の垂直位置。負の値を渡すと null のままになる |
NewWindow | true の場合、ターゲットを新しいウィンドウで開くよう /NewWindow true を出力する |
Description | 注釈の /Contents に格納される代替説明。PDFUACompliance 下で必須 |
戻り値
このメンバーは値を返さない
動作
- PDF 2.0(ISO 32000-2)を要求し、
StrictVersionLockの動作に従う - リモートの構造ターゲットはポインタで外部の StructElem を参照できないため、ISO 32000-2 §12.3.2.3 は最初の
/SD要素をターゲット要素のバイト文字列/IDにすることを要求する。出力されるリテラル文字列形式は、同じIDStrに対してAddStructureElementが生成する/ID形式と一致する /F、必須の/Dフォールバック宛先、/SDバイト文字列配列を持つ GoToR アクションを出力する- 空の
FileName、空のRemoteStructElemID、負のFallbackTargetPageIndexは、注釈やバージョン追加が出力される前に例外を発生させる