Thursday, December 27, 2007

Access Assembly file and get Product informations

Hi Guys

We have good features in the .net based on the application version and customizations. Basically dot net provide unique assembly file for the common setting within the Projects. And we can play with that file within code as well. How I can say that? The dot net give few attributes based on the assembly manipulations. Let say we want to know the current version of the Product, so we want to access assembly file and get answer from that file. Since when we try access that product version attribute in the assembly file, we must use the AssemblyVersionAttribute attribute.

And lot’s customization attribute exist in the .net class library based on the assembly file.

List of commonly using attributes.

1. 1.AssemblyTitleAttribute

2. 2.AssemblyCompanyAttribute

3. 3.AssemblyVersionAttribute

4. 4.AssemblyProductAttribute

5.5 5.AssemblyCopyrightAttribute

6. 6.AssemblyDescriptionAttribute

Now see, somebody can know how use those attribute with our coding .somebody may be can’t know. This article provides simple class with commonly using attribute, and gets information from the assembly about the product.

Let’s see the class.

using System;

using System.Collections.Generic;

using System.Text;

using System.Reflection;

namespace AccessAssembly

{

public class ApplicationDetails

{

static string companyName = string.Empty;

///

/// Get the name of the system provider name from the assembly

///

public static string CompanyName

{

get

{

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyCompanyAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

companyName = ((AssemblyCompanyAttribute)customAttributes[0]).Company;

}

if (string.IsNullOrEmpty(companyName))

{

companyName = string.Empty;

}

}

return companyName;

}

}

static string productVersion = string.Empty;

///

/// Get System version from the assembly

///

public static string ProductVersion

{

get

{

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyVersionAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

productVersion = ((AssemblyVersionAttribute)customAttributes[0]).Version;

}

if (string.IsNullOrEmpty(productVersion))

{

productVersion = string.Empty;

}

}

return productVersion;

}

}

static string productName = string.Empty;

///

/// Get the name of the System from the assembly

///

public static string ProductName

{

get

{

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyProductAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

productName = ((AssemblyProductAttribute)customAttributes[0]).Product;

}

if (string.IsNullOrEmpty(productName))

{

productName = string.Empty;

}

}

return productName;

}

}

static string copyRightsDetail = string.Empty;

///

/// Get the copyRights details from the assembly

///

public static string CopyRightsDetail

{

get

{

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyCopyrightAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

copyRightsDetail = ((AssemblyCopyrightAttribute)customAttributes[0]).Copyright;

}

if (string.IsNullOrEmpty(copyRightsDetail))

{

copyRightsDetail = string.Empty;

}

}

return copyRightsDetail;

}

}

static string productTitle = string.Empty;

///

/// Get the Product tile from the assembly

///

public static string ProductTitle

{

get

{

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyTitleAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

productTitle = ((AssemblyTitleAttribute)customAttributes[0]).Title;

}

if (string.IsNullOrEmpty(productTitle))

{

productTitle = string.Empty;

}

}

return productTitle;

}

}

static string productDescription = string.Empty;

///

/// Get the description of the product from the assembly

///

public static string ProductDescription

{

get

{

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyDescriptionAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

productDescription = ((AssemblyDescriptionAttribute)customAttributes[0]).Description;

}

if (string.IsNullOrEmpty(productDescription))

{

productDescription = string.Empty;

}

}

return productDescription;

}

}

}

}

Let see simple explanation get product description from the assembly file

public static string ProductDescription

{

get

{

//get the entry assebly file for the product

Assembly assembly = System.Reflection.Assembly.GetEntryAssembly();

if (assembly != null)

{

//now get the customattribute for the AssemblyDescriptionAttribute

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyDescriptionAttribute), false);

if ((customAttributes != null) && (customAttributes.Length > 0))

{

productDescription = ((AssemblyDescriptionAttribute)customAttributes[0]).Description;

}

if (string.IsNullOrEmpty(productDescription))

{

productDescription = string.Empty;

}

}

return productDescription;

}

}

We want to get all custom attribute from the assembly file based on the AssemblyDescriptionAttribute .

object[] customAttributes = assembly.GetCustomAttributes(typeof(AssemblyDescriptionAttribute), false);

After access the first attribute in the collections, and get the value from that

productDescription = ((AssemblyDescriptionAttribute)customAttributes[0]).Description;

That’s it. and enjoy

Con

The .net provides a good customization based on the assembly file. So please try access all other attributes in the assembly file and enjoy.

Best Regards
RRave

MCTS/MCPD

1 comment:

vb_dude said...

Well done and thanks!

However, in VB.net the example has several flaws. First of all, "GetEntryAssembly" does not exist and I had to use "GetExecutingAssembly" instead. Second, version info cannot be retrieved using the code above -- it returns an empty string. You can however get the version info by, in VB, using "assembly.GetName().Version.ToString". See also here: http://stackoverflow.com/questions/1144525/getcustomattribute-returns-null-for-assemblyversionattribute

Apart from these minor issues, thank you very much!