DiagramObject

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > ダイアグラム >

DiagramObject

DiagramObjectはダイアグラム内の要素のIDと書式設定の情報を含むオブジェクトです。DiagramのDiagramObjectsコレクションから利用できます。

 

 

プロジェクト内の関係するテーブル: t_diagramobjects

 

 

属性

属性

R/W

説明

BackgroundColor

int

RW

要素の背景色です。

色の数値の指定方法は「色の値の指定」のページをご覧ください。

BorderColor

int

RW

要素の線の色です。

色の数値の指定方法は「色の値の指定」のページをご覧ください。

BorderLineWidth

int

RW

要素の線の幅です。

1から5までの値を指定できます。既定値は1です。不適切な値の場合には1が適用されます。

bottom

int

RW

要素の位置情報です。なお、Enterprise Architectのダイアグラム内の座標系は、左上が {0,0} になります。つまり、上下方向(Y軸)の値は常に負の値になります。

DiagramID

int

RW

関連するダイアグラムのIDです。

ElementDisplayMode

int

RW

要素の属性や操作の折り返し方法です。

1 = 常に全て表示

2 = 折り返す

3 = 省略する

不適切な値が指定された場合には、1が指定されたものと見なします。

ElementID

int

RW

元になる要素のElementIDです。

FeatureStereotypeToHide

string

RW

属性や操作のステレオタイプで、ダイアグラム内で非表示になるものを指定します。

FontBold

bool

RW

フォントが太字かどうかを示します。

FontColor

int

RW

フォントの色を示します。

色の数値の指定方法は「色の値の指定」のページをご覧ください。

FontItalic

bool

RW

フォントが斜体かどうかを示します。

FontName

string

RW

フォント名を示します。

FontSize

int

RW

フォントのサイズを示します。値を変更する場合、fontNameの設定が空の場合にはfontNameの指定も必要です。

FontUnderline

bool

RW

フォントに下線が表示されるかどうかを示します。

InstanceGUID

string

R

ダイアグラム内で一意なID (DUID) です。

InstanceID

int

R

現在のモデルでのインスタンスのIDです。

IsSelectable

bool

RW

ダイアグラム内で要素が選択可能かどうかを示します。

Left

int

RW

要素の位置情報です。

ObjectType

ObjectType

R

このオブジェクトの種類を区別するために利用できる値です。

Right

int

RW

要素の位置情報です。

Sequence

int

RW

ダイアグラム内における表示の順序を示します。

指定する場合には1以上の値を指定し、1が最前面になり、数値が大きくなるほど背面に配置されます。

ShowComposedDiagram

bool

RW

「区画の表示設定」ダイアログで設定可能な内容について、値の参照・設定が可能です。

ShowConstraints

bool

RW

ShowFormattedNotes

bool

RW

ShowFullyQualifiedTags

bool

RW

ShowInheritedAttributes

bool

RW

ShowInheritedConstraints

bool

RW

ShowInheritedOperations

bool

RW

ShowInheritedResponsibilities

bool

RW

ShowInheritedTags

bool

RW

ShowNotes

bool

RW

ShowPackageAttributes

bool

RW

ShowPackageOperations

bool

RW

ShowPortType

bool

RW

ShowPrivateAttributes

bool

RW

ShowPrivateOperations

bool

RW

ShowProtectedAttributes

bool

RW

ShowProtectedOperations

bool

RW

ShowPublicAttributes

bool

RW

ShowPublicOperations

bool

RW

ShowResponsibilities

bool

RW

ShowRunstates

bool

RW

ShowStructuredCompartments

bool

RW

ShowTags

bool

RW

Style

object

RW

オブジェクトに適用される書式設定です。この属性の文字列の具体的な内容および構成は非公開・サポート対象外です。

書式設定を変更する場合には、他の属性を利用してください。

TextAlign

int

RW

ノート要素など文字の位置を調整可能な要素について、文字の位置を指定します。

1 = 左寄せ

2 = 中央揃え

3 = 右寄せ

不適切な値が指定された場合には、1が指定されたものとみなします。

Top

int

RW

要素の位置情報です。Enterprise Architectのダイアグラム内の座標系は、左上を (0,0) とする2次元の領域になっています。そのため、Y軸方向の値は常に負になります。

 

 

操作

操作

戻り値の型

説明

GetLastError()

string

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

MoveElementToGridPosition

(string gridX,

string gridY)

bool

ダイアグラムをグリッド表示している場合に、要素を指定した位置のグリッドに移動します。

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

ResetFont()

void

フォントの設定を削除し、既定のフォントで表示します。

SetFontStyle

(string fontName,
int fontSize,
bool bold,
bool italic,
bool underline)

bool

フォントのスタイルを設定します。

SetStyleEx

(string Parameter,

string Value)

void

ダイアグラム内の要素についての追加の属性を設定します。利用非推奨です。

 

Update()

bool

既存の要素を変更した場合や新しい要素を追加した場合に更新するメソッドです。

Falseが返された場合にはGetLastErrorメソッドで詳細な情報を取得することができます。

 

 

色の値の指定

 

Style属性には、要素の色の情報の他、さまざまな情報が含まれています。要素の色を変更する場合に、この内容を直接変更することはお勧めしません。その代わりに、 SetStyleEx あるいは BackgroundColor, FontColor or BorderColor の属性を利用することをお勧めします。

 

Style属性には色の情報が次のような形で格納されています。

 

    BCol=n;BFol=n;LCol=n;LWth=n;

 

それぞれの項目は次の通りです:

 

それぞれの色は、色を数値で表現した値で設定します。例えば 赤=FF, 緑=FF00 青=FF0000 となります。

 

以下の例は、ダイアグラム内のすべての要素の背景色を赤(FF=255)に、文字色と境界線色を黄色(FFFF=65535)に設定しています。

 

foreach(EA.DiagramObject diagObj in diagram.DiagramObjects)

{

  diagObj.BackgroundColor=255;

  diagObj.FontColor=65535;

  diagObj.BorderColor=65535;

  diagObj.BorderLineWidth=1;

  diagObj.Update();

}

 

値として-1を指定すると、未指定の状態になります。