Skip to content

BH.oM.Adapters.Excel.CellContents

Object representing the information stored within a cell: the value and metadata related to it.

Class structure

Implemented interfaces and base types

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

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Comment string Comment applied to the cell. -
Value object Value stored in the cell. -
Address CellAddress Address of the cell. -
DataType Type Data type of the value stored in the cell. Only 5 data types are considered: number, text, Boolean, date/time, and timespan. -
FormulaA1 string Formula stored in the cell, in standard Excel format (e.g. "=A1"). -
FormulaR1C1 string Formula stored in the cell, in R1C1 (relative) format. For more information on that format, please search for 'A1 vs R1C1 Notation'. -
HyperLink string Hyperlink stored in the cell. -
RichText string Information about rich formatting of the cell content. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Code and Schema

C# implementation

C#
public class CellContents : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

Assembly: Excel_oM.dll

The C# class definition is available on github:

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/CellContents.json"
}

The JSON Schema is available on github here: