BH.oM.Adapters.Excel.CellValuesRequest¶

IRequest that pulls values only from the Excel file.

Class structure¶

Implemented interfaces and base types¶

The CellValuesRequest is inheriting from the following base type(s) and implements the following interfaces:

BH.oM.Data.Requests.IRequest
BH.oM.Base.IObject

Properties¶

Defining properties¶

The following properties are defined on the class

Name	Type	Description	Quantity
Worksheet	string	Name of the worksheet to read from.	-
Range	CellRange	Cell range to read. If left empty, entire extent of the spreadsheet starting from A1 is used.	-

Derived properties¶

The following properties are defined as extension methods in one of the BHoM_Engines

Name	Type	Description	Quantity	Engine
Discipline	Nullable<Discipline>	Gets discipline enforced by the Request. If the result is different than defaultDiscipline and neither of two is Undefined, null is returned (the result discipline is conflicting with defaultDiscipline).	-	Revit_Engine
IFilterDescription	string	Returns a description of the filter represented by the given IRequest.	-	Revit_Engine

Code and Schema¶

C# implementation¶

C#

public class CellValuesRequest : BH.oM.Data.Requests.IRequest, BH.oM.Base.IObject

Assembly: Excel_oM.dll

The C# class definition is available on github:

CellValuesRequest.cs

All history and changes of the class can be found by inspection the history.

JSON Schema implementation¶

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema

{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Excel_oM/CellValuesRequest.json"
}

The JSON Schema is available on github here:

CellValuesRequest.json