Class Row.AddRowBuilder

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

A convenience class for creating a Row with the necessary fields for inserting into a list of Rows.

public class Row.AddRowBuilder

Inheritance

object

Row.AddRowBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

If multiple rows are specified in the request, all rows must be inserted at the same location (i.e. the toTop, toBottom, parentId, siblingId, and above attributes must be the same for all rows in the request).

Constructors

AddRowBuilder(bool?, bool?, long?, long?, bool?)

Sets the required property/properties for Adding a Row

public AddRowBuilder(bool? toTop, bool? toBottom, long? parentId, long? siblingId, bool? above)

Parameters

toTop bool?

Indicates that the row should be added to the top of the sheet.

toBottom bool?

Indicates that the row should be added to the bottom of the sheet, or, if used in conjunction with parentId, added as the last child of the parent.

parentId long?

Indicates that the row should be added as the first child of this row.

siblingId long?

Indicates that the row should be added as the next row at the same hierarchical level of this row.

above bool?

Optionally used in conjunction with siblingId with a value of true to indicate that the row should be added above the specified sibling row.

Remarks

If multiple rows are specified in the request, all rows must be inserted at the same location (i.e. the toTop, toBottom, parentId, siblingId, and above attributes must be the same for all rows in the request).

Methods

Build()

Builds the Row.

public Row Build()

Returns

Row

the row

GetAbove()

Gets the above flag.

public bool? GetAbove()

Returns

bool?

the above flag

GetCells()

Gets the cells.

public IList<Cell> GetCells()

Returns

IList<Cell>

the cells

GetExpanded()

Gets the expanded flag.

public bool? GetExpanded()

Returns

bool?

the expanded flag

GetFormat()

Gets the format

public string GetFormat()

Returns

string

the format

GetParentId()

Gets the parent Id.

public long? GetParentId()

Returns

long?

the parent Id

GetSiblingId()

Gets the sibling Id.

public long? GetSiblingId()

Returns

long?

the sibling Id

GetToBottom()

Gets the to bottom.

public bool? GetToBottom()

Returns

bool?

the to bottom

GetToTop()

Gets the to top.

public bool? GetToTop()

Returns

bool?

the to top

SetAbove(bool?)

Sets the flag which which is used in conjunction with siblingId with a value of true to indicate that the row should be added above the specified sibling row.

public Row.AddRowBuilder SetAbove(bool? above)

Parameters

above bool?

the above flag

Returns

Row.AddRowBuilder

the add row builder

SetCells(IList<Cell>)

Sets the cells of the row.

public Row.AddRowBuilder SetCells(IList<Cell> cells)

Parameters

cells IList<Cell>

the cells

Returns

Row.AddRowBuilder

the add row builder

SetExpanded(bool?)

Sets if expanded.

public Row.AddRowBuilder SetExpanded(bool? expanded)

Parameters

expanded bool?

the expanded

Returns

Row.AddRowBuilder

the add row builder

SetFormat(string)

Sets the Format.

public Row.AddRowBuilder SetFormat(string format)

Parameters

format string

the format

Returns

Row.AddRowBuilder

the add row builder

SetParentId(long?)

Sets the parent Id that puts the row as the first child of the specified Id.

public Row.AddRowBuilder SetParentId(long? parentId)

Parameters

parentId long?

the parent Id

Returns

Row.AddRowBuilder

the add row builder

SetSiblingId(long?)

Sets the sibling Id that puts the row as the next row at the same hierarchical level of this row.

public Row.AddRowBuilder SetSiblingId(long? siblingId)

Parameters

siblingId long?

the sibling Id

Returns

Row.AddRowBuilder

the add row builder

SetToBottom(bool?)

Sets the to bottom flag that puts the row at the bottom of the sheet.

public Row.AddRowBuilder SetToBottom(bool? toBottom)

Parameters

toBottom bool?

the to bottom

Returns

Row.AddRowBuilder

the add row builder

SetToTop(bool?)

Sets the to top flag that puts the row at the top of the sheet.

public Row.AddRowBuilder SetToTop(bool? toTop)

Parameters

toTop bool?

the to top flag

Returns

Row.AddRowBuilder

the add row builder