Class Column.AddColumnBuilder

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

A convenience class to help create a column object with the appropriate fields for adding to a sheet.

public class Column.AddColumnBuilder

Inheritance

object

Column.AddColumnBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AddColumnBuilder(string, int?, ColumnType?)

Sets the required properties for adding a column to a sheet.

public AddColumnBuilder(string title, int? index, ColumnType? type)

Parameters

title string

the column title

index int?

the column index (zero-based)

type ColumnType?

the column type

Methods

Build()

Builds the column.

public Column Build()

Returns

Column

the column

GetAutoNumberFormat()

Gets the format for an auto number column.

public AutoNumberFormat GetAutoNumberFormat()

Returns

AutoNumberFormat

the format for an auto number column

GetIndex()

Gets the index.

public int? GetIndex()

Returns

int?

the index

GetLocked()

Gets the flag whether column is locked or not.

public bool? GetLocked()

Returns

bool?

the locked flag

GetOptions()

Gets the option for the column.

public IList<string> GetOptions()

Returns

IList<string>

the option

GetSymbol()

Gets the symbol for the column.

public Symbol? GetSymbol()

Returns

Symbol?

the symbol

GetSystemColumnType()

Gets the system column type.

public SystemColumnType? GetSystemColumnType()

Returns

SystemColumnType?

the system column type

GetTitle()

Gets the title.

public string GetTitle()

Returns

string

the title

GetType()

Gets the type for the column.

public ColumnType? GetType()

Returns

ColumnType?

the type

GetWidth()

Gets the display width.

public long? GetWidth()

Returns

long?

the display width

SetAutoNumberFormat(AutoNumberFormat)

Sets the format for an auto number column.

public Column.AddColumnBuilder SetAutoNumberFormat(AutoNumberFormat autoNumberFormat)

Parameters

autoNumberFormat AutoNumberFormat

the auto number format

Returns

Column.AddColumnBuilder

the adds the column to sheet builder

SetIndex(int)

Sets the position for the column.

public Column.AddColumnBuilder SetIndex(int index)

Parameters

index int

the position

Returns

Column.AddColumnBuilder

the add column builder

SetLocked(bool)

Sets whether the column is locked.

public Column.AddColumnBuilder SetLocked(bool locked)

Parameters

locked bool

the flag

Returns

Column.AddColumnBuilder

the add column builder

SetOptions(IList<string>)

Sets the options for the column.

public Column.AddColumnBuilder SetOptions(IList<string> options)

Parameters

options IList<string>

the options

Returns

Column.AddColumnBuilder

the adds the column to sheet builder

SetSymbol(Symbol?)

Sets the symbol for the column.

public Column.AddColumnBuilder SetSymbol(Symbol? symbol)

Parameters

symbol Symbol?

the symbol

Returns

Column.AddColumnBuilder

the adds the column to sheet builder

SetSystemColumnType(SystemColumnType?)

Sets the system column type.

public Column.AddColumnBuilder SetSystemColumnType(SystemColumnType? systemColumnType)

Parameters

systemColumnType SystemColumnType?

the system column type

Returns

Column.AddColumnBuilder

the adds the column to sheet builder

SetTitle(string)

Sets the title for the column.

public Column.AddColumnBuilder SetTitle(string title)

Parameters

title string

the title

Returns

Column.AddColumnBuilder

the adds the column to sheet builder

SetType(ColumnType?)

Sets the type for the column.

public Column.AddColumnBuilder SetType(ColumnType? type)

Parameters

type ColumnType?

the type

Returns

Column.AddColumnBuilder

the adds the column to sheet builder

SetWidth(long?)

Sets the primary flag for the column.

public Column.AddColumnBuilder SetWidth(long? width)

Parameters

width long?

the width

Returns

Column.AddColumnBuilder

the add column builder