Class Column.CreateSheetColumnBuilder

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 being created.

public class Column.CreateSheetColumnBuilder

Inheritance

object

Column.CreateSheetColumnBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CreateSheetColumnBuilder(string, bool?, ColumnType?)

Sets the required properties for a column.

public CreateSheetColumnBuilder(string title, bool? primary, ColumnType? type)

Parameters

title string

must be unique within the sheet

primary bool?

one and only one column may be a primary column

type ColumnType?

must be set to TEXT_NUMBER if column is primary

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

GetOptions()

Gets the option for the column.

public IList<string> GetOptions()

Returns

IList<string>

the option

GetPrimary()

Gets the whether the column is the primary column.

public bool? GetPrimary()

Returns

bool?

the primary

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.CreateSheetColumnBuilder SetAutoNumberFormat(AutoNumberFormat autoNumberFormat)

Parameters

autoNumberFormat AutoNumberFormat

the auto number format

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder

SetOptions(IList<string>)

Sets the options for the column.

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

Parameters

options IList<string>

the options

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder

SetPrimary(bool?)

Sets whether the column is the primary column.

public Column.CreateSheetColumnBuilder SetPrimary(bool? primary)

Parameters

primary bool?

the primary

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder

SetSymbol(Symbol?)

Sets the symbol for the column.

public Column.CreateSheetColumnBuilder SetSymbol(Symbol? symbol)

Parameters

symbol Symbol?

the symbol

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder

SetSystemColumnType(SystemColumnType?)

Sets the system column type.

public Column.CreateSheetColumnBuilder SetSystemColumnType(SystemColumnType? systemColumnType)

Parameters

systemColumnType SystemColumnType?

the system column type

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder

SetTitle(string)

Sets the title for the column.

public Column.CreateSheetColumnBuilder SetTitle(string title)

Parameters

title string

the title

Returns

Column.CreateSheetColumnBuilder

the adds the column to sheet builder

SetType(ColumnType?)

Sets the type for the column.

public Column.CreateSheetColumnBuilder SetType(ColumnType? type)

Parameters

type ColumnType?

the type

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder

SetWidth(long?)

Sets the primary flag for the column.

public Column.CreateSheetColumnBuilder SetWidth(long? width)

Parameters

width long?

the width

Returns

Column.CreateSheetColumnBuilder

the CreateSheetColumnBuilder