Tag Property (FpSpread)

Visual Basic
C#

'Declaration
 
Public Shadows Property Tag As Object

'Usage
 
Dim instance As FpSpread
Dim value As Object
 
instance.Tag = value
 
value = instance.Tag

public new object Tag {get; set;}

Property Value

Object containing the application tag

The tag is only for the application's use; the spreadsheet does not use this information in working with the data. The information in the tag is stored separately from the information provided in the text or the value or the note.

You can assign user-defined information to any cell, column, row, sheet, or the entire component. The information in the tag is not composited from these different levels.

This property is available at run time only. (The Properties window uses a TypeConverter object to convert property values to and from strings for editing in the grid. The framework provides some converters for types defined in the framework, and there are converters for all of the intrinsic data types, except for Object. Since Object does not have a type converter, the Properties window is unable to edit values for properties of type Object, and these properties are displayed as read-only and are grayed out.)

This example sets the application-specific tag for the Spread component.

C#

FarPoint.Win.Spread.FpSpread fpSpread1 = new FarPoint.Win.Spread.FpSpread();
FarPoint.Win.Spread.SheetView shv = new FarPoint.Win.Spread.SheetView();
fpSpread1.Location = new Point(10, 10);
fpSpread1.Height = 200;
fpSpread1.Width = 400;
Controls.Add(fpSpread1);
fpSpread1.Sheets.Add(shv);
fpSpread1.Tag = "TestTag";
listBox1.Items.Add(fpSpread1.Tag.ToString());

Visual Basic

Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
fpSpread1.Location = New Point(10, 10)
fpSpread1.Height = 200
fpSpread1.Width = 400
Controls.Add(fpSpread1)
fpSpread1.Sheets.Add(shv)
fpSpread1.Tag = "TestTag"
ListBox1.Items.Add(fpSpread1.Tag.ToString())

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

FpSpread Class
FpSpread Members
GetTag Method
SetTag Method

User-Task Documentation

Adding a Tag to a Cell