Home > Store

Practical Code Generation in .NET: Covering Visual Studio 2005, 2008, and 2010

Register your product to gain access to bonus material or receive a coupon.

Practical Code Generation in .NET: Covering Visual Studio 2005, 2008, and 2010

eBook (Watermarked)

  • Your Price: $31.99
  • List Price: $39.99
  • Includes EPUB, MOBI, and PDF
  • About eBook Formats
  • This eBook includes the following formats, accessible from your Account page after purchase:

    ePub EPUB The open industry format known for its reflowable content and usability on supported mobile devices.

    MOBI MOBI The eBook format compatible with the Amazon Kindle and Amazon Kindle applications.

    Adobe Reader PDF The popular standard, used most often with the free Adobe® Reader® software.

    This eBook requires no passwords or activation to read. We customize your eBook by discreetly watermarking it with your name, making it uniquely yours.

Description

  • Copyright 2010
  • Edition: 1st
  • eBook (Watermarked)
  • ISBN-10: 0-321-77065-X
  • ISBN-13: 978-0-321-77065-3

“Once this skill is within your everyday comfort zone, it will give your productivity a boost and increase your value to your team. I encourage you to add the techniques outlined in this book to your toolset and to use them to develop your own workbench of generative tools. In doing so, I’m confident you’ll improve your capabilities, and what’s more, have fun doing so.”

–From the Foreword by Gareth Jones, Developer Architect, Visual Studio®, Microsoft

Enlist Visual Studio’s Built-in Code Generation Tools to Write Better Software Faster

Automatic code generation can dramatically increase your productivity, improve code quality and maintainability, promote reuse, and help you extend best practices throughout your development organization. .NET and Visual Studio contain many powerful, code-generation tools--and this book shows you how to succeed with all of them. With Practical Code Generation in .NET, spend less time writing monotonous, repetitive code--leaving more time to address troublesome areas!

Microsoft MVP Peter Vogel covers code generation with Visual Studio 2010, 2008, and 2005, as well as all recent versions of .NET, including .NET 4.0. You’ll learn when enlisting code generation makes sense and how to design solutions that build on the skills and resources you already have.

Writing for experienced programmers, Vogel shows how to generate reliable code using procedural code, Visual Studio add-ins, XML, configuration files, and more--including Microsoft’s innovative CodeDOM technology for generating code in multiple languages. He brings everything together in three complete, chapter-length case studies.

Coverage includes

•¿ Understanding the structure of .NET code-generation solutions and best practices for architecting them

•¿ Creating Visual Studio add-ins that quickly integrate code generation into day-to-day activities

•¿ Using objects and methods to add or remove project components

•¿ Using text insertion to generate code using any tool--even standard string handling functions

•¿ Working with the specific features of C#, Visual Basic .NET, and ASP.NET

•¿ Generating more concise code with .NET’s new Text Template Transformation Toolkit (T4)

•¿ Building code-generation solutions with Visual Studio templates, attributes, and custom tools

•¿ Distributing code-generation solutions

Sample Content

Table of Contents

Foreword . . . xiv

Preface . . . xvi

Acknowledgments . . . xx

About the Author . . . xxi

Chapter 1 Introducing Code Generation . . . 1

Repetitive Code: Your History . . . 2

Copy-and-Paste . . . 2

General-Purpose Code . . . 3

Benefits of Code Generation . . . 4

When to Use Code Generation . . .7

Best Practices in Code-Generation Solutions . . . 10

Code-Generation Process . . . 11

Code-Generation Tools . . .12

Model-Driven Architecture, Declarative Programming, and Code Generation . . . 14

Model-Driven Architecture . . . 14

Declarative Programming . . . 17

PART I: TOOLS . . . 19

Chapter 2 Integrating with Visual Studio . . . 21

Design-Time Integration . . .22

Starting Your Visual Studio Add-In . . . 23

Laying the Foundation . . . 24

Integrating with Visual Studio . . . 27

Writing a Generation Class in Visual Studio . . . 30

Working with COM . . .31

Debugging Issues in Visual Studio 2005/2008 . . . 32

The OnConnection Method . . .34

Removing Add-In Menus . . . 35

Creating a Menu-Driven User Interface . . . 36

Extending Your Menus . . . 36

Adding Additional Menus . . . 37

Finding the Menu . . . 38

Adding the Menu Item . . . 40

Supporting Multiple Menu Items . . . 42

Creating Submenus . . .43

Adding Submenus . . . 44

Context Menus . . . 44

Accessing the Context . . . 46

Working with Visual Studio Windows . . . 49

Using the Task List Window . . .49

Retrieving Selected Items . . . 50

Writing Messages to the Output Window and the TaskList . . . 51

AutoNavigate in Visual Studio 2005 . . .55

Final Touches . . . 57

Responding to Events . . . 58

Simple Events . . . 58

Filtered Events . . . 60

Working with Document Events . . . 61

Extracting Event Packages . . . 63

Finishing Events . . . 64

Accepting Input . . . 65

Options . . . 65

Creating a Dockable Window . . .  65

Saving Input Values . . .69

Adding an Options Tab . . . 71

Accessing and Saving Option Properties . . . 73

Integrating with Visual Studio . . . 76

Chapter 3 Manipulating Project Components . . . 77

The Code Model . . . 78

Code Model Caveats . . . 79

Managing Projects and Solutions . . . 80

Creating Projects . . . 80

Referencing the Project Items Collection . . . 82

Adding Folders to a Project . . .83

Adding Files . . . 84

Copying Boilerplate Code . . . 86

Generating Code . . . 86

Introducing CodeModel and FileCodeModel . . . 86

Generating Code . . . 89

Modifying and Analyzing Components . . .110

Finding Projects and Project Items . . . 110

Reading Project Properties . . .113

Removing Items . . . 113

Checking for Changes . . . 114

Processing Components in a File . . . 114

Processing All the Components in a File . . . 114

Retrieving Components by Name . . . 116

Retrieving Components by Location . . .117

Working with Retrieved Elements . . . 118

Determining If an Element Can Be Modified . . . 118

Writing Language-Specific Code . . . 119

Using CodeElement with the Position Parameter . . . 119

Choosing Interfaces . . . 120

The CodeEvent Object . . . 121

Working with the CodeType Objects . . . 121

Finding Components with CodeType . . .121

Simple CodeType Options . . .124

Working with Comments and Documentation Comments . . . 124

Working with Related Classes . . . 125

Storing Information . . . 126

Storing Strings in the Globals Object . . . 127

Working with Project Components . . . 128

Chapter 4 Modifying Code in the Editor . . . 129

Opening and Closing Documents and TextDocuments . . . 130

Accessing the Document/TextDocument . . . 130

Making the Document Available to the Developer . . . 131

Closing the Document . . .132

Backing Out Changes . . .133

Creating and Finishing a Context . . . 133

Getting Information on the Context . . . 135

Creating EditPoints to Access Text . . . 135

Retrieving EditPoints with the TextDocument . . . 136

Retrieving EditPoints with the FileCodeModel . . . 136

Retrieving CodeElements from Text . . . 138

Retrieving Information . . .139

Document and TextDocument Objects . . . 139

Document Object Only . . . 140

EditPoint . . .140

Accessing Text with an EditPoint . . . 140

Retrieving Text . . . 141

Relocating the EditPoint . . . 143

Finding Text . . . 144

Finding Text with Regular Expressions . . . 146

Working with Bookmarks . . . 147

Creating Bookmarks . . . 147

Inserting, Replacing, and Formatting Text . . . 149

Inserting and Deleting Text . . .149

Replace Selected Text . . . 150

Bulk Insertions . . . 151

Cleaning Up after Insertions . . .  151

Bulk Replacements . . .152

Controlling the Text Being Displayed . . .153

Formatting Code . . . 154

Smart Formatting . . . 154

Controlled Indenting . . . 154

Inserting and Reading Text . . . 155

Chapter 5 Supporting Project-Specific Features . . . 157

Introducing the VSLangProj Libraries . . . 158

Working with Projects . . . 160

Reference Objects . . .170

Managing a “Projectless” Website . . . 170

Working with the Website . . .171

Adding New Components . . .172

Working with Website Items . . . . 179

Project-Specific Features . . .. . . 180

Chapter 6 Generating Language-Neutral Code . . . 181

A Comprehensive Example . . . 182

The Code to Be Generated . . . 183

Using Variables, Data Types, and Literals . . . 184

Creating Namespaces and Classes . . .185

Adding Methods with Parameters . . . 186

Adding Statements to Methods . . . 187

Generating Code . . . 188

Declarations . . . 189

Local Scalar Variables . . . 190

Arrays . . . 193

Delegates . . . 195

Defining Classes . . . 197

Inheritance and Interfaces . . .198

Generics and Partial Classes . . . 199

Class Members . . . 200

Fields . . . 200

Methods . . . 201

Parameters . . . 205

Events . . . 206

Constructors . . . 211

Entry Points . . . 213

Properties . . . 214

Creating an Indexer . . . 216

Statements and Expressions . . . 216

Expressions . . . 217

Statements . . . 224

Code Structures . . . 228

If...Then . . . 228

For Loops . . . 229

Try...Catch . . . 232

When All Else Fails: Code Snippets . . . 235

Snippet Expressions and Statements . . .236

Compile Units . . . 237

Other Code Features . . . 238

Generating Valid Names . . . 238

Adding Comments . . . 239

Adding Custom Attributes . . . 240

Using Directives to Organize Code into Regions . . . 241

UserData (Option Strict and Option Compare) . . . 242

Code Providers . . . 243

Generating Code . . . 243

Generating Partial Code . . . 246

Compiling Code . . . 246

Generating Code . . . 247

Chapter 7 Generating Code from Templates with T4 . . . 249

T4 in Visual Studio . . . 251

T4 Code-Generation Strategies . . . 252

Options for Extending T4 . . . 253

The T4 Process . . . 253

Creating a T4 Template . . . 254

Escape Characters . . . 257

Directives . . . 258

Adding Helper Methods . . . 261

Generating Errors and Warnings . . . 263

Review . . . 264

Accessing the Generated Code . . .  264

Controlling Code Indentation . . .  264

Extending T4 . . . 265

Creating a New Base Class . . .  265

Defining Custom Directives . . .  267

Invoking Templates from Code . . .  270

Configuring the Project . . . 271

Invoking the Template Using the Visual Studio Host . . . 272

Invoking the Template with a Custom Host . . . 273

Defining a Custom Host . . .274

Adding Custom Methods to the Host . . .280

Passing Parameters to a Template . . . 281

Supporting Custom Directives . . . 282

Leveraging Templates . . .283

Chapter 8 Other Tools: Templates, Attributes, and Custom Tools . . . 285

Item Templates . . . 286

Using the Wizard . . . 287

Template Components . . . 290

Modifying/Creating a Template Control File . . . 293

Attributes . . . 305

Introducing Attributes . . . 306

Creating a Custom Attribute . . . 308

Processing Attributes with Reflection . . . 311

Documenting with Attributes . . . 315

Generating Code from Custom File Formats . . . 315

Setting Up the Project . . . 316

Integrating Custom Tools . . . 323

Reviewing the Tools . . . 329

PART II: CASE STUDIES . . . 331

Chapter 9 Case Study: Generating a Connection String Manager . . . 333

Defining the Problem . . . 334

A Model Solution . . . 335

Supporting Customization . . . 337

Setting Up the Add-In . . . 337

Defining the Add-In . . . 337

Creating the Menu . . . 338

Calling the Solution . . . 342

Creating the Code Generator . . . 343

Finding the Project . . . 344

Does Anything Need to be Done? . . . 345

Segregating Generated Code . . . 346

Adding the Template . . . 349

Customizing the Template . . . 350

Fixing the Namespace . . . 352

Modifying the Class . . . 353

Adding a Reference . . . 355

Generating Code . . . 355

Reading Input . . . 356

Processing the Configuration File . . . 357

Adding Property Code . . . 358

Notifying the Developer . . . 359

Defining the Output Utility . . . 359

Handling the Task List . . . 360

Using the Output Method . . . 361

Supporting Customization . . . 362

Customizable Code . . . 362

Accepting Input . . . 363

Defining the Options Dialog . . . 363

Saving Developer Choices . . . 364

Option Manager Class . . . 365

Creating the User Control . . . 366

Implementing the User Control Interface . . . 367

Integrating with the Add-In . . . 369

Generating Custom Code . . . 370

Adding Custom Code . . . 371

Tying Generation to Events . . . 371

Integrating with Builds . . . 372

Integrating with Documents . . . 373

Generating a Simple Class . . . 375

Chapter 10 Case Study: Generating Validation Code . . . 377

Defining the Problem . . . 378

The Dedicated Code Solution . . . 378

The Generalized Code Solution . . . 380

The Generated Code Solution . . . 380

Creating the Validator . . . 382

The EventArgs Parameter . . . 386

Creating Other Code-Generated Validators . . . 387

Adding the Validator to the Toolbox . . .387

Starting the Code-Generation Project . . . 388

Wiring Up the Add-In . . .389

Creating a Submenu . . . 390

Handling Multiple Documents in Events . . . 392

Starting the Generation Utility . . . 395

Responding to the Add-In . . .395

Defining a Template . . . 397

Generating Code . . . 400

Starting the Process . . . 400

Managing the Code-Generation Process . . . 402

Utility Methods . . . 404

Processing the Validators . . . 407

Inserting Code . . . 410

Specifying Code with the CodeDom . . . 411

Generating the Lookup Methods . . . 412

Generating Code in the Target Language . . . 421

Supporting “Projectless” Websites . . . 421

Adding Code . . . 422

Handling Errors . . . 425

Building a Complete Code-Generation Solution . . . 426

Chapter 11 Case Study: Generating Data-Conversion Code . . . 427

Defining the Problem . . . 428

Creating the Designer . . .432

Building the Designer . . . 435

Adding Items to Your Designer . . . 439

Adding Domain Properties . . . 440

Adding an Enumerated Data Type . . . 441

Adding Relationships to Support Connections . . . 441

Adding Graphical Items . . . 442

Adding Toolbox Items . . . 446

Validation, Generation, and Test . . . 447

Enhancing Model Validation . . .450

Enabling Validation . . . 450

Adding Validation Code . . . 452

Other Options . . . 454

Generating Code . . . 454

Configuring the Template . . . 455

Distributing Your Designer . . . 458

Converting the Template to a Custom Tool: Visual Studio 2005/2008 . . .459

Preloading the Custom Tool Property . . .462

Create a Deployment Project: Visual Studio 2005/2008 . . . 464

Deploying: VS2010 . . .465

Visual Studio 2010 Additions . . .  465

Capturing Inputs . . . 466

PART III: APPENDIXES . . . 467

Appendix A Generating Menu Names . . .468

Appendix B Options Dialog Categories, Subcategories, and Properties . . . 469

Appendix C A Code-Generation Add-In . . . 470

Integrating Code-Generation Classes . . . 470

Adding the Submenu Button . . . 471

Responding to Events . . . 475

Responding to the Menu Button . . . 479

An Extensible Solution . . . 479

Appendix D Distributing Code-Generation Solutions . . . 481

Creating the .vscontent File . . . 481

Adding Add-Ins . . . 482

Adding Templates . . . 482

Adding a Toolbox Control . . .484

Adding Files . . . 484

A Complete Example . . .485

Installing the Solution . . .486

Index . . . 487

Updates

Submit Errata

More Information

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020