C# Class Smartsheet.Api.Models.Column.AddColumnBuilder

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

Show file Open project: smartsheet-platform/smartsheet-csharp-sdk

Public Methods

Method	Description
AddColumnBuilder ( string title, int index, ColumnType type ) : System	Sets the required properties for adding a Column to a Sheet.
Build ( ) : Column	Builds the column.
GetAutoNumberFormat ( ) : AutoNumberFormat	Gets the Format for an auto number column.
GetIndex ( ) : int?	Gets the Index.
GetLocked ( ) : bool?	Gets the flag whether column is locked or not.
GetOptions ( ) : IList	Gets the option for the column.
GetSymbol ( ) : Symbol?	Gets the Symbol for the column.
GetSystemColumnType ( ) : SystemColumnType?	Gets the system column Type.
GetTitle ( ) : string	Gets the Title.
GetType ( ) : ColumnType?	Gets the Type for the column.
GetWidth ( ) : long?	Gets the display width.
SetAutoNumberFormat ( AutoNumberFormat autoNumberFormat ) : AddColumnBuilder	Sets the Format for an auto number column.
SetIndex ( int index ) : AddColumnBuilder	Sets the position for the column.
SetLocked ( bool locked ) : AddColumnBuilder	Sets whether the column is locked.
SetOptions ( IList options ) : AddColumnBuilder	Sets the Options for the column.
SetSymbol ( Symbol symbol ) : AddColumnBuilder	Sets the Symbol for the column.
SetSystemColumnType ( SystemColumnType systemColumnType ) : AddColumnBuilder	Sets the system column Type.
SetTitle ( string title ) : AddColumnBuilder	Sets the Title for the column.
SetType ( ColumnType type ) : AddColumnBuilder	Sets the Type for the column.
SetWidth ( long width ) : AddColumnBuilder	Sets the Primary flag for the column.

Method Details

AddColumnBuilder() public method

Sets the required properties for adding a Column to a Sheet.

public AddColumnBuilder ( string title, int index, ColumnType type ) : System
title	string	the Column title
index	int	the Column index (zero-based)
type	ColumnType	the Column Type
return	System

Build() public method

Builds the column.

public Build ( ) : Column
return	Column

GetAutoNumberFormat() public method

Gets the Format for an auto number column.

public GetAutoNumberFormat ( ) : AutoNumberFormat
return	AutoNumberFormat

GetIndex() public method

Gets the Index.

public GetIndex ( ) : int?
return	int?

GetLocked() public method

Gets the flag whether column is locked or not.

public GetLocked ( ) : bool?
return	bool?

GetOptions() public method

Gets the option for the column.

public GetOptions ( ) : IList
return	IList

GetSymbol() public method

Gets the Symbol for the column.

public GetSymbol ( ) : Symbol?
return	Symbol?

GetSystemColumnType() public method

Gets the system column Type.

public GetSystemColumnType ( ) : SystemColumnType?
return	SystemColumnType?

GetTitle() public method

Gets the Title.

public GetTitle ( ) : string
return	string

GetType() public method

Gets the Type for the column.

public GetType ( ) : ColumnType?
return	ColumnType?

GetWidth() public method

Gets the display width.

public GetWidth ( ) : long?
return	long?

SetAutoNumberFormat() public method

Sets the Format for an auto number column.

public SetAutoNumberFormat ( AutoNumberFormat autoNumberFormat ) : AddColumnBuilder
autoNumberFormat	AutoNumberFormat	the auto number Format
return	AddColumnBuilder

SetIndex() public method

Sets the position for the column.

public SetIndex ( int index ) : AddColumnBuilder
index	int	the position
return	AddColumnBuilder

SetLocked() public method

Sets whether the column is locked.

public SetLocked ( bool locked ) : AddColumnBuilder
locked	bool	the flag
return	AddColumnBuilder

SetOptions() public method

Sets the Options for the column.

public SetOptions ( IList options ) : AddColumnBuilder
options	IList	the Options
return	AddColumnBuilder

SetSymbol() public method

Sets the Symbol for the column.

public SetSymbol ( Symbol symbol ) : AddColumnBuilder
symbol	Symbol	the Symbol
return	AddColumnBuilder

SetSystemColumnType() public method

Sets the system column Type.

public SetSystemColumnType ( SystemColumnType systemColumnType ) : AddColumnBuilder
systemColumnType	SystemColumnType	the system column Type
return	AddColumnBuilder

SetTitle() public method

Sets the Title for the column.

public SetTitle ( string title ) : AddColumnBuilder
title	string	the Title
return	AddColumnBuilder

SetType() public method

Sets the Type for the column.

public SetType ( ColumnType type ) : AddColumnBuilder
type	ColumnType	the Type
return	AddColumnBuilder

SetWidth() public method

Sets the Primary flag for the column.

public SetWidth ( long width ) : AddColumnBuilder
width	long	the width
return	AddColumnBuilder