Applies To
	Product(s):	MicroStation V8i
	Version(s):	08.11.XX.XX
	Environment:	N/A
	Area:	Programming
	Subarea:	General
	Original Author:	Bentley Technical Support Group

 

 

 

 

 

 

 

Where to find information regarding developing with MicroStation (in the order each should be referenced):

MicroStation SDK ReadMe ..\Bentley\MicroStation\readme_microstationsdk.chm

The ReadMe contains the following information pertaining to the MicroStation SDK:

• What is new/changed
• Requirements
• QuickInstall Guide
• ReadMe

MicroStation Programming Interfaces Reference ..\Bentley\Documentation\MicroStationAPI.chm

This reference covers various topics, including (but not limited to):

Event Handling	The recommended method to interact with MicroStation V8's View, AccuDraw, and Mouse control systems
XAttributes	Extended information that is stored 'on' an element
Viewports	The abstraction of a visible information container
Transaction Manager	Journals all transactionable (or undoable) changes to Persistent Elements during a session
Font Manager	The root for all font access
MstnTool	The MstnTool class encapsulates the MDL "state" functions and helps simplify the process of writing tools for MicroStation.
ElemHandles	An indirect reference to an element's current state
Geographic Coordinate Systems
Scoped Variable Management	Scope management classes use C++ constructor and destructor calls at scope entry and exit time to guarantee corresponding setup and teardown operations.

NOTE: When developing in C++ using the MicroStation API, the first Bentley include file in your source should be MicroStationAPI.h. This will ensure that some necessary header files are included in the order they need to be.

MDL API Function Reference ..\Bentley\Documentation\MDLAPIFunctionReference.chm

This document identifies the MicroStation API published functions, categorized by various subsystems and topics, and includes:

• Each function's description, required header and library files, return value, and parameters
• Which version the function was introduced in
• The wrapper declaration for use with MicroStation VBA
• Example code

All functions in the MDL API Function Reference are automatically tagged with the xx.yy.zz build in which they were initially included as public functions. Some things to consider regarding this include:

• v8.0.0 is the baseline for all functions, since so many signatures changed in V8.0.
• What is documented is the version when the function first appears as documented. It is possible that the function was available previously, but was undocumented. Then again, signature changes are common as functions move from private to public.
• Only the first three parts of the version number are used (i.e. 8.1.2). The fourth part of the version number (the build number) is superfluous, since many functions appear in builds that are not publicly released.

Refer to the delivered deprecated*.fdf files in ..\mdl\include\ for the latest deprecated MDL functions. Bentley highly recommends avoiding the use of deprecated functions.

To search for functions that appeared in a particular version of MicroStation, click on the Search tab and use the following as examples:

• 08.11* searches for all functions initially published in MicroStation V8i (i.e. V8.11) builds
• 08.09* searches for all functions initially published in MicroStation V8 XM Edition (i.e. V8.9) builds
• 8.5* searches for all functions initially published in MicroStation V8 2004 Edition (i.e. V8.5) builds
• 8.1* searches for all functions initially published in MicroStation V8.1 builds
• 8.0* searches for all functions initially published in MicroStation V8.0 builds

MDL Programmer Guide ..\Bentley\Documentation\MDLProgrammerGuide.chm

MDL lets developers create professional-quality applications that integrate seamlessly with MicroStation and Bentley products. It is the recommended way to access MicroStation V8 DGN files with full fidelity. MDL facilitates development of applications by providing consistent functionality and capabilities across the products on which they run. It can be used to develop simple utilities, customized commands or sophisticated commercial applications for vertical markets and is used by Bentley's developers as the tool to incorporate modular functionality into its products. MicroStation V8 can also host and interface with a variety of programs and applications written in C, C++, C#, and Visual Basic. The MDL Programmer Guide includes, among other things:

• An MDL overview
• Design methodology
• How to build and run applications
• Information on MicroStation resources, element descriptors, and built-in variables
• Developing MicroStation applications for DWG files
• Developing MicroStation applications that access databases
• Internationalization
• MFC Dialog and Native Window Support
• Drag-and-drop
• Porting MDL Applications to MicroStation V8

MicroStation VBA documentation ..\Bentley\MicroStation\MicroStationVBA.chm

This document is delivered with MicroStation. MicroStation VBA, the MicroStation V8 implementation of the Microsoft Visual Basic for Applications engine, one of the most popular programming environments in the world, provides MicroStation users (as well as developers) with a large number of capabilities -- from easy customization to tight integration with other Windows applications. In addition to identifying all the enums, objects, events, methods, properties, and types available, the MicroStation VBA documentation also includes a number of examples as well as a general overview covering the following:

• Getting Started with Visual Basic
  • Loading and running a VBA macro
  • MicroStation V8 Objects
    • Automation Object Model
    • Application object structure
    • ModelReference object structure
    • Attachment object structure
    • ActiveSettings object structure
    • What is not in the Automation Object Model?
    • Understanding objects, properties and methods
  • Frequently asked MicroStation VBA Questions
  • Using the MicroStation VBA Interface
    • Project Manager
    • The Macros dialog box
    • MicroStation VBA Environment Variables
    • MicroStation VBA Keyins
    • Using the Visual Basic Editor
  • Recording and Revising Macros
  • Automating common MicroStation tasks
  • Working with MicroStation Objects
  • Working with MicroStation Events
  • Customizing MicroStation with Visual Basic
  • Converting from MicroStation Basic to VBA
• Developing Code in VBA
  • Interface oriented programming
  • Interacting with MDL
  • Calling DLL functions from VBA
  • Units and coordinate systems in VBA
  • Events
  • Handling design elements
  • Organization of a MicroStation command
  • Accessing data and other applications
  • Common Mistakes
• Changes for MicroStation

MicroStation BASIC documentation ..\Bentley\Documentation\basic_help.chm

Delivered with MicroStation and covers the entire functionality of MicroStation BASIC. Note that MicroStation BASIC has not been enhanced and will be unsupported in future versions. Bentley highly recommends migrating existing MicroStation BASIC code to Visual Basic or Visual Basic for Applications.

Example Code

There are a number of VBA and MDL code examples delivered with MicroStation, the MicroStation SDK, and included with the documentation for both (check the QuickInstall Guide for the default installation location of examples delivered with the MicroStation SDK). Additional example code is also available at the following locations:

• Be Communities (use this search for code)
• "Learning MicroStation VBA" Book by Jerry Winters (bentley.com)
• various VBA distance learning courses through the Bentley Institute

Bentley Developer Network

The Bentley Developer Network provides you with resources to help successfully develop and test software products that complement Bentley technologies. Whether you are a new or an experienced developer, you have convenient access to information, tools, technical support and programming resources to help you work more efficiently. And that means you will reduce development costs and time to market. The Bentley Developer Network program delivers essential programming information and the latest Bentley software along with the tools you need to extend that software. Click here to find out what Bentley Developer Network membership level is right for you.