SubModel Object Members

Public Methods

Method	Description
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

Class Module	Description
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).
AttachmentFont	Font 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.
AttributeFont	Font 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.
CompleteRoleName	Determines whether you want to display complete role names (true) or not (false). DATATYPE: Boolean.
DataSecurityColor	Color 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).
DataSecurityFont	Font 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.
Definition	Submodel definition property. DATATYPE: String.
DiagramBackgroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityBackgroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityDimTypeLabelColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityDimTypeLabelFont	Font 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.
EntityDisplayFormat	Display 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.
EntityForegroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
EntityNameFont	Font 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.
EntityTitleColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ForeignKeyFont	Font 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.
ForeignNonKeyFont	Font 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.
GridSpacing	Spacing for grid points. DATATYPE: Double.
GridsPerLine	Number of grid points per line. DATATYPE: Integer.
GridUnits	Unit type for the grid measurement. Valid values are: Inches = 0, Centimeters = 1. DATATYPE: Integer.
GUID	GUID of the submodel as assigned by ER/Studio. Each submodel has a unique GUID. DATATYPE: String.
HorizontalScrollPosition	Horizontal scroll bar position of the diagram display window. DATATYPE: Integer.
HorizontalViewSize	Width of the diagram display window. DATATYPE: Integer.
ID	ID of the submodel as assigned by ER/Studio. Each submodel in a diagram has a unique ID. DATATYPE: Integer.
IndexColor	Color 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).
IndexFont	Font 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.
InheritedNonKeyColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
InheritedPrimaryKeyColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
InheritOption	Determines whether the submodel inherits objects added to nested submodels. DATATYPE: Boolean.
IsActive	Indicates whether the submodel is the one currently displayed. DATATYPE: Boolean.
MainSubModel	Tells the user whether the currently displayed submodel is the main sub model (true) or not (false). DATATYPE: Boolean.
Name	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	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
NonInheritedPrimaryKeyColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
OffPageBackgroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
OffPageForegroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageBoundary	Page boundary. DATATYPE: Integer.
PageForegroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageNumberColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
PageNumberFont	Font 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.
PageOrientation	Page orientation. Valid values are: Portrait = 1, Landscape = 2. DATATYPE: Integer.
PageSize	Page size. DATATYPE: Integer.
ParentSubmodelID	ID of the parent Submodel object if this Submodel is a child in a nested Submodel. DATATYPE: Integer.
PrimaryKeyFont	Font 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.
RelationshipBusinessNameColor	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	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	Color 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).
RelationshipNameColor	Color 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).
RelationshipNameFont	Font 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.
SchemaObjDisplayFormat	Display format of Schema Objects in the submodel. Valid values are: Name = 1, Definition = 2. DATATYPE: Integer.
Shadow	Determines whether shadows are drawn (true) or not (false). DATATYPE: Boolean.
ShadowColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ShapeNameFont	Font 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.
ShapeTextFont	Font 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.
ShowAttributeName	Determines whether attribute's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowCardinality	Determines whether cardinality is displayed (true) or not (false). DATATYPE: Boolean.
ShowColumnName	Determines whether attribute's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAlternateKey	Determines whether entity's alternate keys are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachment	Determines whether entity's attachments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttachmentValue	Determines whether entity's attachment values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityAttributeBitmap	Determines whether entity's attribute bitmaps are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurity	Determines whether entity's data security are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataSecurityValue	Determines whether entity's data security values are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDataType	Determines whether entity's data types are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionalType	Determines whether entity's dimension type are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDimensionAttributes	Determines whether entity's dimension attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityDomain	Determines whether entity's domains are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityFactAttributes	Determines whether entity's fact attributes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityIndex	Determines whether entity's indexes are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityInversionEntry	Determines whether entity's inversion entries are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityName	Determines whether entity's physical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNameCompartment	Determines whether entity name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityNullOption	Determines whether entity's null options are displayed (true) or not (false). DATATYPE: Boolean.
ShowEntityOwner	Determines whether entity's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowGrid	Determines whether to show the grid (true) or not (false). DATATYPE: Boolean.
ShowRelationshipBusinessName	Determines whether relationship business names are displayed (true) or not (false). DATATYPE: Boolean.
ShowRelationshipName	Determines whether relationship names are displayed (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjRelationships	Determines whether schema object relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowSchemaObjs	Determines whether schema objects are displayed (true) or not (false). DATATYPE: Boolean.
ShowShapeNames	Determines whether shape names are displayed (true) or not (false). DATATYPE: Boolean.
ShowTableName	Determines whether entity's logical name is displayed (true) or not (false). DATATYPE: Boolean.
ShowTrigger	Sets the ShowTrigger flag. DATATYPE: Boolean.
ShowTriggerActions	Determines whether relationship trigger actions are displayed (true) or not (false). DATATYPE: Boolean.
ShowVerbs	Determines whether verbs are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewNameCompartment	Determines whether view name compartments are displayed (true) or not (false). DATATYPE: Boolean.
ShowViewOwner	Determines whether view's owner is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewParentName	Determines whether view's parent name is displayed (true) or not (false). DATATYPE: Boolean.
ShowViewRelationships	Determines whether view relationships are drawn (true) or not (false). DATATYPE: Boolean.
ShowViews	Determines whether views are displayed (true) or not (false). DATATYPE: Boolean.
SnapToGrid	Determines whether to snap objects (entites, views, etc.) to the grid (true) or not (false). DATATYPE: Boolean.
StraightRelLine	Determines whether straight relationship lines are drawn (true) or not (false). DATATYPE: Boolean.
TextBackgroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TextBlockBorderColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TextBlockFont	Font 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.
TextForegroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockBackgroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockBorderColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TitleBlockFont	Font for the title block. 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.
TitleBlockTextColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
TriggerColor	Color for Triggers. 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).
TriggerFont	Font for Triggers. 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.
VerbFont	Font for the verb. 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.
VerbTextColor	Color for the verb. 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).
VerticalScrollPosition	Vertical scroll bar position of the diagram display window. DATATYPE: Integer.
VerticalViewSize	Height of the diagram display window. DATATYPE: Integer.
ViewBackgroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewDisplayFormat	Display format of Views in the submodel. Valid values are: Attributes = 1, Entities = 2, Primary Keys = 3, All Keys = 4, Definition = 5, Note = 6. DATATYPE: Integer.
ViewFieldFont	Font for local, non-key view fields. 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.
ViewFieldTextColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewForegroundColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
ViewNameFont	Font for the view 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.
ViewRelationshipColor	Color for the view relationship. 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).
ViewTitleColor	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 byte represents a green value (0-255), and the third byte represents a blue value (0-255).
WrapEntityName	Determines whether entity names are wrapped (true) or not (false). DATATYPE: Boolean.
WrapViewName	Determines whether view names are wrapped (true) or not (false). DATATYPE: Boolean.
ZoomFactor	Viewing zoom percentage of the submodel (ie, 50, 100, %200, etc.). DATATYPE: Integer.

Content

Space Tools

Public Methods

Public Properties