Class CellBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
CellBuilder
Assembly: Syncfusion.AspNetCore.Spreadsheet.dll
Syntax
public class CellBuilder : ControlBuilder
Constructors
CellBuilder()
Declaration
CellBuilder(List<Cell>)
Declaration
public CellBuilder(List<Cell> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<Cell> |
collection |
|
Methods
Add()
Declaration
Chart(Action<ChartBuilder>)
Declaration
public CellBuilder Chart(Action<ChartBuilder> chart)
Parameters
Returns
Chart(List<Chart>)
Specifies the chart of the cell.
Declaration
public CellBuilder Chart(List<Chart> chart)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<Chart> |
chart |
|
Returns
ColSpan(Int32)
Specifies the column-wise cell merge count.
Declaration
public CellBuilder ColSpan(int colSpan)
Parameters
| Type |
Name |
Description |
| System.Int32 |
colSpan |
|
Returns
Represents the threaded comment associated with the cell.
A threaded comment allows users to add a main comment and maintain a discussion through replies.
Each cell supports a single comment thread, which includes:
- author: The name of the person who created the comment.
- text: The main content of the comment.
- createdTime: The time-stamp indicating when the comment was added.
- isResolved: Indicates whether the thread is marked as resolved.
- replies: A collection of reply comments, each with its own
author, text, and createdTime.
Declaration
public CellBuilder Comment(SpreadsheetThreadedComment comment)
Parameters
Returns
Declaration
public CellBuilder Comment(Action<SpreadsheetThreadedCommentBuilder> comment)
Parameters
Returns
Specifies the number format code to display value in specified number format.
Declaration
public CellBuilder Format(string format)
Parameters
| Type |
Name |
Description |
| System.String |
format |
|
Returns
Defines the formula or expression of the cell.
Declaration
public CellBuilder Formula(string formula)
Parameters
| Type |
Name |
Description |
| System.String |
formula |
|
Returns
Hyperlink(SpreadsheetHyperlink)
Specifies the hyperlink of the cell.
Declaration
public CellBuilder Hyperlink(SpreadsheetHyperlink hyperlink)
Parameters
Returns
Hyperlink(Action<SpreadsheetHyperlinkBuilder>)
Declaration
public CellBuilder Hyperlink(Action<SpreadsheetHyperlinkBuilder> hyperlink)
Parameters
Returns
Hyperlink(Object)
Specifies the hyperlink of the cell.
Declaration
public CellBuilder Hyperlink(object hyperlink)
Parameters
| Type |
Name |
Description |
| System.Object |
hyperlink |
|
Returns
Hyperlink(String)
Specifies the hyperlink of the cell.
Declaration
public CellBuilder Hyperlink(string hyperlink)
Parameters
| Type |
Name |
Description |
| System.String |
hyperlink |
|
Returns
Image(Action<ImageBuilder>)
Declaration
public CellBuilder Image(Action<ImageBuilder> image)
Parameters
Returns
Image(List<Image>)
Specifies the image of the cell.
Declaration
public CellBuilder Image(List<Image> image)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<Image> |
image |
|
Returns
Index(Int32)
Specifies the index of the cell.
Declaration
public CellBuilder Index(int index)
Parameters
| Type |
Name |
Description |
| System.Int32 |
index |
|
Returns
IsLocked(Boolean)
Specifies the cell is locked or not, for allow edit range in spreadsheet protect option.
Declaration
public CellBuilder IsLocked(bool isLocked)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isLocked |
|
Returns
IsReadOnly(Boolean)
Represents whether a cell in the sheet is read-only or not. If set to true, it prevents editing the specified cell in the sheet.
Declaration
public CellBuilder IsReadOnly(bool isReadOnly)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isReadOnly |
|
Returns
Notes(Object)
Specifies the note of the cell.
Declaration
public CellBuilder Notes(object notes)
Parameters
| Type |
Name |
Description |
| System.Object |
notes |
|
Returns
Notes(String)
Specifies the note of the cell.
Declaration
public CellBuilder Notes(string notes)
Parameters
| Type |
Name |
Description |
| System.String |
notes |
|
Returns
RichText(Action<RichTextBuilder>)
Declaration
public CellBuilder RichText(Action<RichTextBuilder> richText)
Parameters
Returns
RichText(List<RichText>)
Specifies the rich text segments for the cell text, allowing superscript and subscript formatting within the content.
Uses the RichText model to apply formatting to specific text segments. The options are:
- text: Specifies the text content for each segment.
- style: Specifies the style for each segment; it supports superscript and subscript formatting.
Set
verticalAlign as super for superscript formatting and sub for subscript formatting.
Declaration
public CellBuilder RichText(List<RichText> richText)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<RichText> |
richText |
|
Returns
RowSpan(Int32)
Specifies the row-wise cell merge count.
Declaration
public CellBuilder RowSpan(int rowSpan)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowSpan |
|
Returns
Style(SpreadsheetCellStyle)
Specifies the cell style options.
Declaration
public CellBuilder Style(SpreadsheetCellStyle style)
Parameters
Returns
Style(Action<SpreadsheetCellStyleBuilder>)
Declaration
public CellBuilder Style(Action<SpreadsheetCellStyleBuilder> style)
Parameters
Returns
Validation(SpreadsheetValidation)
Specifies the validation of the cell.
Declaration
public CellBuilder Validation(SpreadsheetValidation validation)
Parameters
Returns
Validation(Action<SpreadsheetValidationBuilder>)
Declaration
public CellBuilder Validation(Action<SpreadsheetValidationBuilder> validation)
Parameters
Returns
Value(String)
Defines the value of the cell which can be text or number.
Declaration
public CellBuilder Value(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Wrap(Boolean)
Wraps the cell text to the next line, if the text width exceeds the column width.
Declaration
public CellBuilder Wrap(bool wrap)
Parameters
| Type |
Name |
Description |
| System.Boolean |
wrap |
|
Returns