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

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

Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method	Description
Build ( ) : Column	Builds the column.
CreateSheetColumnBuilder ( string title, bool primary, ColumnType type ) : System	Sets the required properties for a Column.
GetAutoNumberFormat ( ) : AutoNumberFormat	Gets the Format for an auto number column.
GetOptions ( ) : IList	Gets the option for the column.
GetPrimary ( ) : bool?	Gets the whether the Column is the Primary 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 ) : CreateSheetColumnBuilder	Sets the Format for an auto number column.
SetOptions ( IList options ) : CreateSheetColumnBuilder	Sets the Options for the column.
SetPrimary ( bool primary ) : CreateSheetColumnBuilder	Sets whether the column is the Primary Column.
SetSymbol ( Symbol symbol ) : CreateSheetColumnBuilder	Sets the Symbol for the column.
SetSystemColumnType ( SystemColumnType systemColumnType ) : CreateSheetColumnBuilder	Sets the system column Type.
SetTitle ( string title ) : CreateSheetColumnBuilder	Sets the Title for the column.
SetType ( ColumnType type ) : CreateSheetColumnBuilder	Sets the Type for the column.
SetWidth ( long width ) : CreateSheetColumnBuilder	Sets the Primary flag for the column.

Method Details

Build() public method

Builds the column.

public Build ( ) : Column
return	Column

CreateSheetColumnBuilder() public method

Sets the required properties for a Column.

public CreateSheetColumnBuilder ( string title, bool primary, ColumnType type ) : System
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
return	System

GetAutoNumberFormat() public method

Gets the Format for an auto number column.

public GetAutoNumberFormat ( ) : AutoNumberFormat
return	AutoNumberFormat

GetOptions() public method

Gets the option for the column.

public GetOptions ( ) : IList
return	IList

GetPrimary() public method

Gets the whether the Column is the Primary Column.

public GetPrimary ( ) : bool?
return	bool?

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 ) : CreateSheetColumnBuilder
autoNumberFormat	AutoNumberFormat	the auto number Format
return	CreateSheetColumnBuilder

SetOptions() public method

Sets the Options for the column.

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

SetPrimary() public method

Sets whether the column is the Primary Column.

public SetPrimary ( bool primary ) : CreateSheetColumnBuilder
primary	bool	the primary
return	CreateSheetColumnBuilder

SetSymbol() public method

Sets the Symbol for the column.

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

SetSystemColumnType() public method

Sets the system column Type.

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

SetTitle() public method

Sets the Title for the column.

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

SetType() public method

Sets the Type for the column.

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

SetWidth() public method

Sets the Primary flag for the column.

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