DocumentGenerator

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > DocumentGeneratorオブジェクト >

DocumentGenerator

DocumentGeneratorオブジェクトはRepositoryのCreateDocumentGenerator()メソッドで得ることができます。このオブジェクトを通して、Enterprise Architectのドキュメント生成機能を利用できます。通常のドキュメント生成機能では対応できないような複雑なドキュメントの生成のために利用します。

 

 

属性

属性

型

R/W

説明

ObjectType

ObjectType

R

オブジェクトを識別するために利用します。

 

 

操作

属性

戻り値の型

説明

DocumentConnector

(int connectorID,

int nDepth,

string templateName)

bool

指定した接続の内容を出力します。

 

引数:

  • connectorId: int -対象の接続のIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

DocumentCustomData

(string XML,

int nDepth,

string templateName)

bool

渡した独自の内容を出力します。

 

引数:

  • XML: string - 出力する内容をXML形式の文字列で渡します。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

 

(参考:カスタムスクリプトとして利用できるスクリプトの例)

DocumentDiagram

(int diagramID,

int nDepth,

string templateName)

bool

指定したダイアグラムの内容を出力します。

 

引数:

  • diagramId: int - 対象のダイアグラムのIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

DocumentElement

(int elementID,

int nDepth,

string templateName)

bool

指定した要素の内容を出力します。

 

引数:

  • elementId: int - 対象の要素のIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

DocumentModelAuthor

(string name,

int nDepth,

string templateName)

bool

指定した作者の内容を出力します。

 

引数:

  • name: string - 作者の名前です。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

DocumentModelClient

(string name,

int nDepth,

string templateName)

bool

指定した顧客の内容を出力します。

 

引数:

  • name: string - 顧客の名前です。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string -  利用するテンプレート名を指定します。空欄にできます。

DocumentModelGlossary

(int id,

int nDepth,

string templateName)

bool

指定した用語の内容を出力します。

 

引数:

  • id: int - 対象の用語のIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string -  利用するテンプレート名を指定します。空欄にできます。

DocumentModelIssue

(int id,

int nDepth,

string templateName)

bool

指定したプロジェクトの問題点の内容を出力します。

 

引数:

  • id: int - 対象の問題点のIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

DocumentModelResource

(string name,

int nDepth,

string templateName)

bool

指定したリソースの内容を出力します。

 

引数:

  • name: string - リソースの名前です。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string -  利用するテンプレート名を指定します。空欄にできます。

DocumentModelRole

(string name,

int nDepth,

string templateName)

bool

指定した役割の内容を出力します。

 

引数:

  • name: string - 役割の名前です。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

DocumentModelTask

(int id,

int nDepth,

string templateName)

bool

指定したプロジェクトのタスクの内容を出力します。

 

引数:

  • id: int - 対象のタスクのIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string -  利用するテンプレート名を指定します。空欄にできます。

DocumentPackage

(int packageID,  

int nDepth,

string templateName)

bool

指定したパッケージの内容を出力します。

 

引数:

  • packageId: int - 対象のパッケージのIDです。
  • nDepth: int - 見出しレベル(段落番号)の深さを指定します。
  • templateName: string - 利用するテンプレート名を指定します。空欄にできます。

GetDocumentAsRTF()

string

ドキュメントの内容を(ファイルに保存するのではなく)RTF形式の文字列で返します。

GetProjectConstant

(string nameVal)

string

指定した名前に対応する、プロジェクトの定数の値を返します。

 

引数:

  • nameVal: string - プロジェクトの定数の名前を指定します。

GetLastError()

string

最後に発生したエラーの詳細情報です。

エラーが発生したときには例外が発生しますので、この操作を利用することはほとんどありません。

InsertBreak

(int breakType)

bool

現在の位置に指定した種類の改行を挿入します。

(参考:DocumentBreak 定数値)

 

引数:

  • breakType: int - 0 = 改ページ, 1 = 改セクション

InsertCoverPageDocument

(string name)

bool

現在の位置に、指定した表紙ページのテンプレートの内容を挿入します。

挿入前にスタイルシートの内容が適用されます。

 

引数:

  • name: string - 表紙のテンプレートの名前です。

InsertHyperlink

(string Name,

string URL)

bool

現在の位置にハイパーリンクを追加します。URLの内容に#BOOKMARKNAME 形式の文字列を含める場合、ドキュメント内のそのブックマークの位置を開きます。

(ビルド1400以降で利用可能)

 

引数:

  • Name: string - 現在の位置に挿入する、リンクの設定対象となる文字列
  • URL: staring - リンク先となる情報

InsertLinkedDocument

(string guid)

bool

現在の位置に、指定した要素の付属ドキュメントの内容を出力します。

注意:

付属ドキュメントは、ドキュメントのヘッダ・フッタの内容指定にも活用できます。これらの内容は、ドキュメントに最初に追加された付属ドキュメントの内容を、ドキュメント全体に適用します。

 

引数:

  • guid: string - 付属ドキュメントを持つ、対象の要素のGUIDです。

InsertTableOfContents()

bool

現在の位置に目次を挿入します。

InsertTeamReviewPost

(string path)

bool

指定したチームライブラリの投稿の内容を出力します。

 

引数:

  • path: string - 対象の投稿へのパスです。

InsertTemplate

(string templateName)

 

指定されたテンプレートの内容をそのままドキュメントに追加します。

 

引数:

  • templateName: string - 対象のテンプレートの名前を指定します。

InsertText

(string text,

string style)

bool

現在の位置に、指定した文字列を挿入します。

注意:

改行は追加されませんので、必要に応じて改行を追加してください。

 

引数:

  • text: string - 書き込む文字列です。
  • style: string - 文字列のスタイルを指定します。既定値はNormalです。

InsertTOCDocument

(string name)

bool

現在の位置に、指定した目次のテンプレートの内容を挿入します。

なお、スタイルシートを利用する場合には、テンプレートの挿入前に追加してください。

 

引数:

  • name: string - 目次のテンプレート名前です。

LoadDocument

(string fileName)

bool

現在生成しているファイルに、指定したファイルの内容を挿入します。

 

引数:

  • fileName: string - 挿入する対象の外部のファイルをフルパスで指定します。

NewDocument

(string templateName)

bool

ドキュメントの生成定義を開始します。他のメソッドを呼び出す前に、必ずこのメソッドを呼び出す必要があります。

 

引数:

  • templateName: string - 利用するテンプレート名を指定します。

ReplaceField

(string fieldname,

string fieldvalue)

bool

指定したフィールドの内容を、指定した文字列で置換します。

 

例:

ReplaceField ("Element.Alias","MyAlias")

注意:

もし、このメソッドを同じフィールドに対して複数回呼び出した場合には、最後に呼び出した内容が有効になります。

 

引数:

  • fieldname: string - 対象のフィールド名です。({} の括弧は含みません)
  • fieldvalue: string - フィールドに対して置換する文字列です。

SaveDocument

(string Filename,

int nDocType)

bool

作成したドキュメントをファイルに保存します。

(参考:DocumentType 定数値)

 

引数:

  • Filename: string - 対象のファイル名・パスです。
  • nDocType: int -  形式を指定します。 0 = RTF, 1 = HTML, 2 = PDF, 3 = DOCX

SetPageOrientation

(int pageOrientation)

bool

現在のページの印刷の向きを指定します。

(参考:DocumentPageOrientation 定数値)

 

引数:

  • pageOrientation: int - 向きを指定します。 0 = 縦向き, 1 = 横向き

SetProjectConstant

(string newNameVal,

string newValue)

bool

指定した内容を、プロジェクトの定数として追加します。指定した内容は開いているプロジェクトに保存されます。

 

引数:

  • newNameVal: string - 追加するプロジェクトの定数の名前です。
  • newValue : string - 追加するプロジェクトの定数の値です。

SetStyleSheetDocument

(string name)

bool

ドキュメントで利用するスタイルシートを指定します。他のテンプレートの挿入前に実行してください。「NewDocument」の実行前に呼び出すことも可能です。

 

引数:

  • name: string - スタイルシートの名前です。

SetSuppressProfile

(string name)

bool

ドキュメント出力時に、対象外とするセクションを指定します。事前に、ドキュメント生成ダイアログの「対象外のセクション」にて、定義を作成する必要があります。
(ビルド1500以降で利用可能)

 

引数:

  • name: string - 適用する対象外のセクション情報の定義名です。

 

 

参照: