ApiWorksheet

Represents the ApiWorksheet class.

Properties

Name	Type	Description
Active	number	Makes the current sheet active.
ActiveCell	ApiRange	Returns an object that represents an active cell.
AllProtectedRanges	ApiProtectedRange[]	Returns all protected ranges from the current worksheet.
BottomMargin	number	Returns or sets the size of the sheet bottom margin measured in points.
Cells	ApiRange	Returns ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use).
Cols	ApiRange	Returns ApiRange that represents all the cells of the columns range.
Comments	ApiComment[]	Returns all comments from the current worksheet.
Defnames	ApiName[]	Returns an array of the ApiName objects.
FreezePanes	ApiFreezePanes	Returns the freeze panes for the current worksheet.
Index	number	Returns a sheet index.
LeftMargin	number	Returns or sets the size of the sheet left margin measured in points.
Name	string	Returns or sets a name of the active sheet.
PageOrientation	PageOrientation	Returns or sets the page orientation.
PivotTables	ApiPivotTable[]	Returns all pivot tables from the current worksheet.
PrintGridlines	boolean	Returns or sets the page PrintGridlines property.
PrintHeadings	boolean	Returns or sets the page PrintHeadings property.
RightMargin	number	Returns or sets the size of the sheet right margin measured in points.
Rows	ApiRange	Returns ApiRange that represents all the cells of the rows range.
Selection	ApiRange	Returns an object that represents the selected range.
TopMargin	number	Returns or sets the size of the sheet top margin measured in points.
UsedRange	ApiRange	Returns ApiRange that represents the used range on the specified worksheet.
Visible	boolean	Returns or sets the state of sheet visibility.

Methods

Method	Returns	Description
AddChart	ApiChart	Creates a chart of the specified type from the selected data range of the current sheet.\ 💡 Please note that the horizontal and vertical offsets are calculated within the limits of the specified column and\ row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set.
AddDefName	boolean	Adds a new name to the current worksheet.
AddImage	ApiImage	Adds an image to the current sheet with the parameters specified.
AddOleObject	ApiOleObject	Adds an OLE object to the current sheet with the parameters specified.
AddProtectedRange	ApiProtectedRange | null	Creates a protected range of the specified type from the selected data range of the current sheet.
AddShape	ApiShape	Adds a shape to the current sheet with the parameters specified.\ 💡 Please note that the horizontal and vertical offsets are\ calculated within the limits of the specified column and row cells\ only. If this value exceeds the cell width or height, another vertical/horizontal position will be set.
AddWordArt	ApiDrawing	Adds a Text Art object to the current sheet with the parameters specified.
Delete	None	Deletes the current worksheet.
FormatAsTable	None	Formats the selected range of cells from the current sheet as a table (with the first row formatted as a header).\ 💡 As the first row is always formatted as a table header, you need to select at least two rows for the table to be formed correctly.
GetActiveCell	ApiRange	Returns an object that represents an active cell.
GetAllCharts	ApiChart[]	Returns all charts from the current sheet.
GetAllDrawings	Drawing[]	Returns all drawings from the current sheet.
GetAllImages	ApiImage[]	Returns all images from the current sheet.
GetAllOleObjects	ApiOleObject[]	Returns all OLE objects from the current sheet.
GetAllPivotTables	ApiPivotTable[]	Returns all pivot tables from the current worksheet.
GetAllProtectedRanges	ApiProtectedRange[] | null	Returns all protected ranges from the current worksheet.
GetAllShapes	ApiShape[]	Returns all shapes from the current sheet.
GetBottomMargin	number	Returns the bottom margin of the sheet.
GetCells	ApiRange | null	Returns the ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use).
GetCols	ApiRange	Returns the ApiRange object that represents all the cells on the columns range.
GetComments	ApiComment[]	Returns all comments from the current worksheet.
GetDefName	ApiName | null	Returns the ApiName object by the worksheet name.
GetDefNames	ApiName[]	Returns an array of ApiName objects.
GetFreezePanes	ApiFreezePanes	Returns the freeze panes from the current worksheet.
GetIndex	number	Returns a sheet index.
GetLeftMargin	number	Returns the left margin of the sheet.
GetName	string	Returns a sheet name.
GetPageOrientation	PageOrientation	Returns the page orientation.
GetPivotByName	ApiPivotTable | null	Returns a pivot table by its name from the current worksheet, or null if it does not exist.
GetPrintGridlines	boolean	Returns the page PrintGridlines property which specifies whether the current sheet gridlines must be printed or not.
GetPrintHeadings	boolean	Returns the page PrintHeadings property which specifies whether the current sheet row/column headings must be printed or not.
GetProtectedRange	ApiProtectedRange | null	Returns a protected range object by its title.
GetRange	ApiRange | null	Returns an object that represents the selected range of the current sheet. Can be a single cell - -A1, or cells\ from a single row - -A1:E1, or cells from a single column - -A1:A10, or cells from several rows and columns - -A1:E10.
GetRangeByNumber	ApiRange	Returns an object that represents the selected range of the current sheet using the -row/column coordinates for the cell selection.
GetRightMargin	number	Returns the right margin of the sheet.
GetRows	ApiRange | null	Returns the ApiRange object that represents all the cells on the rows range.
GetSelection	ApiRange	Returns an object that represents the selected range.
GetTopMargin	number	Returns the top margin of the sheet.
GetUsedRange	ApiRange	Returns the ApiRange object that represents the used range on the specified worksheet.
GetVisible	boolean	Returns the state of sheet visibility.
GroupDrawings	ApiGroup	Groups an array of drawings in the current worksheet.
Move	None	Moves the current sheet to another location in the workbook.
Paste	None	Pastes the contents of the clipboard to the current sheet.
RefreshAllPivots	None	Refreshes all pivot tables on the current worksheet.
ReplaceCurrentImage	None	Replaces the current image with a new one.
SetActive	None	Makes the current sheet active.
SetBottomMargin	None	Sets the bottom margin of the sheet.
SetColumnWidth	None	Sets the width of the specified column.\ One unit of column width is equal to the width of one character in the Normal style.\ For proportional fonts, the width of the character 0 (zero) is used.
SetDisplayGridlines	None	Specifies whether the current sheet gridlines must be displayed or not.
SetDisplayHeadings	None	Specifies whether the current sheet row/column headers must be displayed or not.
SetHyperlink	None	Adds a hyperlink to the specified range.
SetLeftMargin	None	Sets the left margin of the sheet.
SetName	None	Sets a name to the current active sheet.
SetPageOrientation	None	Sets the page orientation.
SetPrintGridlines	None	Specifies whether the current sheet gridlines must be printed or not.
SetPrintHeadings	None	Specifies whether the current sheet row/column headers must be printed or not.
SetRightMargin	None	Sets the right margin of the sheet.
SetRowHeight	None	Sets the height of the specified row measured in points.\ A point is 1/72 inch.
SetTopMargin	None	Sets the top margin of the sheet.
SetVisible	None	Sets the state of sheet visibility.