Basic but useful properties of Worksheet in Excel C# VSTO

Worksheet:

A worksheet looks like a database having Rows and Columns. It is a collection of cells where you manipulate the data. Excel Worksheet has many useful properties, we will refer some of them with example here:

Visibility : Hiding/Unhiding worksheet

Prerequisites:

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

Hidden example:

//get current workbook reference
excel.Workbook xlWorksheet = Globals.ThisAddIn.Application.ActiveWorkbook;
xlWorksheet.Visible = Microsoft.Office.Interop.Excel.XlSheetVisibility.xlSheetVeryHidden;

Visibility example:

//get current workbook reference
excel.Workbook xlWorksheet = Globals.ThisAddIn.Application.ActiveWorkbook;
xlWorksheet.Visible = Microsoft.Office.Interop.Excel.XlSheetVisibility.xlSheetHidden;

Type : This property refers to a Sheet Type (Please refer post Get List of Unsupported Sheet in C# VSTO)

Check sheet type using “Type” property :

if (xlSheet.Type == Excel.XlSheetType.xlWorksheet)
{
	return true;
}

Hidden : This property ensures to Hide/Unhide Rows/Column in a Sheet

if (xlWorkbook.Sheets[sheetName].Rows[rowIndex].Hidden!=true)
{
	xlWorkbook.Sheets[sheetName].Rows[rowIndex].Hidden = true;
}

CodeName : This is another useful property which excel offers. Consider a scenario, You are referring a sheet name in your code as a common practice. What if user goes and rename the same sheet!!! Ah!!! the code gone messy; nothing works. The solution is to refer CodeName to make it dynamic. CodeName property refers Sheet Name defined by excel not defined by user in front end.

Getting Code Name of a Sheet:

public static string GetCodeNameFromSheetName(Excel.Workbook xlBook, string sheetName)
{
	try
	{
		Excel.Worksheet xlSheet = xlBook.Sheets[sheetName];
		return xlSheet.CodeName;
	}
	catch (Exception ex)
	{
		return string.Empty;
	}
}

Let’s reverse the logic to get Sheet Name form CodeName property:

public static Excel.Worksheet GetSheetNameFromCodeName(Excel.Workbook xlBook,string sheetName)
{
	try
	{
		return (Excel.Worksheet)xlBook.Sheets[sheetName];
	}
	catch (Exception ex)
	{
		return null;
	}
}

Next>>Special/Short Hand Operators in C#

Share on Facebook

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 […]

Create a progress bar in Excel using VBA (Visual Basic for Applications)

Progress bar In this article we will create one progress bar using Excel vba with step by step example. User can change feel and look of the UserForm as per their need and mimic the logic to fit in their solution. Design Insert a user form Add one label on it and change Caption property […]

Basic but useful properties of Worksheet in Excel C# VSTO

Worksheet:

Leave a Reply Cancel reply

Number List in Word Document using C# code example

Comments vs Note Text Excel Add-in with code example

Microsoft Word End Notes with code example (VBA,VSTO)

Microsoft Word Escape Key method VBA, C#, VB.Net example

Microsoft Word PageBreaks and SectionBreaks VBA, C#, VB.Net Example

RSS feed

Subscribe to our articles