Versions Compared

Key

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

...

Class ModuleDescription

AttachmentColor

This is the color Color for Attachments. 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).
AttachmentFontThis is the font Font for Attachments. 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.
AttributeFontThis is the font Font for local, non-key attributes. 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.
CompleteRoleNameThis determines whether Determines whether you want to display complete role names are displayed (true) or not (false). DATATYPE: Boolean.
DataSecurityColorThis is the color Color for Data Security. 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).
DataSecurityFontThis is the font Font for Data Security. 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.
DefinitionThis is the submodel Submodel definition property. DATATYPE: String.
DiagramBackgroundColorThis is the color Color 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 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityBackgroundColorThis is the color Color 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 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityDimTypeLabelColorThis is the color Color for Entity Dimension Type Label. 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).
EntityDimTypeLabelFontThis is the font Font for Entity Dimension Type Label. 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.
EntityDisplayFormatThis is the display Display format of Entities in the submodel. The possible Valid values are: Attributes = 1 - Attributes, Entities = 2 - Entities, 3 - Primary Keys = 3, 4 - All Keys = 4, Definition = 5 - Definition, Note = 6 - Note. DATATYPE: Integer.
EntityForegroundColorThis is the color 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 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityNameFontThis is the font for the entity 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.
EntityTitleColorThis is the color 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 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ForeignKeyFontThis is the font for foreign key attributes. 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.
ForeignNonKeyFontThis is the font for foreign, non-key attributes. 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.
GridSpacingThis is the spacing for grid points. DATATYPE: Double.
GridsPerLineThis is the number of grid points per line. DATATYPE: Integer.
GridUnitsThis is the unit type for the grid measurement. The possible values are: 0 - Inches, 1 - Centimeters. DATATYPE: Integer.
GUIDGUID of the submodel. This GUID is assigned by ER/Studio. Each submodel has a unique GUID. DATATYPE: String.
HorizontalScrollPositionThis is the horizontal scroll bar position of the diagram display window. DATATYPE: Integer.
HorizontalViewSizeThis is the width of the diagram display window. DATATYPE: Integer.
IDID of the submodel. This ID is assigned by ER/Studio. Each submodel in a diagram has a unique ID. DATATYPE: Integer.
IndexColorThis is the color for Indexes. 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).
IndexFontThis is the font for Indexes. 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.
InheritedNonKeyColorThis is the color 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 8 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
InheritedPrimaryKeyColorThis is the color for foreign, 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).
InheritOptionThis determines if the submodel will inherit objects added to nested submodels. DATATYPE: Boolean.
IsActiveThis indicates if the submodel is the one currently displayed. DATATYPE: Boolean.
MainSubModelThis tells the user whether the currently displayed submodel is the main sub model (true) or not (false). DATATYPE: Boolean.
NameThis is the name 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 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 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 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 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 boundary. DATATYPE: Integer.
PageForegroundColorThis is the 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 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 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 orientation. The possible values are: 1 - Portrait, 2 - Landscape. DATATYPE: Integer.
PageSizeThis is the 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 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 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 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 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 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 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 format of Schema Objects in the submodel. The possible values are: 1 - Name, 2 - Definition. DATATYPE: Integer.
ShadowThis determines whether shadows are drawn (true) or not (false). DATATYPE: Boolean.
ShadowColorThis is the 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 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 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 whether attribute's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowCardinalityThis determines whether cardinality is displayed (true) or not (false). DATATYPE: Boolean.
ShowColumnNameThis determines whether attribute's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAlternateKeyThis determines whether entity's alternate keys are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentThis determines whether entity's attachments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentValueThis determines whether entity's attachment values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttributeBitmapThis determines whether entity's attribute bitmaps are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityThis determines whether entity's data security are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityValueThis determines whether entity's data security values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataTypeThis determines whether entity's data types are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionalTypeThis determines whether entity's dimension type are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionAttributesThis determines whether entity's dimension attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDomainThis determines whether entity's domains are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityFactAttributesThis determines whether entity's fact attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityIndexThis determines whether entity's indexes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityInversionEntryThis determines whether entity's inversion entries are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameThis determines whether entity's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameCompartmentThis determines whether entity name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNullOptionThis determines whether entity's null options are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityOwnerThis determines whether entity's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowGridThis determines whether to show the grid (true) or not (false). DATATYPE: Boolean.
ShowRelationshipBusinessNameThis determines whether relationship business names are displayed (true) or not (false). DATATYPE: Boolean.
ShowRelationshipNameThis determines whether relationship names are displayed (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjRelationshipsThis determines whether schema object relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjsThis determines whether schema objects are displayed (true) or not (false). DATATYPE: Boolean.
ShowShapeNamesThis determines whether shape names are displayed (true) or not (false). DATATYPE: Boolean.
ShowTableNameThis determines whether entity's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowTriggerThis sets the ShowTrigger flag. DATATYPE: Boolean.
ShowTriggerActionsThis determines whether relationship trigger actions are displayed (true) or not (false). DATATYPE: Boolean.
ShowVerbsThis determines whether verbs are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewNameCompartmentThis determines whether view name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewOwnerThis determines whether view's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewParentNameThis determines whether view's parent name is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewRelationshipsThis determines whether view relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowViewsThis determines whether views are displayed (true) or not (false). DATATYPE: Boolean.
SnapToGridThis determines whether to snap objects (entites, views, etc.) to the grid (true) or not (false). DATATYPE: Boolean.
StraightRelLineThis 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.

...