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

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,obj) は、指定された mlreportgen.dom.Text、mlreportgen.dom.Number、または mlreportgen.dom.CharEntity オブジェクトのリンク テキストを使用して、指定されたターゲットへのハイパーリンクを作成します。

例

入力引数

すべて展開する

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

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

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

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

プロパティ

すべて展開する

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

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

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

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

スタイルシート定義スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft® Word レポートでは、ドキュメント テンプレートで定義されていないスタイル名は無視されます。Microsoft Word テンプレートの詳細については、DOM API レポート プログラムのテンプレートを参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
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.*
d = Document('mydoc');

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

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

バージョン履歴

R2014b で導入

参考

クラス

トピック