IGoExcel Interface

Provides functions properties to read and write data from Excel.

In a rule, this interface is implemented by the predefined object named GoExcel.

Namespace: Autodesk.iLogic.Interfaces
Assembly: Autodesk.iLogic.Interfaces (in Autodesk.iLogic.Interfaces.dll) Version: 23.0

Syntax

Public Interface IGoExcel

public interface IGoExcel

The IGoExcel type exposes the following members.

Properties

	Name	Description
	Application	Gets the Excel Application object (of the type Microsoft.Office.Interop.Excel.Application).
	CellValueString	Gets or sets the value of the cell at the specified address in the current workbook and worksheet.
	CellValueString, String, String	Gets or sets the value of the cell at the specified address.
	CellValuesString, String	Gets or sets the values of a range of cells from a single column or row.
	CellValuesString, String, String, String	Gets or sets the values of a range of cells from a single column or row.
	DisplayAlerts	Gets or sets a property of the Excel application. If this is True, alert dialogs will be displayed.
	FindRowStart	Gets or sets the index (1-based) of the first row to search wit hthe FindRow function. This must be creater than the TitleRow. The default value is 2.
	NamedRangeValue	Gets or sets the value of a named range. Named ranges are defined in the Excel file.
	TitleRow	Gets or sets the index (1-based) of the title row. The title row is the row that contains the column names. The default value is 1.
	Tolerance	Gets or sets a value that is used for numeric equality tests in the FindRow function. If the difference between two numbers is less than or equal to the tolerance, they will be considered to be equal. The default tolerance is 0.0000001.

Methods

	Name	Description
	ChangeSourceOfLinked	Replace the Excel file that is currently a source of linked parameters with another file. This is similar to the Change Source command on the context menu in the UI.
	ClearCache	Clear the internal cache used by FindRow and CurrentRowValue. This cache is not used by CellValue and related functions. It is a global cache, and it persists when rules are not being run.
	Close	Closes the Excel file that is currently open (if any).
	CurrentRowValue	Gets the value of the cell at the specified column in the current row. (Use FindRow to set the current row.)
	FindColumn	Find a column by name. The name is the value of the cell in the TitleRow.
	FindRow	Finds and selects a row that matches the given values.
	Open	Opens the specified Excel workbook, and optionally sets the named worksheet as the current sheet.
	Save	Saves the Excel file that is currently open (if any).
	SetCurrentSheet	Sets the current sheet of the specified Excel workbook.