Static
$tStatic
nextGets the data table to which the cell belongs.
The cells in the left-most column and top-most row of the data table will return null for the associated data table.
If a data table is associated with the cell, getting the value will return the calculated value for the cell.
Note: it is slightly faster to use the WorksheetRow.getCellAssociatedDataTable method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellAssociatedDataTable method.
The data table to which the cell belongs or null if the cell does not belong to a data table.Gets the merged cells region which contains the cell, or null if the cell is not merged.
Note: it is slightly faster to use the WorksheetRow.getCellAssociatedMergedCellsRegion method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellAssociatedMergedCellsRegion method.
The merged cells region which contains the cell, or null if the cell is not merged.Gets the WorksheetTable to which this cell belongs.
A cell belongs to a table if it exists in any area of the table. It can be a header cell, total cell, or a cell in the data area.
Note: it is slightly faster to use the WorksheetRow.getCellAssociatedTable method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellAssociatedTable method.
Gets the cell formatting for this cell.
Use this property to set cell formatting specific to the cell. If you will be applying the format to numerous cells, see the Workbook.createNewWorksheetCellFormat method for performance considerations.
If this cell belongs to a merged cell region, getting the CellFormat will get the CellFormat of the associated merged cell region.
Note: it is slightly faster to use the WorksheetRow.getCellFormat method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellFormat method.
The cell formatting for this cell.Gets the column index of the cell. The column index of the cell.
Gets or sets the comment applied to the cell.
Note: it is slightly faster to use the WorksheetRow.getCellComment or WorksheetRow.setCellComment methods, which do not create WorksheetCell instances internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellComment or WorksheetRow.SetCellComment methods.
The comment applied to the cell.InvalidOperationException The value applied only has only one anchor cell set. It should have both or neither anchor cells set.
InvalidOperationException The value has its WorksheetShape.topLeftCornerCell and WorksheetShape.bottomRightCornerCell anchors set but they are from different worksheets.
Gets or sets the data validation rule for the WorksheetCell.
ArgumentException Occurs when the value specified is already applied to cells in another worksheet.
ArgumentException Occurs when the value specified is invalid based on its rule type's requirements.
Gets the formula which has been applied to the cell.
If a formula has been applied to the cell, getting the value will return the calculated value of the formula.
Note: it is slightly faster to use the WorksheetRow.getCellFormula method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellFormula method.
The formula which has been applied to the cell or null if no formula has been applied.Get the value indicating whether the cell has an associated comment.
Note: it is slightly faster to use the WorksheetRow.getCellComment method and check for a non null return value, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellComment method and checking for a non null return value.
True if the cell has an associated comment; False otherwise.Gets the row index of the cell. The row index of the cell.
Gets or sets the value of the cell.
If this cell belongs to a merged cell region and it is the top-left cell of the region, getting and setting the value will get and set the value of the associated merged cell region. Getting the value of other cells in a merged cell region will always return null. Setting the value of other cells in a merged cell region will have no effect.
If a formula has been applied to the cell or a data table is associated with the cell, getting the Value will return the calculated value of the cell.
The types supported for the value are:
Note: it is slightly faster to use the WorksheetRow.getCellValue or WorksheetRow.setCellValue methods, which do not create WorksheetCell instances internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetCellComment or WorksheetRow.SetCellComment methods.
The value of the cell.NotSupportedException The assigned value's type is not supported and can't be exported to Excel.
InvalidOperationException The value assigned is a formula. Instead, Formula.applyTo should be called on the Formula, passing in the cell.
InvalidOperationException The value assigned is a WorksheetDataTable. Instead, the WorksheetDataTable.cellsInTable should be set to a region containing the cell.
InvalidOperationException The value assigned is a FormattedString which is the value another cell or merged cell region.
InvalidOperationException The value is assigned and this cell is part of an ArrayFormula or WorksheetDataTable.
Applies a formula to the cell.
'value' is parsed based on the CellReferenceMode of the Workbook to which the cell belongs. If the cell's worksheet has been removed from its parent collection, the A1 CellReferenceMode will be used to parse the formula.
Note: it is slightly faster to use the WorksheetRow.applyCellFormula method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this method is equivalent to using the WorksheetRow.ApplyCellFormula method.
ArgumentNullException 'value' is null or empty.
FormulaParseException 'value' is not a valid formula.
InvalidOperationException The cell is part of an array formula or data table which is not confined to just the cell.
The formula to parse and apply to the cell.
Removes the comment associated with the cell.
Note: it is slightly faster to use the WorksheetRow.setCellComment method and pass in null as the comment parameter, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this method is equivalent to using the WorksheetRow.SetCellComment method and passing in null as the comment parameter.
Determines whether the specified object is another WorksheetCell instance which refers to the same location on the same worksheet as this cell.
True if the cells refer to the same location on the same worksheet; False otherwise.
The instance to check for equality.
Gets the bounds of the cell in twips (1/20th of a point).
The bounds returned by this method are only valid with the current configuration of the worksheet. If any rows or columns before the cell are resized, these bounds will no longer reflect the position of the cell.
Note: it is slightly faster to use the WorksheetRow.getCellBoundsInTwips method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this method is equivalent to using the WorksheetRow.GetBoundsInTwips method.
The bounds of the cell on its worksheet.
Gets the bounds of the cell in twips (1/20th of a point).
The bounds returned by this method are only valid with the current configuration of the worksheet. If any rows or columns before the cell are resized, these bounds will no longer reflect the position of the cell.
Note: it is slightly faster to use the WorksheetRow.getCellBoundsInTwips method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this method is equivalent to using the WorksheetRow.GetBoundsInTwips method.
The bounds of the cell on its worksheet.
The options to use when getting the bounds of the cell.
Gets the effective hyperlink on the cell.
If multiple hyperlinks are applied to the cell, the last one in the Worksheet.hyperlinks collection will be used.
If the cell has one or more hyperlinks in the Worksheet.hyperlinks collection as well as a formula containing a HYPERLINK function, the last hyperlink from the collection will be used.
If the cell has a hyperlink due to the HYPERLINK function being used in a formula, the returned value will be sealed.
Gets the resolved cell formatting for this cell.
If any cell format properties are the default values on the cell, the values from the owning row's cell format will be used. If those are default, then the values from the owning column's cell format will be used. Otherwise, the workbook default values will be used.
Note: it is slightly faster to use the WorksheetRow.getResolvedCellFormat method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this method is equivalent to using the WorksheetRow.GetResolvedCellFormat method.
A format object describing the actual formatting that will be used when displayed this cell in Microsoft Excel.
Gets the text displayed in the cell.
The display text is based on the value of the cell and the format string applied to the cell.
Note: it is slightly faster to use the WorksheetRow.getCellText method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetText method.
Gets the text of the cell.
The text is based on the value of the cell and the format string applied to the cell.
Note: it is slightly faster to use the WorksheetRow.getCellText method, which does not create a WorksheetCell instance internally. However, if a reference to the WorksheetCell instance already exists, using this property is equivalent to using the WorksheetRow.GetText method.
InvalidEnumArgumentException 'textFormatMode' is not defined in the TextFormatMode enumeration.
The format mode to use when getting the cell text.
Gets the string representation of the address of the cell.
The string representation of the address of the cell.
Gets the string representation of the address of the cell.
The string representation of the address of the cell.
The mode used to generate cell references.
The value indicating whether to include the worksheet name in the cell address.
Gets the string representation of the address of the cell.
The string representation of the address of the cell.
The mode used to generate cell references.
The value indicating whether to include the worksheet name in the cell address.
The value indicating whether to use a relative column address.
The value indicating whether to use a relative row address.
Returns a boolean indicating if the value of the cell is valid considering the associated dataValidationRule
Returns false if the cell has an associated dataValidationRule and the current value does not pass the validation defined by that rule; otherwise true is returned.
Static
compareStatic
compareStatic
equalsStatic
equalsStatic
getStatic
getStatic
getGets the string representation of the address of the cell.
The string representation of the address of the cell.
The WorksheetRow of the cell.
The index of the column of the cell.
The mode used to generate cell references.
The value indicating whether to include the worksheet name in the cell address.
Gets the string representation of the address of the cell.
The string representation of the address of the cell.
The WorksheetRow of the cell.
The index of the column of the cell.
The mode used to generate cell references.
The value indicating whether to include the worksheet name in the cell address.
The value indicating whether to use a relative column address.
The value indicating whether to use a relative row address.
Static
getStatic
isStatic
reference
Represents a cell in a Microsoft Excel worksheet.