Versions Compared

Key

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

Public Methods

 

ActiveDataDictionary

Returns the current, active Data Dictionary.

 

ActiveDiagram

Returns the current, active diagram.

 

CloseDiagram

Closes the diagram specified by the given, title string. PARAMETERS: Identifier as String.

 

CreateStringObjects

Returns a newly created and empty StringObjects.

 

DeleteNamedRelease

Delete a NamedRelease from the Repo Server using the given Name. Return value is 1 if it succeeded, else it's 0. PARAMETERS: Name as String. RETURN DATATYPE: Integer.

 

EnableScreenUpdate

Enable (TRUE) or disable(FALSE) the screen updates of the diagram. PARAMETERS: Enable as Boolean.

 
EnableScreenUpdateEx

EnableTreeUpdate as Boolean, Enable or disable the screen and explorer tree updates of the diagram. PARAMETERS: EnableViewUpdate as Boolean.

 

GetAllNamedReleases

Returns the name of all NamedReleases.

 

GetLastErrorCode

Returns the last ErrorCode of the Diagram. It returns zero if the last operation succeeded. RETURN DATATYPE: Integer.

 

GetLastErrorString

Returns the last ErrorString (error detail) of the Diagram. It returns an empty string if the last operation succeeded. RETURN DATATYPE: String.

 

GetNamedRelease

Directory as String, Get a NamedRelease from the Repo Server using the given Name, and save it to given directory. Return value is 1 if it succeeded else it's 0. PARAMETERS: Name as String. RETURN DATATYPE: Integer.

 

GetRegistryKey Method

Returns the Registry Key for this application. RETURN DATATYPE: String.

 

HideWindow

Make the application hidden. Use this outside of ERStudio such as in a VB Application.

 

ImportERXFile

Imports the given, complete file path of the .erx file, and opens a new diagram for the imported .erx file. PARAMETERS: FullFilePath as String.

 

ImportSQLFile

Imports the given, complete file path of the .sql file, and opens a new diagram for the imported .sql file. PARAMETERS: FullFilePath as String, TargetDatabasePlatform as String.

 

MetaImportObject

Returns an object which provides an interface for importing various file formats via MIMB (implements functionality of MetaWizard (import) for Automation.

 

NewDiagram

Opens a new diagram.

 

OpenFile

Reads in the given, complete file path of the .dm1 file, and opens a new diagram for the .dm1 file. PARAMETERS: FullFilePath as String.

 

Quit

Shutdown ER/Studio without saving any documents.

 

RepoAvailableSubmodels

Returns the collection of submodels (of the given diagram) available in the repository. PARAMETERS: DiagramName (String).

 

RepoDataDictionaries

Returns all Data Dictionary names from the Repo Server.

 

RepoDeleteDiagram

Delete a Diagram from the Repo Server using the given Diagram Name. Return value is 1 if it succeeded else it's 0. PARAMETERS: Name as String. RETURN DATATYPE: Integer.

 

RepoDiagrams

Returns all Diagram names from the Repo Server.

 

RepoGetDiagram

GetDiagram from the Repo Server using the given Diagram Name. Return value is 1 if it succeeded else it's 0. PARAMETERS: Name as String. RETURN DATATYPE: Integer.

 

RepoLogin

Login to the Repo Server using the given Name and Password. Return value is 1 if it succeeded, else it's 0. PARAMETERS: Name as String and Password as String. RETURN DATATYPE: Integer.

 

RepoLogout

Logout of the Repo Server. Return value is 1 if it succeeded, else it's 0. RETURN DATATYPE: Integer.

 

RepoObjectPrivileges

Returns all ObjectPrivilege names from the Repo Server.

 

RepoProjects

Returns all Projects from the Repo Server.

 

RepoRoles

Returns all Roles from the Repo Server.

 

RepoSoftDeleteDiagram

Delete a Diagram from the Repo Server but leave data still in the database (marked as deleted). Uses the given Diagram Name. Return value is 1 if it succeeded else it's 0. PARAMETERS: Name as String. RETURN DATATYPE: Integer.

 

RepoUsers

Returns all Users from the Repo Server.

 

ReverseEngineerObject

Returns an object which provides an interface for reverse-engineering.

 

ShowWindow

If the application is hidden, this will make the application visible.

 
SynchronizeComments

Synchronize the user comments in the dm1 file with the ones in the repository database. Return value is 1 if it succeeded else it is 0.

Public Properties

 _DiagramItem

Returns a diagram, given the diagram's title. PARAMETERS: Identifier as String.

 _NewEnum

 


 CurrentUser

Returns the name of the user that is currently logged in. DATATYPE: String.

 DiagramCount

Returns the number of currently, open diagrams. DATATYPE: Integer.

 DiagramItem

Returns a diagram, given the diagram's title. PARAMETERS: Identifier as String.

 ERSFullVersion

This property displays the ERStudio.exe Full Version and Build Number. DATATYPE: String.

 ERSVersion

This property displays the ERStudio.exe Version and Build Number. DATATYPE: String.

 HideRepositoryIcon

This Boolean flag controls the showing or hiding of Repository Status Icon. DATATYPE: Boolean.

 RepoActiveDirectory

This is the Repository Active Directory of ER/Studio. DATATYPE: String.

See Also

Application Overview