Public Methods
This object represents an shape display object in ER/Studio. A shape display object is a graphical representation of a shape object in a specific submodel; it is not a shape object itself.
| Method | Description |
|---|
| ParentShape | Get the parent shape object of this shape display object. DATATYPE: Shape. |
| RepoCheckOutStatus | Get the Check Out status of this ShapeDisplay object. DATATYPE: StringObjects. |
| RepoVersionHistory | Get the Version History of this shape display object from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects. |
Public Properties
| Property | Description |
|---|
| BackgroundColor | Background color of the shape display object. It takes a 4-byte integer where the first byte represents red value (0-255), the second byte is the green value (0-255), and the third byte is the blue value (0-255). |
| DisplayBackgroundColor | Determines whether to use a custom background color just for this shape display object (true) or whether to use the default shape background color of the submodel (false). DATATYPE: Boolean. |
| FitShape | When enabled, fits the shape to the size of the text. |
| GUID | GUID of the shape display object as assigned by ER/Studio. Each shape display object has a unique GUID. DATATYPE: String. |
| HorizontalJustification | Sets the way in which text is justified horizontally. Valid values are: Left = 1, Center = 2, Right = 3. |
| HorizontalPosition | X coordinate of the shape display object. DATATYPE: Integer. |
| HorizontalSize | Width of the shape display object. DATATYPE: Integer. |
| ID | ID of the shape display object as assigned by ER/Studio. Each shape display object in a diagram has a unique ID. DATATYPE: Integer. |
| Name | Name of the shape object. DATATYPE: String. |
| NameColor | Color for the name. It takes a 4-byte integer where the first byte represents red value (0-255), the second byte is the green value (0-255), and the third byte is the blue value (0-255). |
| NameFont | Font for the name. Although this property is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller. |
| OutlineColor | OutlineColor of the shape display object. It takes a 4-byte integer where the first byte represents red value (0-255), the second byte is the green value (0-255), and the third byte is the blue value (0-255). |
| TextColor | Color for the text. It takes a 4-byte integer where the first byte represents red value (0-255), the second byte is the green value (0-255), and the third byte is the blue value (0-255). |
| TextFont | Font for the text. Although this property is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller. |
| VerticalJustification | Sets the way in which text is justified vertically. Valid values are: Top = 1, Center = 2, Bottom = 3. |
| VerticalPosition | Y coordinate of the shape display object. DATATYPE: Integer. |
| VerticalSize | Height of the shape display object. DATATYPE: Integer. |
| WrapText | When enabled, wraps the text to the size of the object. |
...