C# Class Smartsheet.Api.Internal.SheetColumnResourcesImpl

This is the implementation of the SheetColumnResources. Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.
Inheritance: AbstractResources, SheetColumnResources
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method Description
AddColumns ( long sheetId, IEnumerable columns ) : IList

Inserts one or more columns into the Sheet specified in the URL.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/Columns
DeleteColumn ( long sheetId, long columnId ) : void

Deletes the Column specified in the URL.

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/columns/{columnId}
GetColumn ( long sheetId, long columnId, IEnumerable include ) : Api.Models.Column

Gets the Column specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/columns/{columnId}
ListColumns ( long sheetId, IEnumerable include, PaginationParameters paging ) : PaginatedResult

Gets a list of all Columns belonging to the Sheet specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/columns

This operation supports pagination of results. For more information, see Paging.
SheetColumnResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic

Constructor.
UpdateColumn ( long sheetId, Api.Models.Column column ) : Api.Models.Column

Updates properties of the column, moves the column, and/or renames the column.

You cannot change the type of a Primary column.

While dependencies are enabled on a sheet, you can’t change the type of any special calendar/Gantt columns.

If the column type is changed, all cells in the column will be converted to the new column type.

Type is optional when moving or renaming, but required when changing type or dropdown values.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/columns/{columnId}

Method Details

AddColumns() public method

Inserts one or more columns into the Sheet specified in the URL.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/Columns

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public AddColumns ( long sheetId, IEnumerable columns ) : IList
sheetId long the sheet Id
columns IEnumerable the column object(s)
return IList

DeleteColumn() public method

Deletes the Column specified in the URL.

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/columns/{columnId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public DeleteColumn ( long sheetId, long columnId ) : void
sheetId long the sheet Id
columnId long the column object
return void

GetColumn() public method

Gets the Column specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/columns/{columnId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public GetColumn ( long sheetId, long columnId, IEnumerable include ) : Api.Models.Column
sheetId long the sheet Id
columnId long the columnId
include IEnumerable elements to include in response
return Api.Models.Column

ListColumns() public method

Gets a list of all Columns belonging to the Sheet specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/columns

This operation supports pagination of results. For more information, see Paging.
if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public ListColumns ( long sheetId, IEnumerable include, PaginationParameters paging ) : PaginatedResult
sheetId long the sheet Id
include IEnumerable elements to include in response
paging Smartsheet.Api.Models.PaginationParameters the paging
return PaginatedResult

SheetColumnResourcesImpl() public method

Constructor.
if any argument is null
public SheetColumnResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic
smartsheet SmartsheetImpl the Smartsheet
return System.Collections.Generic

UpdateColumn() public method

Updates properties of the column, moves the column, and/or renames the column.

You cannot change the type of a Primary column.

While dependencies are enabled on a sheet, you can’t change the type of any special calendar/Gantt columns.

If the column type is changed, all cells in the column will be converted to the new column type.

Type is optional when moving or renaming, but required when changing type or dropdown values.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/columns/{columnId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public UpdateColumn ( long sheetId, Api.Models.Column column ) : Api.Models.Column
sheetId long the sheet Id
column Api.Models.Column column object to update
return Api.Models.Column