Versions Compared

Key

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

Public Methods

MethodDescription
Sets this SubModel as the Active Submodel.
AliasDisplaysReturns an object representing a collection of all alias display objects in the submodel.
AuxiliaryTableDisplaysReturns an object representing a collection of all auxiliary table display objects in the submodel.
BoundAttachmentsGet all the BoundAttachments of this SubModel.
BoundSecurityPropertiesGet all the BoundSecurityProperties of this SubModel.
BufferPoolDisplaysReturns an object representing a collection of all buffer pool display objects in the submodel.
BusinessDataObjectDisplaysReturns an object representing a collection of all BusinessDataObject displays in the submodel.
DatabaseDisplaysReturns an object representing a collection of all database display objects in the submodel.
DeleteNamingStandardsTemplateUnbind this Submodel from the naming standards template by deleting the naming standards template ID from the submodel.
EntityDisplaysReturns an object representing a collection of all entity display objects in the submodel.
EntityNamesReturns 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).
ExportImageOptionsGet ExportImageOptions object for this SubModel.
FunctionDisplaysReturns an object representing a collection of all function display objects in the submodel.
GetNamingStandardsTemplateReturns the naming standards template bound to the submodel or null, if none is bound to the submodel.
LineDisplaysReturns an object representing a collection of all line display objects in the submodel.
MaterializedViewDisplaysReturns an object representing a collection of all materialized view display objects in the submodel.
NodeGroupDisplaysReturns an object representing a collection of all nodegroup display objects in the submodel.
ObjectTypeDisplaysReturns an object representing a collection of all object type display objects in the submodel.
PackageDisplaysReturns an object representing a collection of all package display objects in the submodel.
PrintOptionsGet PrintOptions object for this SubModel.
ProcedureDisplaysReturns an object representing a collection of all procedure display objects in the submodel.
RelationshipDisplaysReturns an object representing a collection of all relationship display objects in the submodel.
RepoCheckOutStatusGet the Check Out status of this SubModel object. DATATYPE: StringObjects.
RepoVersionHistoryGet the Version History of this SubModel from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects.
RollbackSegmentDisplaysReturns an object representing a collection of all rollback segment display objects in the submodel.
SchemaObjRelationshipDisplaysReturns an object representing a collection of all schema object relationship display objects in the submodel.
SelectedObjectsReturns an object representing a collection of all selected objects in the submodel.
SequenceDisplaysReturns an object representing a collection of all sequence display objects in the submodel.
ShapeDisplaysReturns an object representing a collection of all shape display objects in the submodel.
StoGroupDisplaysReturns an object representing a collection of all stogroup display objects in the submodel.
SynonymDisplaysReturns an object representing a collection of all synonym display objects in the submodel.
TablespaceDisplaysReturns an object representing a collection of all tablespace display objects in the submodel.
UserCommentsReturns a collection of all the user comments associated with the submodel.
ViewDisplaysReturns an object representing a collection of all view display objects in the submodel.
ViewNamesReturn all the View names in this Submodel. DATATYPE: StringObjects.
ViewRelationshipDisplaysReturns an object representing a collection of all view relationship display objects in the submodel.

Public Properties

Class ModuleDescription
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.
EntityForegroundColorThis is the color 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 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 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 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 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 Spacing for grid points. DATATYPE: Double.
GridsPerLineThis is the number Number of grid points per line. DATATYPE: Integer.
GridUnitsThis is the unit Unit type for the grid measurement. The possible Valid values are: Inches = 0 - Inches, Centimeters = 1 - Centimeters. DATATYPE: Integer.
GUIDGUID of the submodel . This GUID is as assigned by ER/Studio. Each submodel has a unique GUID. DATATYPE: String.
HorizontalScrollPositionThis is the horizontal Horizontal scroll bar position of the diagram display window. DATATYPE: Integer.
HorizontalViewSizeThis is the width Width of the diagram display window. DATATYPE: Integer.
IDID of the submodel . This ID is as assigned by ER/Studio. Each submodel in a diagram has a unique ID. DATATYPE: Integer.
IndexColorThis is the color 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 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 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 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 Determines whether the submodel will inherit inherits objects added to nested submodels. DATATYPE: Boolean.
IsActiveThis indicates if Indicates whether the submodel is the one currently displayed. DATATYPE: Boolean.
MainSubModelThis tells Tells the user whether the currently displayed submodel is the main sub model (true) or not (false). DATATYPE: Boolean.
NameThis is the name 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 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 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 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 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 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 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