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

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

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

Public Methods

Method	Description
Build ( ) : Column	Gets the sheet Id. Gets the column Id. Builds the column.
GetAutoNumberFormat ( ) : AutoNumberFormat	Gets the auto number Format.
GetFormat ( ) : int?	Gets the Format.
GetIndex ( ) : int?	Gets the Index.
GetOptions ( ) : IList	Gets the Options.
GetSymbol ( ) : Symbol?	Gets the Symbol.
GetSystemColumnType ( ) : SystemColumnType?	Gets the system column Type.
GetTitle ( ) : string	Gets the Title.
GetType ( ) : ColumnType?	Gets the Type.
SetAutoNumberFormat ( AutoNumberFormat autoNumberFormat ) : UpdateColumnBuilder	Sets the Format for an auto number column.
SetFormat ( string format ) : UpdateColumnBuilder	Sets the format descriptor.
SetIndex ( int index ) : UpdateColumnBuilder	Sets the position for the column.
SetLocked ( bool locked ) : UpdateColumnBuilder	Sets whether the column is locked.
SetOptions ( IList options ) : UpdateColumnBuilder	Sets the Options for the column.
SetSymbol ( Symbol symbol ) : UpdateColumnBuilder	Sets the Symbol for the column.
SetSystemColumnType ( SystemColumnType systemColumnType ) : UpdateColumnBuilder	Sets the system column Type for the column.
SetTitle ( string title ) : UpdateColumnBuilder	Sets the Title for the column.
SetType ( ColumnType type ) : UpdateColumnBuilder	Sets the Type for the column.
SetWidth ( long width ) : UpdateColumnBuilder	Sets the sheet Id. Sets the column Id. Sets the display width.
UpdateColumnBuilder ( long id, string title, int index ) : System	Sets the required properties for updating a column.

Method Details

Build() public method

Gets the sheet Id. Gets the column Id. Builds the column.

public Build ( ) : Column
return	Column

GetAutoNumberFormat() public method

Gets the auto number Format.

public GetAutoNumberFormat ( ) : AutoNumberFormat
return	AutoNumberFormat

GetFormat() public method

Gets the Format.

public GetFormat ( ) : int?
return	int?

GetIndex() public method

Gets the Index.

public GetIndex ( ) : int?
return	int?

GetOptions() public method

Gets the Options.

public GetOptions ( ) : IList
return	IList

GetSymbol() public method

Gets the Symbol.

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.

public GetType ( ) : ColumnType?
return	ColumnType?

SetAutoNumberFormat() public method

Sets the Format for an auto number column.

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

SetFormat() public method

Sets the format descriptor.

public SetFormat ( string format ) : UpdateColumnBuilder
format	string	the format
return	UpdateColumnBuilder

SetIndex() public method

Sets the position for the column.

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

SetLocked() public method

Sets whether the column is locked.

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

SetOptions() public method

Sets the Options for the column.

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

SetSymbol() public method

Sets the Symbol for the column.

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

SetSystemColumnType() public method

Sets the system column Type for the column.

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

SetTitle() public method

Sets the Title for the column.

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

SetType() public method

Sets the Type for the column.

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

SetWidth() public method

Sets the sheet Id. Sets the column Id. Sets the display width.

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

UpdateColumnBuilder() public method

Sets the required properties for updating a column.

public UpdateColumnBuilder ( long id, string title, int index ) : System
id	long	the id of the Column
title	string	the new Column title
index	int	the new Column index (zero-based)
return	System