Smart Development Environment 4.1 for Visual Studio .NET User's Guide

The software and documentation are furnished under the Smart Development Environment license agreement and may be used only in accordance with the terms of the agreement.

Copyright Information
Copyright © 1999-2007 by Visual Paradigm. All rights reserved.

The material made available by Visual Paradigm in this document is protected under the laws and various international laws and treaties. No portion of this document or the material contained on it may be reproduced in any form or by any means without prior written permission from Visual Paradigm.

Every effort has been made to ensure the accuracy of this document. However, Visual Paradigm makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose. The information in this document is subject to change without notice.

All examples with names, company names, or companies that appear in this document are imaginary and do not refer to, or portray, in name or substance, any actual names, companies, entities, or institutions. Any resemblance to any real person, company, entity, or institution is purely coincidental.

Trademark Information

Smart Development Environment is registered trademark of Visual Paradigm.
Sun, Sun ONE, Java, Java2, J2EE and EJB, NetBeans are all registered trademarks of Sun Microsystems, Inc.
Microsoft, Windows, Windows NT, Visual Studio, Visio, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation.
Oracle is a registered trademark of Oracle Corporation.
Rational Rose is registered trademark of International Business Machines Corporation.
WinZip is a registered trademark of WinZip Computing, Inc.
Other trademarks or service marks referenced herein are property of their respective owners.

Smart Development Environment License Agreement THE USE OF THE SOFTWARE LICENSED TO YOU IS SUBJECT TO THE TERMS AND CONDITIONS OF THIS SOFTWARE LICENSE AGREEMENT. BY INSTALLING, COPYING, OR OTHERWISE USING THE SOFTWARE, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT, AND AGREE TO BE BOUNDED BY ALL OF THE TERMS AND CONDITIONS OF THIS SOFTWARE LICENSE AGREEMENT.

1. Limited License Grant. Visual Paradigm grants to you ("the Licensee") a personal, non-exclusive, non-transferable, limited, perpetual, revocable license to install and use Visual Paradigm Products ("the Software" or "the Product"). The Licensee must not re-distribute the Software in whole or in part, either separately or included with a product.
2. Restrictions. The Software is confidential copyrighted information of Visual Paradigm, and Visual Paradigm and/or its licensors retain title to all copies. The Licensee shall not modify, adapt, decompile, disassemble, decrypt, extract, or otherwise reverse engineer the Software. Software may not be leased, rented, transferred, distributed, assigned, or sublicensed, in whole or in part. The Software contains valuable trade secrets. The Licensee promises not to extract any information or concepts from it as part of an effort to compete with the licensor, nor to assist anyone else in such an effort. The Licensee agrees not to remove, modify, delete or destroy any proprietary right notices of Visual Paradigm and its licensors, including copyright notices, in the Software.
3. Disclaimer of Warranty. The software and documentation are provided "AS IS," WITH NO WARRANTIES WHATSOEVER. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH THE LICENSEE. THERE IS NO WARRANTY THE DOCUMENTATION, Visual Paradigm's EFFORTS OR THE LICENSED SOFTWARE WILL FULFILL ANY OF LICENSEE'S PARTICULAR PURPOSES OR NEEDS. IF THESE WARRANTIES ARE UNENFORCEABLE UNDER APPLICABLE LAW, THEN Visual Paradigm DISCLAIMS SUCH WARRANTIES TO THE MAXIMUM EXTENT PERMITTED BY SUCH APPLICABLE LAW.
4. Limitation of Liability. Visual Paradigm AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY THE LICENSEE OR ANY THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING SOFTWARE. IN NO EVENT WILL Visual Paradigm OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, EXEMPLARY, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF Visual Paradigm HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
5. Termination. The Licensee may terminate this License at any time by destroying all copies of Software. Visual Paradigm will not be obligated to refund any License Fees, if any, paid by the Licensee for such termination. This License will terminate immediately without notice from Visual Paradigm if the Licensee fails to comply with any provision of this License. Upon such termination, the Licensee must destroy all copies of the Software. Visual Paradigm reserves all rights to terminate this License.

SPECIFIC DISCLAIMER FOR HIGH-RISK ACTIVITIES. The SOFTWARE is not designed or intended for use in high-risk activities including, without restricting the generality of the foregoing, on-line control of aircraft, air traffic, aircraft navigation or aircraft communications; or in the design, construction, operation or maintenance of any nuclear facility. Visual Paradigm disclaims any express or implied warranty of fitness for such purposes or any other purposes.

NOTICE. The Product is not intended for personal, family or household use; rather, it is intended exclusively for professional use. Its utilization requires skills that differ from those needed to use consumer software products such as word processing or spreadsheet software.

GOVERNMENT RIGHTS. If the Software is licensed by or on behalf of a unit or agency of any government, the Licensee agrees that the Software is "commercial computer software", "commercial computer software documentation" or similar terms and that, in the absence of a written agreement to the contrary, the Licensee's rights with respect to the Software are limited by the terms of this Agreement.

Acknowledgements

This Product includes software developed by the Apache Software Foundation (http://www.apache.org). Copyright c1999 The Apache Software Foundation. All rights reserved.

Table of Contents

Chapter 1 - Introduction to Smart Development Environment for Visual Studio.NET

What is Smart Development Environment (SDE) for Visual Studio.NET™
Key Benefits

Single Environment for Development
Enabling Model-driven Development
Incremental Round-trip Engineering
Round-trip Engineering for Multiple Programming Languages

Features Highlight

Chapter 2 - Getting Started with SDE-VS

Starting SDE-VS
Importing a License Key

Importing a Floating License Key
Requesting for a License Key

Unloading SDE-VS
Panes

Diagram Navigator Pane
Model Pane
Class Repository Pane
Logical View Pane
Stencil Pane
Property Pane
Diagram Overview Pane
Documentation Pane
Message Pane

Working with UML Projects

Saving a Project
Exporting and Merging of Project
Importing a Project
Managing Project Properties

Open Specification Dialog Box

Navigating between Diagram Elements

Part 1 -Working with Smart Development Environment for Visual Studio .NET

Chapter 3 - Incremental Round-trip Engineering for C#

Opening/Closing a UML Model
Generating Code from UML Model

Generate Code from Selected Classes
Generate Code from Classes in a Package
Generate Code from Classes in the Whole Project

Reverse Engineering

Selected Files
Files in a Package
Files in the Whole Project

Enabling/Disabling Auto Round-trip Engineering
Browsing Code with UML model
Selecting UML Model with Code
Model Representation of Code

Chapter 4 - Incremental Round-trip Engineering for Visual Basic

Opening/Closing a UML Model
Generating Code from UML Model

Generate Code from Selected Classes
Generate Code from Classes in a Package
Generate Code from Classes in the Whole Project

Reverse Engineering

Selected Files
Files in a Package
Files in the Whole Project

Enabling/Disabling Auto Round-trip Engineering
Browsing Code with UML model
Selecting UML Model with Code
Model Representation of Code

Chapter 5 - Incremental Round-trip Engineering for C++

Opening/Closing a UML Model
Generating Code from UML Model

Generate Code from Selected Classes
Generate Code from Classes in a Package
Generate Code from Classes in the Whole Project

Reverse Engineering

Selected Files
Files in a Folder
Files in the Whole Project

Enabling/Disabling Auto Round-trip Engineering
Browsing Code with UML model
Selecting UML Model with Code
Model Representation of Code

Chapter 6 - Incremental Round-trip Engineering for ASP Project

Opening/Closing a UML Model
Generating Code from UML Model

Generate Code from Selected Classes
Generate Code from Classes in a Package
Generate Code from Classes in the Whole Project

Reverse Engineering

Selected Files
Files in a Package
Files in the Whole Project

Enabling/Disabling Auto Round-trip Engineering
Browsing Code with UML model
Selecting UML Model with Code
Model Representation of Code

Chapter 7 - Working with Diagrams

Creating Diagram Elements

Creating Shapes
Creating Connectors
Creating Self-Connection

Resource-Centric Interface

Using the Resource-Centric Interface
Show Extra Resources
Auto Hide Resource Centric
Enabling/Disabling the Resource-Centric Interface Feature

Connector Styles

Follow Diagram Connector Style
Rectilinear Connector Style
Oblique Connector Style
Curve Connector Style
Change Connector Style
Set a Default Connector Style
Connection Point

Styles
Pinning the Connection End Point

Basic Editing Features

Undo
Redo
Copy
Paste
Delete

Finding a Model Element
Fill Color

Format Fill Color Dialog Box

Line Format

Format Line Dialog Box

Alignment

Referenced Shape for Alignment
Using the Align Shapes Dialog Box

Distribute Shapes

Using the Distribute Shapes Dialog Box

Zooming

Zooming In
Zooming Out
Zooming to 100%
Zooming to a Specific Ratio
Zooming to Fit Diagram to Window
Zooming to Region

Grid

Showing/Hiding Grids
Snap to Grid
Grid Size
Grid Color

Form Diagram from Model

Customize Form Diagram Properties
Hierarchical Diagram
Navigation Diagram

Compartment Visibility Control
Quick Previewer
Fast Scroll
Sub-Diagrams

Creating a Sub-Diagram
Selecting Existing Diagrams as Sub-Diagrams
Viewing the List of Sub-Diagrams
Opening Sub-Diagrams
Removing Sub-Diagrams

OLE Support

Copying Diagram Elements as an OLE Object
Editing an OLE Object

Logical View

Creating a Logical View
Creating Diagram(s) under View
Moving Diagram(s) between Views
Exporting and Importing View

Modeler
Stencil
Installing Visio Send to VP Plugin
Sending Shape from Visio to SDE-VS
Importing a Stencil
Opening a Stencil
Creating Shape from Stencil
Closing a Stencil

Exporting Diagram as Images

Exporting the Active Diagram as an Image
Exporting Diagrams as Images

Mouse Gesture

Gesture Start Point and Direction
Initial State and Final State

Chapter 8 - Generating Documentation

Report Writer

Launching Report Writer
Panes
Toolbar
Constructing a Report
Applying Style to Report
Updating Table of Contents
Exporting a report
Importing a Report
Updating a Report
Printing a report

HTML Report Generation

The Generate HTML Dialog Box
Generating an HTML Report
Defining Image Quality
Defining a Header/Footer
Defining the Document Info

PDF Report Generation

The Generate PDF Dialog Box
Generating a PDF Report
Defining Image Quality
Defining the page information

Printing Diagrams

Print Preview
Printing a Diagram with Preview
Printing a Diagram with Quick Print

Chapter 9 - Interoperability

XMI Importer and Exporter

Supported XMI File version
Importing an XMI File
Exporting an XMI file

Rose Importer

Importing a Rose Project

Chapter 10 - Automatic Diagrams Layout

Auto Layout

Class Diagram
Activity Diagram
State Machine Diagram
Communication Diagram
Others diagram

Performing Layout
Orthogonal Layout
Hierarchic Layout
Directed Tree Layout
Balloon Tree Layout
Compact Tree Layout
Horizontal-Vertical Tree Layout
BBC Compact Circular Layout
BBC Isolated Circular Layout
Single Cycle Circular Layout
Organic Layout
Smart Organic Layout
Organic Edge Route Layout
Orthogonal Edge Route Layout

Chapter 11 - Instant Reverse

What is Instant Reverse™
Supported Formats
Using Instant Reverse

Chapter 12 - Incorporating VisioR and Images to Diagrams

Introduction
Creating VisioR Shapes
Editing VisioR Shapes
Resizing VisioR Shapes
Fitting VisioR Shape Size
What is Image Shape
Creating Image Shapes

Creating Image Shapes by Using Diagram Toolbar
Creating Image Shapes by Copy and Paste
Creating Image Shapes by Drag and Drop

Selecting Image
Selecting Linked File
Image Scaling Option
Exporting Image
Exporting Linked File

Chapter 13 - Team Collaboration

VP Teamwork Server

Starting the Teamwork Client
Checking out a Project
Checking in a Project
Updating a Project
Reverting a Project
Checking for Updates
Refresh Project List
Export Project
Import Project
Viewing the Checkin Version History
Closing the Teamwork Client
Logout the Teamwork Client

CVS and Subversion

Starting the Teamwork Client
Importing a Project to the Server
Checking out a Project
Checking in a Project
Updating a Project
Reverting a Project
Checking for Updates
Refresh Project List
Export Project
Import Project
Viewing the Checkin Version History
Closing the Teamwork Client
Logout the Teamwork Client

Appendix A - Configuring Application Options

Configuring Application Options using the Application Options Dialog Box

General
Diagramming
View
Instant Reverse
ORM
Visual Studio .NET

Appendix B - Configuring Stereotypes and Tagged Value

Introduction
Adding Stereotype to a Model Element
Configuring Stereotypes

Creating a New Stereotype
Editing a Stereotype
Using the Stereotype Specification Dialog Box
Adding Tagged Value to a Stereotype
Adding Tagged Value to a Model Element

Appendix C - Supported Mouse Gestures

Appendix D - Glossary

Visual Paradigm International Limited Website: www.visual-paradigm.com E-mail: support@visual-paradigm.com