Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Class ModuleDescription

AttachmentColor

Color for Attachments. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
AttachmentFontFont for Attachments. 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.
AttributeFontFont for local, non-key attributes. 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.
CompleteRoleNameDetermines whether you want to display complete role names (true) or not (false). DATATYPE: Boolean.
DataSecurityColorColor for Data Security. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
DataSecurityFontFont for Data Security. 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.
DefinitionSubmodel definition property. DATATYPE: String.
DiagramBackgroundColorColor for the background of the submodel. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityBackgroundColorColor for the background of the entity. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityDimTypeLabelColorColor for Entity Dimension Type Label. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityDimTypeLabelFontFont for Entity Dimension Type Label. 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.
EntityDisplayFormatDisplay format of Entities in the submodel. Valid values are: Attributes = 1, Entities = 2, Primary Keys = 3, All Keys = 4, Definition = 5, Note = 6. DATATYPE: Integer.
EntityForegroundColorColor for the foreground of the entity. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityNameFontFont for the entity 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.
EntityTitleColorColor for the title of the entity. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ForeignKeyFontFont for foreign key attributes. 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.
ForeignNonKeyFontFont for foreign, non-key attributes. 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.
GridSpacingSpacing for grid points. DATATYPE: Double.
GridsPerLineNumber of grid points per line. DATATYPE: Integer.
GridUnitsUnit type for the grid measurement. Valid values are: Inches = 0, Centimeters = 1. DATATYPE: Integer.
GUIDGUID of the submodel as assigned by ER/Studio. Each submodel has a unique GUID. DATATYPE: String.
HorizontalScrollPositionHorizontal scroll bar position of the diagram display window. DATATYPE: Integer.
HorizontalViewSizeWidth of the diagram display window. DATATYPE: Integer.
IDID of the submodel as assigned by ER/Studio. Each submodel in a diagram has a unique ID. DATATYPE: Integer.
IndexColorColor for Indexes. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
IndexFontFont for Indexes. 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.
InheritedNonKeyColorColor for the foreign, non-key attributes. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
InheritedPrimaryKeyColorColor for foreign, primary key attributes. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second byte represents a green value (0-255), and the third byte represents a blue value (0-255).
InheritOptionDetermines whether the submodel inherits objects added to nested submodels. DATATYPE: Boolean.
IsActiveIndicates whether the submodel is the one currently displayed. DATATYPE: Boolean.
MainSubModelTells the user whether the currently displayed submodel is the main sub model (true) or not (false). DATATYPE: Boolean.
NameName of the submodel. DATATYPE: String.
NamingStandardsTemplateIdID of the NamingStandardsTemplate object bound to the submodel (if any). A user can bind a NamingStandardsTemplate to the submodel by assigning a particular NamingStandardsTemplateId to this property. DATATYPE: Integer.
NonInheritedNonKeyColorThis is the color Color for local, non-key attributes. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
NonInheritedPrimaryKeyColorThis is the color Color for local, primary key attributes. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
OffPageBackgroundColorThis is the color Color for the background of the off page. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
OffPageForegroundColorThis is the color Color for the foreground of the off page. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageBoundaryThis is the page Page boundary. DATATYPE: Integer.
PageForegroundColorThis is the color Color for the foreground of the page. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageNumberColorThis is the color Color for the number of the page. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageNumberFontThis is the font Font for the page numbers. Although this property , itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
PageOrientationThis is the page Page orientation. The possible Valid values are: Portrait = 1 - Portrait, Landscape = 2 - Landscape. DATATYPE: Integer.
PageSizeThis is the page Page size. DATATYPE: Integer.
ParentSubmodelIDID of the parent Submodel object if this Submodel is a child in a nested Submodel. DATATYPE: Integer.
PrimaryKeyFontThis is the font Font for the local, primary key font. Although this property , itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
RelationshipBusinessNameColorThis is the color Color for the relationship business name. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
RelationshipBusinessNameFontThis is the font Font for the relationship business name. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
RelationshipColorThis is the color Color for the relationships. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
RelationshipNameColorThis is the color Color for the relationship name. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
RelationshipNameFontThis is the font Font for the relationship name. Although this property , itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
SchemaObjDisplayFormatThis is the display Display format of Schema Objects in the submodel. The possible Valid values are: Name = 1 - Name, Definition = 2 - Definition. DATATYPE: Integer.
ShadowThis determines Determines whether shadows are drawn (true) or not (false). DATATYPE: Boolean.
ShadowColorThis is the color Color for the shadow of entities, views, etc. This property takes a 4-byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ShapeNameFontThis is the font Font for the shape name. Although this property , itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
ShapeTextFontThis is the font Font for the shape text. Although this property , itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
ShowAttributeNameThis determines Determines whether attribute's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowCardinalityThis determines Determines whether cardinality is displayed (true) or not (false). DATATYPE: Boolean.
ShowColumnNameThis determines Determines whether attribute's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAlternateKeyThis determines Determines whether entity's alternate keys are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentThis determines Determines whether entity's attachments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentValueThis determines Determines whether entity's attachment values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttributeBitmapThis determines Determines whether entity's attribute bitmaps are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityThis determines Determines whether entity's data security are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityValueThis determines Determines whether entity's data security values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataTypeThis determines Determines whether entity's data types are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionalTypeThis determines Determines whether entity's dimension type are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionAttributesThis determines Determines whether entity's dimension attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDomainThis determines Determines whether entity's domains are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityFactAttributesThis determines Determines whether entity's fact attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityIndexThis determines Determines whether entity's indexes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityInversionEntryThis determines Determines whether entity's inversion entries are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameThis determines Determines whether entity's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameCompartmentThis determines Determines whether entity name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNullOptionThis determines Determines whether entity's null options are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityOwnerThis determines Determines whether entity's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowGridThis determines Determines whether to show the grid (true) or not (false). DATATYPE: Boolean.
ShowRelationshipBusinessNameThis determines Determines whether relationship business names are displayed (true) or not (false). DATATYPE: Boolean.
ShowRelationshipNameThis determines Determines whether relationship names are displayed (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjRelationshipsThis determines Determines whether schema object relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjsThis determines Determines whether schema objects are displayed (true) or not (false). DATATYPE: Boolean.
ShowShapeNamesThis determines Determines whether shape names are displayed (true) or not (false). DATATYPE: Boolean.
ShowTableNameThis determines Determines whether entity's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowTriggerThis sets Sets the ShowTrigger flag. DATATYPE: Boolean.
ShowTriggerActionsThis determines Determines whether relationship trigger actions are displayed (true) or not (false). DATATYPE: Boolean.
ShowVerbsThis determines Determines whether verbs are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewNameCompartmentThis determines Determines whether view name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewOwnerThis determines Determines whether view's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewParentNameThis determines Determines whether view's parent name is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewRelationshipsThis determines Determines whether view relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowViewsThis determines Determines whether views are displayed (true) or not (false). DATATYPE: Boolean.
SnapToGridThis determines Determines whether to snap objects (entites, views, etc.) to the grid (true) or not (false). DATATYPE: Boolean.
StraightRelLineThis determines Determines whether straight relationship lines are drawn (true) or not (false). DATATYPE: Boolean.
TextBackgroundColorThis is the color for the background of the text object. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TextBlockBorderColorThis is the color for the border of the text object. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TextBlockFontThis is the font for the text object. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
TextForegroundColorThis is the color for the text in text objects. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockBackgroundColorThis is the color for the background of title blocks. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockBorderColorThis is the color for the border of the title block. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockFontThis is the font for the title block. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
TitleBlockTextColorThis is the color for the text of the title block. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TriggerColorThis is the color for Triggers. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TriggerFontThis is the font for Triggers. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
VerbFontThis is the font for the verb. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
VerbTextColorThis is the color for the verb. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
VerticalScrollPositionThis is the vertical scroll bar position of the diagram display window. DATATYPE: Integer.
VerticalViewSizeThis is the height of the diagram display window. DATATYPE: Integer.
ViewBackgroundColorThis is the color for the background of views. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewDisplayFormatThis is the display format of Views in the submodel. The possible values are: 1 - Attributes, 2 - Entities, 3 - Primary Keys, 4 - All Keys, 5 - Definition, 6 - Note. DATATYPE: Integer.
ViewFieldFontThis is the font for local, non-key view fields. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
ViewFieldTextColorThis is the color for the view field text. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewForegroundColorThis is the color for the foreground of views. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewNameFontThis is the font for the view name. Although this property, itself, is read only, the user can modify the font by setting the properties in the ERSFont object which is returned to the caller.
ViewRelationshipColorThis is the color for the view relationship. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewTitleColorThis is the color for the title text of views. This property takes a 4 byte integer where the first byte represents a red value (0-255), the second 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
WrapEntityNameThis determines whether entity names are wrapped (true) or not (false). DATATYPE: Boolean.
WrapViewNameThis determines whether view names are wrapped (true) or not (false). DATATYPE: Boolean.
ZoomFactorThis is the viewing zoom percentage of the submodel (ie, 50, 100, %200, etc.). DATATYPE: Integer.

...