Custom Property in Excel using VBA, C#, VB.Net example CustomProperty sheet metadata example

CustomProperty

Helps to create identifier with key, value format which helps developer to tag information within internal XML metadata of a Excel sheet. In this article we will see how we can create a custom property and retrieve a property. Use the Add method or the Item property of the CustomProperties collection to return a CustomProperty object.

After a CustomProperty object is returned, you can add metadata to worksheets by using the CustomProperties property of the Worksheet object with the Add method.

In this article we are using VSTO (Visual Studio Tools for office) in both flavors (C#, VB.Net) and VBA (Visual Basic for Applications) hence following prerequisites are recommended:

Prerequisites

Visual Studio 2015 or above having Microsoft Office for Developer Tool installed
Create Excel Addin in C# or VB code style (Visual Studio Tools for Office)
Excel 2010 or above
Create a ribbon designer and put button

C# code example

private void btnCustomProperty_Click(object sender, RibbonControlEventArgs e)
{
	//Bind sheet reference
	excel.Worksheet oWorksheet = Globals.ThisAddIn.Application.ActiveSheet;

	//add property
	oWorksheet.CustomProperties.Add("Site_Name", "VBAOVERALL");

	//Pull custom properties from sheet
	excel.CustomProperties oCustomProperties = oWorksheet.CustomProperties;

	//Iterate each property
	foreach (excel.CustomProperty oCustomProperty in oCustomProperties)
	{
		//Read property
		Console.WriteLine("Custom Property Name-" + oCustomProperty.Name);
		Console.WriteLine("Custom Property Value-" + oCustomProperty.Value);
	}
	
}

VB.Net code example

Private Sub btnColorStop_Click(sender As Object, e As RibbonControlEventArgs) Handles btnColorStop.Click
	'Bind sheet reference
	dim oWorksheet As excel.Worksheet
	oWorksheet = Globals.ThisAddIn.Application.ActiveSheet

	'add property
	oWorksheet.CustomProperties.Add("Site_Name", "VBAOVERALL")

	'Pull custom properties from sheet
	Dim oCustomProperties As excel.CustomProperties
	oCustomProperties = oWorksheet.CustomProperties

	'Iterate each property        
	For Each oCustomProperty As excel.CustomProperty In oCustomProperties
		'Read property
		Console.WriteLine("Custom Property Name-" + oCustomProperty.Name)
		Console.WriteLine("Custom Property Value-" + oCustomProperty.Value)
	Next
End Sub

VBA code example

Public Sub CreateCustomProperty()
    'Bind sheet reference
    Dim oWorksheet As Worksheet
    Set oWorksheet = ActiveSheet

    'add property
    oWorksheet.CustomProperties.Add "Site_Name", "VBAOVERALL"

    'Pull custom properties from sheet
    Dim oCustomProperties As CustomProperties
    Set oCustomProperties = oWorksheet.CustomProperties

    'Iterate each property
    Dim oCustomProperty As CustomProperty
    For Each oCustomProperty In oCustomProperties
        'Read property
        Debug.Print "Custom Property Name-" & oCustomProperty.Name
        Debug.Print "Custom Property Value-" & oCustomProperty.Value
    Next
End Sub

Output

Please leave your comments or queries under comment section also please do subscribe to out blogs to keep your self upto date.

Share on Facebook

VBA Basic and Advanced Questions and Answers

Basic Q&A Q. VBA stands for? Ans: Visual Basic for Applications Q. What is VBA? Ans: VBA (Visual Basic for Applications) is a scripting language. It can be used to automate most of the Microsoft Office Applications like Excel, Word, PowerPoint, MS Access, Outlook etc. Q. Types of available modules in VBA VBA contains four […]

Export Generic Collection to PDF ASP.Net Core MVC

PDF Sometime you may in need to export data in PDF. Following code will use Syncfusion Package and give you ready made Table pushed from Generic collection. Put below code in Repository Put below code in Controller JavaScript Code Finally you can attach id to an element in html and in JavaScript on Document ready […]

Export Excel ASP.Net Core MVC

Excel Export Following Example helps you to export excel from database in a generic way using EPPlus library. Requirement EPPlus Nuget Package Code to Repository Supporting Method Code to Controller Code to JavaScript JavaScript Supporting Method You can hit ExportToExcel() call in document ready method in JavaScript document by pointing any id written in HTML […]

Save/Retrieve Session ASP.Net Core MVC

Session Plays a vital role while dealing with caching in your browser. ASP.Net Core offers Session caching fast and reliable way. Here is the practical example. Put following code anywhere in common class or Repository, it has two methods Generic in nature Add/Get. Add Method will allow you to cache object in Browser memory and […]

Number List in Word Document using C# code example

Number List Microsoft Word offers feature by which you can auto number your list in various formats. In this article we will write code to dynamically generate a numbered list in a document using C#. C# Code example Note: You have to add Microsoft Word Interop library as reference to enable Using statement or create […]

Sorting in Microsoft Word using VBA (Visual Basic for Applications)

Sorting Do you know, Microsoft Word has capability to perform sorting over a document. In this article we will write code to sort paragraphs in Alphabetical order using visual basic for applications code. Before code Code example Put above code in a module, Select number of paragraphs that you would like to sort in A-Z […]

EPPlus Open Office Xml Office solution using C#

EPPlus Is an open Office XML solution, highly useful library capable to manipulate Microsoft Excel similar to Introp APIs. Why EPPlus? As per Microsoft the solutions (Excel, Word, PowerPoint, Outlook etc) built for client architecture but what about Servers? Let’s take an example that I have recently faced and EPPlus helped me a lot here. […]

String vs StringBuilder C#.Net with code example

String C# class which offers capability to store any type of string data into a variable. Strings are immutable (non-modifiable) cause performance overhead because each time we modify a string it creates a copy of modified instance into the memory, hence, as a practice string should be avoided for large string operations. Following is the […]

Var vs. Dynamic C# with code example

Var vs. Dynamic C# offers variety with flavors to accomplish the task to the developers. var keyword defines a static nature which gets resolve at compile-time introduced in C# 3.0 where dynamic gets resolved at runtime introduced in C# 4.0. Var is a statically type variable, which means values of these variables gets decoded at […]

Multi-threading in C#.Net with step by step code example

Multi-threading Is a concept to execute multiple tasks or process simultaneously. Basically multi-threading enables paths to your application to execute multiple processes. Multi-threading can be achieved in C# using System.Threading name space which provides complete control over threading. Let’s write example code where we will execute two different methods to print numbers using loop and […]

Custom Property in Excel using VBA, C#, VB.Net example