Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

mlreportgen.dom.ExternalLink クラス

名前空間: mlreportgen.dom

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

説明

ドキュメント外の場所へのハイパーリンクを定義します。

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

作成

説明

externalLinkObj = ExternalLink(target,linkText) は、指定されたリンク テキストをもつ、指定されたターゲットへのハイパーリンクを作成します。このコンストラクターは、リンク テキストを保持する text オブジェクト (mlreportgen.dom.Text) を作成します。

externalLinkObj = ExternalLink(target,linkText,linkTextStyleName) は、指定されたリンク テキストとスタイル名でハイパーリンクを作成します。

externalLinkObj = ExternalLink(target,textObj) は、指定された Text オブジェクトを使用して、指定されたターゲットへのハイパーリンクを作成します。

入力引数

すべて展開する

外部リンクのリンク ターゲット。文字ベクトル (URL の場合) または mlreportgen.dom.LinkTarget オブジェクトとして指定します。

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

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

リンク テキストを含む text オブジェクト。mlreportgen.dom.Text オブジェクトで指定します。

プロパティ

すべて展開する

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

このドキュメント要素の ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

ドキュメント要素の書式を指定する書式オブジェクト。

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

このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

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

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

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

メモ

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

データ型: string | char

メソッド

すべて展開する

すべて折りたたむ

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

append(d,ExternalLink('https://www.mathworks.com/','MathWorks'));

close(d);
rptview(d.OutputPath);

バージョン履歴

R2014b で導入