Main Content

mlreportgen.dom.InternalLink クラス

名前空間: mlreportgen.dom

同一ドキュメント内の場所へのハイパーリンク

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

説明

このハイパーリンクが含まれる同一ドキュメント内の場所へのハイパーリンク。この種のリンクは、ドキュメント内での内部ナビゲーションを提供するために使用します。

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

作成

説明

internalLinkObj = InternalLink(targetName,linkText) は、指定されたリンク ターゲット オブジェクトへのハイパーリンクを作成するとともに、指定されたリンク テキストを使用します。

internalLinkObj = InternalLink(targetName,linkText,linkTextStyleName) は、指定されたリンク ターゲットへのハイパーリンクを作成するとともに、指定されたスタイル名をリンク テキストに使用します。

例

internalLinkObj = InternalLink(target,obj) は、指定された mlreportgen.dom.Text、mlreportgen.dom.Number、または mlreportgen.dom.CharEntity オブジェクトのリンク テストを使用して、指定されたターゲットへのハイパーリンクを作成します。

入力引数

すべて展開する

リンク ターゲットの名前。文字ベクトルとして指定します。文字ベクトルは、mlreportgen.dom.LinkTarget オブジェクトの Name プロパティの値、または URL です。

リンク テキストに使用するテキスト。

リンク テキストに使用するスタイル名。

外部ターゲットへのリンク テキストを含むオブジェクト。mlreportgen.dom.Text、mlreportgen.dom.Number、または mlreportgen.dom.CharEntity オブジェクトで指定します。

プロパティ

すべて展開する

mlreportgen.dom.InternalLink オブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。

属性:

SetAccess
private
NonCopyable
true

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

属性:

NonCopyable
true

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

属性:

NonCopyable
true

データ型: char | string

mlreportgen.dom.InternalLink オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

SetAccess
private
NonCopyable
true

テンプレートで定義されているリンク スタイルの名前。文字ベクトルとして指定します。styleName で指定するスタイルは、リンクが追加されるドキュメントの作成に使用されるテンプレートで定義されていなければなりません。

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

属性:

NonCopyable
true

データ型: cell

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

属性:

NonCopyable
true

データ型: char | string

この読み取り専用プロパティは、このハイパーリンクのリンク ターゲットを表示します。

ターゲットが開かれるウィンドウ。文字ベクトルまたは string スカラーとして指定します。

取り得る値は次のとおりです。

  • "samewindow" - (既定) 同じウィンドウでターゲットを開く

  • "newwindow" - 新しいウィンドウでターゲットを開く

メモ

このプロパティは、HTML 出力タイプのレポートにのみ適用されます。

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

mlreportgen.dom.LinkTarget オブジェクトを使用してリンク ターゲットを定義し、mlreportgen.dom.InternalLink オブジェクトを使用してリンクを定義することにより、同じドキュメント内のターゲットにリンクします。リンク ターゲットの名前によって、リンク ターゲットとのリンクが関連付けられます。すべてのレポート タイプに有効なリンク ターゲット名を生成するには、mlreportgen.utils.normalizeLinkID を使用します。

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

% Append a link target to a heading
h = Heading(1,'Author''s Biography');
h.Style = {PageBreakBefore(true)};
linkID = normalizeLinkID('bio');
append(h,LinkTarget(linkID));

% Link to the target
append(d,InternalLink(linkID,'About the Author'));

% Append the heading 
append(d,h);

close(d);
rptview(d);

バージョン履歴

R2014b で導入

参考

| | | | | |

トピック