Concepts

Concepts used in Microsoft Excel BDK Book.

Excel range reference

ExcelRangeRef represents a reference to a range of cells within an Excel worksheet. It provides detailed information about a contiguous set of cells and is designed for use in applications that require precise range-based operations, such as data extraction, modification, and analysis within spreadsheets.

Field Name	Description	Type
drive_id	The unique identifier for the drive containing the workbook.	text
file_id	The unique identifier for the workbook.	text
sheet_id	The unique identifier for the worksheet.	text
address	The address of the range.	text
address_local	The local address of the range.	optional[text]
cell_count	The number of cells in the range.	optional[number]
column_count	The number of columns in the range.	optional[number]
column_hidden	Whether the columns in the range are hidden.	optional[boolean]
column_index	The index of the first column in the range.	optional[number]
hidden	Whether the range is hidden.	optional[boolean]
row_count	The number of rows in the range.	optional[number]
row_hidden	Whether the rows in the range are hidden.	optional[boolean]
row_index	The index of the first row in the range.	optional[number]

Excel sheet reference

ExcelSheetRef represents a reference to a worksheet within an Excel workbook, providing details to uniquely identify and interact with a specific sheet. It facilitates precise data manipulation and integration, useful for data processing, automated workflows, and integration across multiple files.

Field Name	Description	Type
id	The unique identifier for the worksheet.	text
name	The name of the worksheet.	text
drive_id	The unique identifier for the drive containing the workbook.	text
file_id	The unique identifier for the workbook.	text

Excel table reference

ExcelTableRef represents a reference to a table within an Excel worksheet, providing essential details to uniquely identify and interact with specific tables. This utility is used to facilitate data management, structured data handling, and integration within larger workflows.

Field Name	Description	Type
id	The unique identifier for the worksheet.	text
name	The name of the worksheet.	text
drive_id	The unique identifier for the drive containing the workbook.	text
file_id	The unique identifier for the workbook.	text
sheet_id	The unique identifier for the worksheet.	text

Excel column reference

ExcelColumnRef represents a reference to a specific column within an Excel worksheet. It serves as a utility to uniquely identify and interact with data in a column, providing essential metadata that allows for efficient data manipulation and retrieval.

Field Name	Description	Type
id	The unique identifier for the column.	text
index	The index of the column.	number

Excel row reference

ExcelRowRef represents a reference to a specific row within an Excel worksheet. This utility enables efficient access, manipulation, and reference of data within rows, providing essential information to uniquely identify and interact with a row's content.

Field Name	Description	Type
id	The unique identifier for the row.	text
index	The index of the row.	number

Sharepoint file reference

A Sharepoint File Reference is a reference to a file in a SharePoint document library.

Field Name	Description	Type
id	The unique identifier for the document library.	optional[text]
name	The name of the document library.	optional[text]
web_url	URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).	optional[text]
parent_reference	Parent information, if the item has a parent.	optional[parent_reference]
is_folder	Boolean flag indicating whenever this item is a folder or not.	boolean
file_name	The name of the file. Same as name.	text

Parent_reference

A reference to a SharePoint document library item, providing essential identifiers that link to a specific item within a SharePoint document library.

Field Name	Description	Type
id	The unique identifier of the document library item.	optional[text]
drive_id	The unique identifier of the drive containing the document library item.	optional[text]

Excel cell reference

ExcelCellRef represents a reference to a specific cell within an Excel worksheet, serving as a utility to uniquely identify and manipulate data within the cell. It provides essential details to locate the cell precisely.

Field Name	Description	Type
drive_id	The unique identifier for the drive.	text
file_id	The unique identifier for the file.	text
sheet_id	The unique identifier for the sheet.	text
row_index	The row of the cell.	number
column_index	The column of the cell.	number
id	The unique identifier for the cell.	optional[text]
row_id	The unique identifier for the row of the cell.	optional[text]
column_id	The unique identifier for the column of the cell.	optional[text]
address	The address of the cell.	optional[text]
table_id	The unique identifier for the table.	optional[text]