|
|
|
Borland® Together®
Edition for Microsoft® Visual Studio®
.NET (version 2.0)
Updated: June 9, 2004
Welcome! Thank you for choosing Borland Together Edition
for Microsoft Visual Studio .NET 2.0 (Together VS .NET). Together VS .NET
provides modeling functionality to complement Microsoft®
Visual Studio® .NET 2003 (Visual Studio .NET). The features
provided by Together VS .NET include:
- UML modeling
- LiveSource for C# and Visual Basic .NET projects (simultaneous
round-trip engineering)
- Pattern support
- Refactoring support for C# projects
- Roundtrip engineering for sequence diagrams in C# projects
- Audits for C# projects (Quality Assurance)
- Documentation generation
- XMI import/export
Important: Together VS .NET requires that you
already have Microsoft Visual Studio .NET 2003 and the Visual Studio .NET
Language Tools, Visual C# .NET and/or Visual Basic .NET, installed and
available.
It is recommended that you read these instructions
entirely before installing Together VS .NET.
Note: The information in this readme represents
known issues at the time of this release. For late-breaking information
that may become available after the release, check the Borland web site
for the most recent version of this readme: http://info.borland.com/techpubs/together/.
What's
New
This release of Together VS .NET includes new features
and improvements to existing functionality. The issues addressed in this
release are described in the What's New
file located in the Docs directory of your Together VS .NET installation:
$Together_VS_.NET_Home$/Docs/what's_new.html.
Back to top.
System
Requirements
Resource
|
Requirements
|
Notes
|
IDE Platform |
Microsoft Visual Studio .NET 2003 (Visual
Studio .NET) |
Together VS .NET requires that Visual
Studio .NET is installed and available. Together VS .NET also requires
that the Visual Studio .NET Language Tools, Visual C# .NET and/or
Visual Basic .NET, are installed and available.
For Visual Studio .NET system requirements and support, consult your
Visual Studio .NET readme and installation documents.
|
CPU |
Pentium III/500 MHz or higher |
|
Memory |
512 MB minimum |
1 GB is recommended |
Disk Space |
30 MB of hard disk space |
This is in addition to the disk space required by Visual Studio .NET. |
Video |
SVGA, high color mode, 1024x768 |
Recommended resolution: 1280x1024 or more |
Supported Operating Systems |
Microsoft® Windows® 2000 (SP2 or higher)
Windows XP Professional
Windows Server 2003
|
Service Pack 2 or higher required for Windows 2000
|
Back to top.
Prerequisites for enabling the Japanese UI in Together VS.NET
If installing the Japanese version of Together VS .NET, your system must
meet the following prerequisites to enable the Japanese UI:
- The Japanese version of Windows 2000, Windows XP, or Windows Server
2003 must be installed, or the Japanese MUI for Windows 2000, Windows
XP, or Windows Server 2003 should be installed for non-Japanese versions
Windows 2000, Windows XP, or Windows Server 2003, respectively.
- The Japanese version of Microsoft® Visual Studio®
.NET 2003 must be installed.
- The location in the Windows Regional Options settings must
be set to Japanese.
- The language for non-Unicode programs (for Windows XP and Windows
Server 2003) or System Locale (for Windows 2000) in the Regional
Options settings should be set to Japanese.
- For Windows XP and Windows Server 2003 users, the Standards and
formats property must be set to Japanese in the Regional Options
settings.
- Choose Japanese from the Together VS .NET installer (see Installation
below). Otherwise, the English language version of Together VS .NET
is installed.
NOTE: If the user fails to meet these requirements,
the user interface displays in English.
Back to top.
Installation
The instructions that follow assume that you have installed
Visual Studio .NET.
- Launch the executable file, either from an installation CD or the
location to which you downloaded the web-based file.
- If downloaded, double-click on the file to begin installation.
- Choose a language for the installer from the drop down list (English
(United States) or Japanese), and press OK.
- The InstallShield Wizard opens. Click Next as prompted.
- Click the radio button to indicate acceptance of the license agreement.
Click Next.
- Enter your user name and organization information. Click Next.
- Click Change to change the path and folder name where Together
VS .NET will be installed, or accept the default directory location,
and click Next. If the directory does not exist, it will be created.
- If your preferences are acceptable, click Install.
- When the InstallShield Wizard finishes, click Finish.
Back to top.
Licensing and Registering Together
VS .NET
For licensing instructions, see Licensing
and Registering Together VS .NET in the Docs directory of your
Together VS .NET installation: $Together_VS_.NET_Home$/Docs/setting_up_licensing.html.
Back to top.
Starting Together VS .NET
Choose one of the following options to start Together
VS .NET:
- Choose Start | Programs | Microsoft Visual Studio .NET 2003 |
Microsoft Visual Studio .NET 2003.
- Run the following from the <drive>:\Program Files\Microsoft
Visual Studio .NET 2003\Common7\IDE directory: devenv.exe.
Back to top.
Uninstalling Together VS .NET
To uninstall Together VS .NET:
-
Choose Start | Settings
| Control Panel | Add/Remove programs.
- Select "Borland Together for Visual Studio .NET (v2.0)"
from the list.
-
Click Remove.
-
The Add/Remove Programs
dialog opens. Click Yes to uninstall.
Refer to the Microsoft Visual Studio .NET 2003 (Visual
Studio .NET) documentation for known Visual Studio .NET issues. The sections
below describe the known issues and limitations related to Together VS
.NET.
General
-
The installer crashes with installing Together VS
.NET to a UNC path (for example, \\servername\path) with improper
security permissions.
-
In sequence diagrams, the message label is not renamed
if you rename its associated method in the source code. As a workaround,
rename the method on the class diagram in the Diagram View or Model
View.
-
After using cut/copy/paste or drag and drop to move
a diagram from one container to another in the Solution Explorer,
the Model View is not updated. After reopening project, the Model
View is updated.
-
It is not possible to drag and drop or cut/copy/paste
constructors or destructors between classes in the Diagram or Model
Views.
-
Renaming a class using the Class View does not
immediately reflect the new class name in the Diagram or Model Views.
Use the Reload command to see the changes. To use the Reload
command, right click on the root project node in the Together VS .NET
Model View, and choose Reload. You can also open the corresponding
source code file in the Editor and make a change in it to show the
changes made in the Class View.
- Together VS .NET does not check for identical signatures; therefore,
it is possible for a user to create a function/method with identical
signatures in the same class, structure (in C# projects only), or interface.
- It is not possible to explicitly declare or view an underlying enum
type in the Diagram or Model Views. You can edit the type in the Visual
Studio .NET editor.
- It is not possible to draw source code links, such as, generalization
or association links, between classes from different projects until
the referenced project has been compiled.
- It is not recommended to exclude the Model Support folder or namespace
diagram files from a project. If these items are excluded, the diagrams
disappear from the Model View.
- After copying and pasting a classifier that is used with other classifiers
of the source namespace (where this classifier is from) from a nested
namespace to an upper-level namespace, the names of the used classifiers
will not be updated by adding a name of the nested namespace.
- When using drag-and-drop to to move a field that has another field
as its initial value, the field is not updated when it is moved to another
class.
- If you rename a namespace containing a class diagram with source code
element shortcuts in it three consecutive times, after the third renaming,
all source code element shortcuts are lost in the class diagram. Use
the Undo (CTRL+Z) operation or reopen the project to restore the lost
elements.
- A corrupted Together VS .NET installation may not always be correctly
recovered after reinstalling Together VS .NET. As a workaround, you
can run "devenv /setup" at the end of recovering, or try to
remove Together VS .NET and install it again.
C#-specific
- Running audits against large projects may be time consuming. As a
workaround, try generating audits against a smaller piece of the project.
- It is not possible to set the abstract property for a C# property-like
event.
- During sequence diagram generation, the following code elements are
not recognized: calls to properties, calls to creation of delegates,
clearing/registering of events, and accessing of indexers.
- When renaming a class, the return type for methods with implicit or
explicit operators are not renamed correctly if the return type for
the method is set to the class that is being renamed. Renaming a class
does not propagate to signatures of such methods.
- When using the Rename refactoring, links to the source code elements
are lost for objects instantiated with classifiers and message links
that have the operation property set.
- When working with unsafe code, such as, pointers and references to
pointers:
- References to fields via pointers in unsafe code are unresolved.
- Refactoring commands are not applied to unsafe code.
Visual Basic .NET-specific
- If an incorrect syntax is used for implementation or inheritance in
the source code, the classifier does not display in Together VS .NET
although it is still recognized by Visual Studio .NET.
- When the signature of a method implementing an interface method is
not the same as the signature of the interface method, the method of
the class is lost from the code model.
- If you have more than one overloaded property, only one overloaded
property displays in the Diagram and Model Views.
- Structures, events, and fields with the withevents keyword are currently
not supported by Together VS .NET. These code elements will not display
in the Diagram or Model Views.
- If you incorrectly set the Implements field of a method to an incorrect
value, the method disappears from the model. You can restore the element
in the model by correctly renaming the Implements value in the source
code editor.
- If you set an invalid initial value to a const, the const disappears
from its classifier in Together VS .NET.
- Use the Reload command (right click on the root project node
in the Together VS .NET Model View, and choose Reload) when encountering
the following problems in Together VS .NET:
- After changing the root namespace property for a Visual Basic .NET
project, the Together VS .NET Model View hierarchy will not show the
actual namespace hierarchy and could have inadequate internal data
for the new structure. After changing the root namespace property,
prior to making any changes with Together VS .NET, use the Reload
command.
- Changes made to elements semantically bound to each other through
an inheritance chain are not handled. For example, when setting the
Implements property for a function in a class so that it implements
a function in an implemented interface of that class, if you make
any changes to the function in the interface, such as, changing its
name, parameters, or return type, the elements are no longer bound
to each other, and the function in the class does not respond to any
changes. It does not matter if you make these changes in Together
VS .NET or in the Visual Studio .NET editor -- the result is the same.
As a workaround, correct the problem using the Visual Studio .NET
Editor, and then use the Reload command in Together VS .NET.
This action refreshes the model from the Visual Studio .NET code model
and removes the invalidated elements.
- If you accidentally change your code allowing a public class to
inherit from an internal class, the public class becomes unresponsive
in Together VS .NET. Correct the code in the Visual Studio .NET Editor,
and then use the Together VS .NET Reload command.
- It is not possible to add a source code element if its container
contains a broken element with the same type. For example, if you
have added a class to a namespace diagram and there is some error
with that class, such as, incorrect inheritance, this makes the class
unresponsive, and you cannot add a new class or a new namespace element
to that namespace diagram. As a workaround, use the Together VS .NET
Reload command. Once the project reloads, elements are properly
added.
- Changing the root namespace property in Visual Studio .NET can cause
the following problems:
- If you have written fully qualified names to the root namespace
of your project for classifiers either in an inheritance list of a
class or as a type of its members, and you change the root namespace
property for the project, the new root namespace name will not replace
the old one in fully qualified names, and the code becomes incompilable.
You should manually correct the code in the Visual Studio .NET editor.
- If you change the root namespace value property for a project to
a non-empty value, the old root namespace folder and its contents
are not processed by Together VS .NET. The old root namespace and
its contents will not be included into the model although the folder
and diagrams are included in the project. As a workaround, manually
copy the diagrams into the the newly-created root namespace folder.
- If you have a lower-level namespace that has the same name as an upper-level
namespace, attempting to rename the lower-level namespace renames the
upper-level namespace instead.
As a workaround to this problem:
- Rename the upper-level namespace to a temporary name.
- Rename the lower-level namespace.
- Restore the original name for the upper-level namespace.
XMI import/export
- The Rational XMI Plugin version 1.3.2 is supported. Full support for
Rose XML Tools will be provided in a future release.
- XMI import for large projects is time consuming.
- When using XMI Export for Visual Basic .NET projects, data types for
source code elements might not be correctly recognized.
- Together VS .NET currently does not import XMI files generated by
Rational XDE.
Generating documentation
-
Due to Internet Explorer limitations, large diagrams
may not be shown when generating project documentation.
- If you generate documentation with the window for the CaliberRM integration
open, Visual Studio .NET will crash if a user has the Sun J2RE 1.4.x
installed and does not have the MS JVM installed and the generated documentation
opens in the Visual Studio .NET internal browser. If Sun J2RE 1.3.x
is installed, there is no problem. As a workaround, there is an option
setting available in Together VS .NET so that you can choose whether
to use the internal Visual Studio .NET browser or an external browser
to view generated documentation. By default, Together VS .NET uses an
external browser to view generated documentation. The option, Use
Internal Browser, is available in the Options dialog under the Together
VS .NET/Generate Documentation options.
Migrating from previous versions
- When opening projects created with previous versions of Together VS
.NET, activate Together VS .NET support manually. Choose Project
| Together VS .NET Support from the main menu. The Model Support
dialog opens. Check the flags for the projects where you need modeling.
- User-created patterns in the previous versions of Together VS .NET
will not be added automatically when installing Together VS .NET 2.0.
Add the patterns manually using the Pattern Organizer in Together VS
.NET. Choose Tools | Together VS .NET | Pattern Organizer from
the main menu to add the patterns.
Recommendations
- Avoid declaring several fields in a single line of source code (for
example, in C# projects, int i, j; or in Visual Basic .NET projects,
Dim i, j). Make individual field declarations instead.
- Do not use the Solution Explorer to rename or otherwise modify the
diagrams. Use the Model View instead.
- Using the Rename command for a class does not propagate the name changes
in dependent projects. As a workaround for C# projects, use the Refactoring
| Rename command instead.
- You can use the Reload command to refresh the Together VS .NET
model from the Visual Studio .NET code model. This command provides
a total refresh for the elements and removes invalid code elements from
the model. Using this command has the same effect as reopening the solution,
but avoids the overhead of reinitializing Visual Studio .NET. You should
use the Reload command as a workaround for issues that might
appear while making changes in Together VS .NET that cause some elements
on the diagram to stop responding or if you get errors from Together
VS .NET, such as, <undefined value>. Usually, when these
problems occur, the elements also disappear from the Visual Studio .NET
Class View and the corresponding source code is underlined in blue in
the Visual Studio .NET editor. Unfortunately, Together VS .NET cannot
always properly handle such elements that become broken. In order
to bring them back to a normal state, it is necessary to edit the code
in the text editor according to the recommendation shown in the Visual
Studio .NET Editor. In these cases, it is best to refresh the model
using the Reload command in order to prevent possible further
misbehavior. To use the Reload command, right click on the root
project node in the Together VS .NET Model View, and choose Reload.
This action refreshes the model from the Visual Studio .NET code model
and removes any invalidated elements.
Back to top.
Finding Out More
Together VS .NET provides a Getting Started Guide in
PDF format as well as online help (including Dynamic Help) that integrates
tightly with the Visual Studio .NET environment. Updated documentation
is also available on the Borland Together Technical Publications website.
Refer to the sections below for more information.
Getting Started
Guide
You can find the Getting
Started Guide for Borland Together Edition for Microsoft Visual Studio
.NET covering the major features in Together VS .NET
in the Docs directory of your installation: $Together_VS_.NET_Home$/Docs/gettingStarted.pdf.
Online Help
Together VS .NET provides online help through the Visual Studio .NET Contents pane. From the main menu, select Help > Contents.
When the contents pane opens, click Borland Together Edition for Microsoft
Visual Studio .NET. Expand the nodes to see the different help sections.
Documents on Our Website
The latest version of this readme file, the Borland
Together Edition for Microsoft Visual Studio .NET Getting Started
Guide, and other documentation is available on our website: http://info.borland.com/techpubs/together/.
Back to top.
Getting Help
If you have questions about Together VS .NET, visit
Borland Technical Support at http://support.borland.com.
Back to top.
|
|