mlreportgen.dom.LinkTarget クラス

名前空間: mlreportgen.dom

内部リンク、外部リンク、またはイメージ領域リンクのターゲット

このページをすべて展開する

説明

内部リンクと外部リンク、およびイメージ領域リンクに使用するターゲット。mlreportgen.dom.InternalLink または mlreportgen.dom.ImageArea オブジェクトを作成するときに、LinkTarget オブジェクトを指定することができます。

mlreportgen.dom.LinkTarget クラスは handle クラスです。

作成

説明

targetObj = LinkTarget(name) は、指定された名前でリンク ターゲットを作成します。

例

入力引数

すべて展開する

リンク ターゲットの名前。文字ベクトルまたは string スカラーとして指定します。

メモ

すべてのレポート タイプに有効なリンク ターゲット名を生成するには、mlreportgen.utils.normalizeLinkID を使用します。生成される名前は、ID の長さに関する Microsoft® Word の制限と、ID が英字で始まるという PDF の要件に準拠しています。

Word では、リンク ターゲット名のスペースがアンダースコア文字に置き換えられます。Word レポートのリンク ターゲット名にはスペースを使用しないでください。

外部リンクのリンク ターゲットを設定するには、次のようにします。

  • Word レポートでは、Word ブックマークを指定します。

  • HTML レポートでは、HTML の名前付きアンカーを指定します (たとえば、<a name="appendix"/>)。

プロパティ

すべて展開する

name 入力引数を参照してください。

styleName で指定するスタイルは、このリンク ターゲットを追加するドキュメント要素の作成に使用されるテンプレートで定義されていなければなりません。

データ型: char | string

このオブジェクトが PDF タイプの mlreportgen.dom.Document または mlreportgen.report.Report オブジェクト内にある mlreportgen.dom.XRef オブジェクトのターゲットであるかどうか。数値または logical の 1 (true) または 0 (false) として指定します。例については、Use Cross-Reference Elements in a PDF Reportを参照してください。

このドキュメント要素オブジェクトの書式指定。DOM 書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。このドキュメント要素オブジェクトに適用されない書式は無視されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

ドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

タグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。この値を使用すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

レポートの先頭でリンク ターゲットを定義し、そのターゲットへの内部リンクを追加します。

import mlreportgen.dom.*
import mlreportgen.utils.*
d = Document("mydoc","pdf");

p = Paragraph("This is my paragraph");
linkID = normalizeLinkID("home");
append(p,LinkTarget(linkID));
append(d,p);

p = Paragraph("This is another paragraph");
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,InternalLink(linkID,"Go to Top"));

close(d);
rptview(d);

バージョン履歴

R2014b で導入

すべて展開する

参考

| | | | |

トピック