XlsWorksheetBase Class

System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet XlsWorksheetBase
Spire.Xls.Core.Spreadsheet.Charts XlsChart
Spire.Xls.Core.Spreadsheet XlsWorksheet

public abstract class XlsWorksheetBase : XlsObject, 
	INamedObject, ITabSheet, IExcelApplication, ICloneParent

Public MustInherit Class XlsWorksheetBase
	Inherits XlsObject
	Implements INamedObject, ITabSheet, IExcelApplication, ICloneParent

public ref class XlsWorksheetBase abstract : public XlsObject, 
	INamedObject, ITabSheet, IExcelApplication, ICloneParent

[<AbstractClassAttribute>]
type XlsWorksheetBase =
class
inherit XlsObject
interface INamedObject
interface ITabSheet
interface IExcelApplication
interface ICloneParent
end

	Name	Description
	ArcShapes	Gets the collection of arc shapes in the worksheet.
	ButtonShapes	Gets the collection of button shapes in the worksheet.
	CellImages	Cell image array. Read-only.
	Charts	Returns charts collection. Read-only.
	CheckBoxes	Returns inner checkboxes collection. Read-only.
	CodeName	Name used by macros to access workbook items.
	ComboBoxes	Returns collection with all comboboxes inside this worksheet. Read-only.
	Comments	Returns comments collection for this worksheet. Read-only.
	DefaultGridlineColor	Indicates whether gridline color has default value.
	FirstColumn	Gets or sets index of the first column of the worksheet.
	FirstDataColumn	Gets index of the first data column of the worksheet.
	FirstDataRow	Gets index of the first data row of the worksheet.
	FirstRow	Gets / sets index of the first row of the worksheet.
	GridLineColor	Grid line color. Examples The following code illustrates how to set the grid line color: Copy <para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set grid lines color</para><para>worksheet.GridLineColor = ExcelColors.Red;</para><para>//Save to file</para><para>workbook.SaveToFile("GridLineColor.xlsx");</para>
	GroupBoxes	Gets the group boxes in the worksheet.
	GroupShapeCollection	Get group shapes in worksheet.
	HasPictures	Indicates whether tabsheet contains any picture. Read-only.
	HasVmlShapes	Indicates whether worksheet has vml shapes. Read-only.
	HeaderFooterShapes	Header / footer shapes collection.
	Index	Returns the index number of the object within the collection of objects.
	IsPasswordProtected	True if the worksheet has been protected with password.
	IsRightToLeft	Indicates whether worksheet is displayed right to left.
	IsRowColHeadersVisible	Gets or sets whether the worksheet will display row and column headers. Default is true.
	IsSelected	Indicates whether tab of this sheet is selected. Read-only.
	IsTransitionEvaluation	Gets or sets a value indicating whether transition evaluation is enabled.
	LabelShapes	Gets the collection of label shapes in the worksheet.
	LastColumn	Gets or sets index of the last column of the worksheet.
	LastDataColumn	Gets index of the last data column of the worksheet.
	LastDataRow	Gets index of the last data row of the worksheet.
	LastRow	Gets or sets one-based index of the last row of the worksheet.
	LeftVisibleColumn	Gets/sets left visible column of the worksheet. Examples The following code illustrates how to set the left visible column: Copy <para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set left visible column</para><para>worksheet.LeftVisibleColumn = 3;</para><para>//Get left visible column</para><para>Console.Write(worksheet.LeftVisibleColumn);</para><para>//Save to file</para><para>workbook.SaveToFile("LeftVisibleColumn.xlsx");</para>
	Lines	Gets the lines of the chart.
	ListBoxes	Gets the list of list boxes in the workbook.
	Name	Returns or sets the name of the object. Read / write String.
	OvalShapes	Gets the oval shapes in the worksheet.
	Parent	Reference to Parent object. Read-only. (Inherited from XlsObject .)
	ParentWorkbook	Returns parent workbook. Read-only.
	Pictures	Pictures collection. Read-only.
	ProtectContents	Indicates is current sheet is protected.
	ProtectDrawingObjects	True if objects are protected. Read only.
	Protection	Gets protected options. Read-only. For sets protection options use "Protect" method.
	ProtectScenarios	True if the scenarios of the current sheet are protected. Read only.
	PrstGeomShapes	Gets the collection of preset geometric shapes.
	QueryTables	Gets the collection of query tables in the worksheet.
	RadioButtons	Returns inner radiobutton collection. Read-only.
	RealIndex	Index of the worksheet in the workbook (not necessary in Worksheets collection)
	RectangleShapes	Gets the rectangle shapes in the worksheet.
	ReferenceCount	Get quantity of instance references. (Inherited from XlsObject .)
	ScrollBarShapes	Gets the scroll bar shapes associated with the worksheet.
	Shapes	Shapes collection.
	SheetId	Gets or sets sheetId for this sheet.
	SpinnerShapes	Gets the spinner shapes in the worksheet.
	TabColor	Tab color.
	TabColorObject	Tab color.
	TabKnownColor	Tab excel color.
	TextBoxes	Returns inner textboxes collection. Read-only.
	TopVisibleRow	Gets/sets top visible row of the worksheet. Examples The following code illustrates how to set the top visible row: Copy <para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set top visible row</para><para>worksheet.TopVisibleRow = 5;</para><para>//Get top visible row</para><para>Console.Write(worksheet.TopVisibleRow);</para><para>//Save to file</para><para>workbook.SaveToFile("TopVisibleRow.xlsx");</para>
	TypedArcs	Returns inner Arcs collection. Read-only.
	TypedButtons	Returns inner buttons collection. Read-only.
	TypedCheckBoxes	Returns inner checkboxes collection. Read-only.
	TypedComboBoxes	Returns inner comboboxes collection. Read-only.
	TypedGroupBoxes	Returns inner gourpboxes collection. Read-only.
	TypedLabels	Returns inner labels collection. Read-only.
	TypedLines	Returns inner lines collection. Read-only.
	TypedListBoxes	Returns inner listboxes collection. Read-only.
	TypedOvals	Returns inner ovals collection. Read-only.
	TypedPictures	Returns inner pictures collection. Read-only.
	TypedRadioButtons	Returns inner radiobutton collection. Read-only.
	TypedRects	Returns inner rects collection. Read-only.
	TypedScollBars	Returns inner scollbars collection. Read-only.
	TypedSpinners	Returns inner spinners collection. Read-only.
	TypedTextBoxes	Returns inner textboxes collection. Read-only.
	UnknownVmlShapes	Indicates whether worksheet contains some unknown vml shapes.
	Visibility	Controls end user visibility of worksheet.
	VmlShapesCount	Returns number of known vml shapes. Read-only.
	Workbook	Get parent workbook of current worksheet.
	Zoom	Zoom factor of document.

Top

	Name	Description
	Activate	Makes the current sheet the active sheet. Equivalent to clicking the sheet's tab in MS Excel.
	AddReference	Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored. (Inherited from XlsObject .)
	AddTextEffectShape	Adds a text effect shape to the worksheet.
	CheckDisposed	Checks whether object was disposed and throws exception if it was. (Inherited from XlsObject .)
	ClearCellImageCache	Clear Cell image array cache,not delete CellImage in cell.
	Clone	Obsolete. Creates copy of the current object.
	Dispose	Dispose object and free resources. (Inherited from XlsObject .)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object .)
	Finalize	Destructor. Call dispose method of current object. (Inherited from XlsObject .)
	FindParent(Type)	This method is used to find parent with specific type. (Inherited from XlsObject .)
	FindParent( Type )	Find parent of object. (Inherited from XlsObject .)
	FindParent(Type, Boolean)	This method is used to find parent with specific type. (Inherited from XlsObject .)
	FindParents	Finds parent objects. (Inherited from XlsObject .)
	GetHashCode	Serves as the default hash function. (Inherited from Object .)
	GetType	Gets the Type of the current instance. (Inherited from Object .)
	InitializeCollections	Initializes all required collections.
	MemberwiseClone	Creates a shallow copy of the current Object . (Inherited from Object .)
	MoveSheet	Moves sheet into new position, including chartsheet and worksheet.
	OnDispose	Method which can be overriden by users to take any specific actions when object is disposed. (Inherited from XlsObject .)
	Protect(String)	Protects worksheet with password.protect the sheet except select lock/unlock cells. Examples The following code illustrates how to protect the sheet except select lock/unlock cells: Copy <para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Protects the first worksheet's content with password</para><para>worksheet.Protect("123456");</para><para>//Save to file</para><para>workbook.SaveToFile("Protect.xlsx");</para>
	Protect(String, SheetProtectionType)	Protects worksheet with password.
	ReleaseReference	Decrease quantity of Reference. User must call this method when freeing resources. (Inherited from XlsObject .)
	Select	Selects current tab sheet.
	SelectTab	Adds sheet tab to the selected tab.
	SetChanged	This method should be called after any changes in the worksheet. Sets Saved property of the parent workbook to false.
	SetParent	Sets parent of the object. (Inherited from XlsObject .)
	ToString	Returns a string that represents the current object. (Inherited from Object .)
	Unprotect	Unprotects this wokrsheet.
	Unprotect(String)	Unprotects this worksheet using specified password.
	Unselect	Unselects current tab sheet if possible.
	Unselect(Boolean)	Unselects current tab sheet if possible.

Top

	Name	Description
	DEF_MIN_COLUMN_INDEX	Defines the default minimum column index as the maximum value of an integer.
	m_bIsDisposed	Flag which indicates if the object was disposed or not. (Inherited from XlsObject .)
	m_book	Represents the workbook object.
	m_iFirstColumn	The first column index, initialized to the default minimum column index.
	m_iFirstRow	One field from Worksheet dimension records.
	m_iLastColumn	One field from Worksheet dimension records.
	m_iLastRow	One field from Worksheet dimension records

Top

Reference

Spire.Xls.Core.Spreadsheet Namespace