.NET 2.0. Access file in Design Time mode.

admin — Sun, 08 Apr 2007 22:02:11 GMT

Most of programmers who are dealing with ASP.NET know how to access files on the server. The common way how to do this is to use HttpContext.Current.Server.MapPath static method and get physical path of the file by passing virtual. But what if we need for instance to read some data from text file which located in our project in Design Time mode. Server.MapPath won't help us so much as our application is not hosted by IIS or Cassini and HttpContext didn't fill yet. How to get physical path of the file then? Thanks to .Net 2.0 it is simple.

For instance let's try to get physical path of the file (sample.txt) stored in the root directory of project thru server control .

To achieve our goal we need three players ISite, IWebApplication and IProjectItem.

ISite - Gets information about the container that hosts the current control when rendered on a design surface.
We have this property available in control level (Control.Site). Be aware Site property is filled only in design time mode and not available when application hosted under the IIS or Cassini.

IWebApplication - IServiceProvider based interface which provides access to Web application in Design Mode.
By using this service we have ability to access items in our projects and reading web.config file in Design Mode.

IProjectItem - Provides an interface for an item that is retrieved at design time.
Contains such information as physical path, virtual path, name etc

First we have to get IWebApplication service from the list of running services.

IWebApplication webApp = (IWebApplication)Site.GetService(typeof(IWebApplication));

Get project item by calling appropriate method.

IProjectItem item = webApp.GetProjectItemFromUrl("~/sample.txt");

Then just get information about physical path from property of IProjectItem interface.

string filePhysicalPath = item.PhysicalPath;

That is it. Easy isn't it, but big headache for the programmers who create controls and doesn't know about it. :)

Asp.Net: How to debug custom controls in Design Time mode.

admin — Tue, 03 Apr 2007 11:28:00 GMT

If you are planning to create WebControlLibrary you will certainly need to debug the code not only in normal runtime but also in Design Time mode. In case of error in a code in design time usually you see rectangle with an exception message. But of course you need to step thru the code to fined the bug. But how to do that ? Is there a way to debug a code during design time?

I am glad to say “YES”, it is possible and easy.

It will be much easier if we will do it together step by step in concrete example.

First of all lets create a test WebControlLibrary project.

Then right click on project and select property.

In the property window navigate to Debug section and switch radio button from “Start Project” (set by default) to “Start external program” and browse for devenv.exe executable of Visual Studio which you are using.

Close the property window and for testing purposes set a breakpoint in RenderContent method.

To start debugging right click on project and select “Debug --> Create New Instance”

Debug process will create an instance of Visual Studio. To test behavior of control you can choose one of your existing web projects or create new one. For now I will create fresh WebSite project. Notice that original version of Visual Studio is in Debug mode. During creation or opening web project I am suggesting to turn off any Add-ins if you are using in Visual Studio. Sometimes those tools are raising exceptions and I don’t see reason to use them during testing of design time behavior of custom control.

Now it will be maybe easier to add our assembly to the Toolbox and use it from there. It will automatically add reference of our assembly. By using Drag and Drop technique it will automatically register assembly on a page .

On Toolbox right click and select “Choose Items”.

Navigate for our assembly by using “Browse” button. Make sure that you are picking debug version of assembly (by default it will be located in Debug folder inside of Bin).

After clicking “OK” on “Choose Toolbox Items” window our custom control (or controls if you have several in project) will appear in Toolbox window of Visual Studio.

Now just find it there, drug and drop to the web page. Switch from “Source” mode of your page editor to “Design” and “the magic will appear” :)

Now add breakpoints you need, step thru code, do the stuff you are usually doing during debugging. Next time you can just run "Debug-->Create New Instance" and just choose created WebSite project.

I hope this information will help you to create nice, professional controls without any bugs :).

Have a fun.

DotNetStyling - .Net World by Armen Ayvazyan : Visual Studio, Controls

.NET 2.0. Access file in Design Time mode.

Asp.Net: How to debug custom controls in Design Time mode.