Public Methods
ActivateSubModel | Sets this SubModel as the Active Submodel. |
| AliasDisplays | Returns an object representing a collection of all alias display objects in the submodel. |
| AuxiliaryTableDisplays | Returns an object representing a collection of all auxiliary table display objects in the submodel. |
| BoundAttachments | Get all the BoundAttachments of this SubModel. |
| BoundSecurityProperties | Get all the BoundSecurityProperties of this SubModel. |
| BufferPoolDisplays | Returns an object representing a collection of all buffer pool display objects in the submodel. |
| BusinessDataObjectDisplays | Returns an object representing a collection of all BusinessDataObject displays in the submodel. |
| DatabaseDisplays | Returns an object representing a collection of all database display objects in the submodel. |
| DeleteNamingStandardsTemplate | Unbind this Submodel from the naming standards template by deleting the naming standards template ID from the submodel. |
| EntityDisplays | Returns an object representing a collection of all entity display objects in the submodel. |
| EntityNames | Returns the names of all entities in the submodel. A user can pass in a Variant variable for the first parameter. PARAMETERS: EntityNames: An array is filled in by the method (Variant), NumFetched: Set by the method (Integer). |
| ExportImageOptions | Get ExportImageOptions object for this SubModel. |
| FunctionDisplays | Returns an object representing a collection of all function display objects in the submodel. |
| GetNamingStandardsTemplate | Returns the naming standards template bound to the submodel or null, if none is bound to the submodel. |
| LineDisplays | Returns an object representing a collection of all line display objects in the submodel. |
| MaterializedViewDisplays | Returns an object representing a collection of all materialized view display objects in the submodel. |
| NodeGroupDisplays | Returns an object representing a collection of all nodegroup display objects in the submodel. |
| ObjectTypeDisplays | Returns an object representing a collection of all object type display objects in the submodel. |
| PackageDisplays | Returns an object representing a collection of all package display objects in the submodel. |
| PrintOptions | Get PrintOptions object for this SubModel. |
| ProcedureDisplays | Returns an object representing a collection of all procedure display objects in the submodel. |
| RelationshipDisplays | Returns an object representing a collection of all relationship display objects in the submodel. |
| RepoCheckOutStatus | Get the Check Out status of this SubModel object. DATATYPE: StringObjects. |
| RepoVersionHistory | Get the Version History of this SubModel from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects. |
| RollbackSegmentDisplays | Returns an object representing a collection of all rollback segment display objects in the submodel. |
| SchemaObjRelationshipDisplays | Returns an object representing a collection of all schema object relationship display objects in the submodel. |
| SelectedObjects | Returns an object representing a collection of all selected objects in the submodel. |
| SequenceDisplays | Returns an object representing a collection of all sequence display objects in the submodel. |
| ShapeDisplays | Returns an object representing a collection of all shape display objects in the submodel. |
| StoGroupDisplays | Returns an object representing a collection of all stogroup display objects in the submodel. |
| SynonymDisplays | Returns an object representing a collection of all synonym display objects in the submodel. |
| TablespaceDisplays | Returns an object representing a collection of all tablespace display objects in the submodel. |
| UserComments | Returns a collection of all the user comments associated with the submodel. |
| ViewDisplays | Returns an object representing a collection of all view display objects in the submodel. |
| ViewNames | Return all the View names in this Submodel. DATATYPE: StringObjects. |
| ViewRelationshipDisplays | Returns an object representing a collection of all view relationship display objects in the submodel. |
Public Properties
AttachmentColor | This is the 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). |
| AttachmentFont | This is the 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. |
| AttributeFont | This is the 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. |
| CompleteRoleName | This determines whether complete role names are displayed (true) or not (false). DATATYPE: Boolean. |
| DataSecurityColor | This is the 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). |
| DataSecurityFont | This is the 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. |
| Definition | This is the submodel definition property. DATATYPE: String. |
| DiagramBackgroundColor | This is the 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). |
| EntityBackgroundColor | This is the 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). |
| EntityDimTypeLabelColor | This is the 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). |
| EntityDimTypeLabelFont | This is the 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. |
| EntityDisplayFormat | This is the display format of Entities in the submodel. The possible values are: 1 - Attributes, 2 - Entities, 3 - Primary Keys, 4 - All Keys, 5 - Definition, 6 - Note. DATATYPE: Integer. |
| EntityForegroundColor | This 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). |
| EntityNameFont | This 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. |
| EntityTitleColor | This 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). |
| ForeignKeyFont | This 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. |
| ForeignNonKeyFont | This 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. |
| GridSpacing | This is the spacing for grid points. DATATYPE: Double. |
| GridsPerLine | This is the number of grid points per line. DATATYPE: Integer. |
| GridUnits | This is the unit type for the grid measurement. The possible values are: 0 - Inches, 1 - Centimeters. DATATYPE: Integer. |
| GUID | GUID of the submodel. This GUID is assigned by ER/Studio. Each submodel has a unique GUID. DATATYPE: String. |
| HorizontalScrollPosition | This is the horizontal scroll bar position of the diagram display window. DATATYPE: Integer. |
| HorizontalViewSize | This is the width of the diagram display window. DATATYPE: Integer. |
| ID | ID of the submodel. This ID is assigned by ER/Studio. Each submodel in a diagram has a unique ID. DATATYPE: Integer. |
| IndexColor | This 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). |
| IndexFont | This 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. |
| InheritedNonKeyColor | This 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). |
| InheritedPrimaryKeyColor | This 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). |
| InheritOption | This determines if the submodel will inherit objects added to nested submodels. DATATYPE: Boolean. |
| IsActive | This indicates if the submodel is the one currently displayed. DATATYPE: Boolean. |
| MainSubModel | This tells the user whether the currently displayed submodel is the main sub model (true) or not (false). DATATYPE: Boolean. |
| Name | This is the name of the submodel. DATATYPE: String. |
| NamingStandardsTemplateId | ID 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. |
| NonInheritedNonKeyColor | This 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). |
| NonInheritedPrimaryKeyColor | This 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). |
| OffPageBackgroundColor | This 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). |
| OffPageForegroundColor | This 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). |
| PageBoundary | This is the page boundary. DATATYPE: Integer. |
| PageForegroundColor | This 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). |
| PageNumberColor | This 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). |
| PageNumberFont | This 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. |
| PageOrientation | This is the page orientation. The possible values are: 1 - Portrait, 2 - Landscape. DATATYPE: Integer. |
| PageSize | This is the page size. DATATYPE: Integer. |
| ParentSubmodelID | ID of the parent Submodel object if this Submodel is a child in a nested Submodel. DATATYPE: Integer. |
| PrimaryKeyFont | This 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. |
| RelationshipBusinessNameColor | This 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). |
| RelationshipBusinessNameFont | This 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. |
| RelationshipColor | This 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). |
| RelationshipNameColor | This 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). |
| RelationshipNameFont | This 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. |
| SchemaObjDisplayFormat | This is the display format of Schema Objects in the submodel. The possible values are: 1 - Name, 2 - Definition. DATATYPE: Integer. |
| Shadow | This determines whether shadows are drawn (true) or not (false). DATATYPE: Boolean. |
| ShadowColor | This 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). |
| ShapeNameFont | This 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. |
| ShapeTextFont | This 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. |
| ShowAttributeName | This determines whether attribute's physical name is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowCardinality | This determines whether cardinality is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowColumnName | This determines whether attribute's logical name is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityAlternateKey | This determines whether entity's alternate keys are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityAttachment | This determines whether entity's attachments are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityAttachmentValue | This determines whether entity's attachment values are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityAttributeBitmap | This determines whether entity's attribute bitmaps are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityDataSecurity | This determines whether entity's data security are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityDataSecurityValue | This determines whether entity's data security values are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityDataType | This determines whether entity's data types are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityDimensionalType | This determines whether entity's dimension type are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityDimensionAttributes | This determines whether entity's dimension attributes are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityDomain | This determines whether entity's domains are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityFactAttributes | This determines whether entity's fact attributes are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityIndex | This determines whether entity's indexes are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityInversionEntry | This determines whether entity's inversion entries are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityName | This determines whether entity's physical name is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityNameCompartment | This determines whether entity name compartments are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityNullOption | This determines whether entity's null options are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowEntityOwner | This determines whether entity's owner is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowGrid | This determines whether to show the grid (true) or not (false). DATATYPE: Boolean. |
| ShowRelationshipBusinessName | This determines whether relationship business names are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowRelationshipName | This determines whether relationship names are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowSchemaObjRelationships | This determines whether schema object relationships are drawn (true) or not (false). DATATYPE: Boolean. |
| ShowSchemaObjs | This determines whether schema objects are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowShapeNames | This determines whether shape names are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowTableName | This determines whether entity's logical name is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowTrigger | This sets the ShowTrigger flag. DATATYPE: Boolean. |
| ShowTriggerActions | This determines whether relationship trigger actions are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowVerbs | This determines whether verbs are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowViewNameCompartment | This determines whether view name compartments are displayed (true) or not (false). DATATYPE: Boolean. |
| ShowViewOwner | This determines whether view's owner is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowViewParentName | This determines whether view's parent name is displayed (true) or not (false). DATATYPE: Boolean. |
| ShowViewRelationships | This determines whether view relationships are drawn (true) or not (false). DATATYPE: Boolean. |
| ShowViews | This determines whether views are displayed (true) or not (false). DATATYPE: Boolean. |
| SnapToGrid | This determines whether to snap objects (entites, views, etc.) to the grid (true) or not (false). DATATYPE: Boolean. |
| StraightRelLine | This determines whether straight relationship lines are drawn (true) or not (false). DATATYPE: Boolean. |
| TextBackgroundColor | This 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). |
| TextBlockBorderColor | This 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). |
| TextBlockFont | This 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. |
| TextForegroundColor | This 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). |
| TitleBlockBackgroundColor | This 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). |
| TitleBlockBorderColor | This 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). |
| TitleBlockFont | This 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. |
| TitleBlockTextColor | This 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). |
| TriggerColor | This 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). |
| TriggerFont | This 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. |
| VerbFont | This 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. |
| VerbTextColor | This 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). |
| VerticalScrollPosition | This is the vertical scroll bar position of the diagram display window. DATATYPE: Integer. |
| VerticalViewSize | This is the height of the diagram display window. DATATYPE: Integer. |
| ViewBackgroundColor | This 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). |
| ViewDisplayFormat | This 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. |
| ViewFieldFont | This 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. |
| ViewFieldTextColor | This 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). |
| ViewForegroundColor | This 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). |
| ViewNameFont | This 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. |
| ViewRelationshipColor | This 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). |
| ViewTitleColor | This 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). |
| WrapEntityName | This determines whether entity names are wrapped (true) or not (false). DATATYPE: Boolean. |
| WrapViewName | This determines whether view names are wrapped (true) or not (false). DATATYPE: Boolean. |
| ZoomFactor | This is the viewing zoom percentage of the submodel (ie, 50, 100, %200, etc.). DATATYPE: Integer. |
See Also