Class Column.UpdateColumnBuilder

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

The convenience class UpdateColumnBuilder to build a Column object to be updated, moved, and/or renamed. The column's index and title properties must be set.

public class Column.UpdateColumnBuilder

Inheritance

object

Column.UpdateColumnBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UpdateColumnBuilder(long, string, int)

Sets the required properties for updating a column.

public UpdateColumnBuilder(long id, string title, int index)

Parameters

id long

the id of the column

title string

the new column title

index int

the new column index (zero-based)

Methods

Build()

Builds the column.

public Column Build()

Returns

Column

the column

GetAutoNumberFormat()

Gets the auto number format.

public AutoNumberFormat GetAutoNumberFormat()

Returns

AutoNumberFormat

the auto number format

GetFormat()

Gets the format.

public int? GetFormat()

Returns

int?

the index

GetIndex()

Gets the index.

public int? GetIndex()

Returns

int?

the index

GetOptions()

Gets the options.

public IList<string> GetOptions()

Returns

IList<string>

the options

GetSymbol()

Gets the symbol.

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.

public ColumnType? GetType()

Returns

ColumnType?

the type

SetAutoNumberFormat(AutoNumberFormat)

Sets the format for an auto number column.

public Column.UpdateColumnBuilder SetAutoNumberFormat(AutoNumberFormat autoNumberFormat)

Parameters

autoNumberFormat AutoNumberFormat

the auto number format

Returns

Column.UpdateColumnBuilder

the modify column builder

SetFormat(string)

Sets the format descriptor.

public Column.UpdateColumnBuilder SetFormat(string format)

Parameters

format string

the format

Returns

Column.UpdateColumnBuilder

the modify column builder

SetIndex(int)

Sets the position for the column.

public Column.UpdateColumnBuilder SetIndex(int index)

Parameters

index int

the position

Returns

Column.UpdateColumnBuilder

the modify column builder

SetLocked(bool)

Sets whether the column is locked.

public Column.UpdateColumnBuilder SetLocked(bool locked)

Parameters

locked bool

the flag

Returns

Column.UpdateColumnBuilder

the modify column builder

SetOptions(IList<string>)

Sets the options for the column.

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

Parameters

options IList<string>

the options

Returns

Column.UpdateColumnBuilder

the modify column builder

SetSymbol(Symbol)

Sets the symbol for the column.

public Column.UpdateColumnBuilder SetSymbol(Symbol symbol)

Parameters

symbol Symbol

the symbol

Returns

Column.UpdateColumnBuilder

the modify column builder

SetSystemColumnType(SystemColumnType)

Sets the system column type for the column.

public Column.UpdateColumnBuilder SetSystemColumnType(SystemColumnType systemColumnType)

Parameters

systemColumnType SystemColumnType

the system column type

Returns

Column.UpdateColumnBuilder

the modify column builder

SetTitle(string)

Sets the title for the column.

public Column.UpdateColumnBuilder SetTitle(string title)

Parameters

title string

the title

Returns

Column.UpdateColumnBuilder

the modify column builder

SetType(ColumnType?)

Sets the type for the column.

public Column.UpdateColumnBuilder SetType(ColumnType? type)

Parameters

type ColumnType?

the type

Returns

Column.UpdateColumnBuilder

the modify column builder

SetWidth(long)

Sets the display width.

public Column.UpdateColumnBuilder SetWidth(long width)

Parameters

width long

the width

Returns

Column.UpdateColumnBuilder

the updated column builder