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.
NonInheritedNonKeyColorColor for local, 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).
NonInheritedPrimaryKeyColorColor for local, 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).
OffPageBackgroundColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
OffPageForegroundColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageBoundaryPage boundary. DATATYPE: Integer.
PageForegroundColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageNumberColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageNumberFontFont for the page numbers. 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.
PageOrientationPage orientation. Valid values are: Portrait = 1, Landscape = 2. DATATYPE: Integer.
PageSizePage size. DATATYPE: Integer.
ParentSubmodelIDID of the parent Submodel object if this Submodel is a child in a nested Submodel. DATATYPE: Integer.
PrimaryKeyFontFont for the local, primary key font. 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.
RelationshipBusinessNameColorColor 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).
RelationshipBusinessNameFontFont 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.
RelationshipColorColor for the relationships. 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).
RelationshipNameColorColor for the relationship name. 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).
RelationshipNameFontFont for the relationship 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.
SchemaObjDisplayFormatDisplay format of Schema Objects in the submodel. Valid values are: Name = 1, Definition = 2. DATATYPE: Integer.
ShadowDetermines whether shadows are drawn (true) or not (false). DATATYPE: Boolean.
ShadowColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ShapeNameFontFont for the shape 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.
ShapeTextFontFont for the shape 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.
ShowAttributeNameDetermines whether attribute's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowCardinalityDetermines whether cardinality is displayed (true) or not (false). DATATYPE: Boolean.
ShowColumnNameDetermines whether attribute's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAlternateKeyDetermines whether entity's alternate keys are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentDetermines whether entity's attachments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentValueDetermines whether entity's attachment values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttributeBitmapDetermines whether entity's attribute bitmaps are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityDetermines whether entity's data security are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityValueDetermines whether entity's data security values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataTypeDetermines whether entity's data types are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionalTypeDetermines whether entity's dimension type are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionAttributesDetermines whether entity's dimension attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDomainDetermines whether entity's domains are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityFactAttributesDetermines whether entity's fact attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityIndexDetermines whether entity's indexes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityInversionEntryDetermines whether entity's inversion entries are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameDetermines whether entity's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameCompartmentDetermines whether entity name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNullOptionDetermines whether entity's null options are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityOwnerDetermines whether entity's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowGridDetermines whether to show the grid (true) or not (false). DATATYPE: Boolean.
ShowRelationshipBusinessNameDetermines whether relationship business names are displayed (true) or not (false). DATATYPE: Boolean.
ShowRelationshipNameDetermines whether relationship names are displayed (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjRelationshipsDetermines whether schema object relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjsDetermines whether schema objects are displayed (true) or not (false). DATATYPE: Boolean.
ShowShapeNamesDetermines whether shape names are displayed (true) or not (false). DATATYPE: Boolean.
ShowTableNameDetermines whether entity's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowTriggerSets the ShowTrigger flag. DATATYPE: Boolean.
ShowTriggerActionsDetermines whether relationship trigger actions are displayed (true) or not (false). DATATYPE: Boolean.
ShowVerbsDetermines whether verbs are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewNameCompartmentDetermines whether view name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewOwnerDetermines whether view's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewParentNameDetermines whether view's parent name is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewRelationshipsDetermines whether view relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowViewsDetermines whether views are displayed (true) or not (false). DATATYPE: Boolean.
SnapToGridDetermines whether to snap objects (entites, views, etc.) to the grid (true) or not (false). DATATYPE: Boolean.
StraightRelLineDetermines whether straight relationship lines are drawn (true) or not (false). DATATYPE: Boolean.
TextBackgroundColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TextBlockBorderColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TextBlockFontFont for the text object. 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.
TextForegroundColorColor 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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockBackgroundColorThis is the color 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 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 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 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 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 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 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 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 Vertical scroll bar position of the diagram display window. DATATYPE: Integer.
VerticalViewSizeThis is the height Height of the diagram display window. DATATYPE: Integer.
ViewBackgroundColorThis is the color 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 Display format of Views 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.
ViewFieldFontThis is the font 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 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 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 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 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 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 Determines whether entity names are wrapped (true) or not (false). DATATYPE: Boolean.
WrapViewNameThis determines Determines whether view names are wrapped (true) or not (false). DATATYPE: Boolean.
ZoomFactorThis is the viewing Viewing zoom percentage of the submodel (ie, 50, 100, %200, etc.). DATATYPE: Integer.
Info
titleSee Also