Class Column

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

Represents the Column object.

public class Column : IdentifiableModel

Inheritance

object

IdentifiableModel

Column

Derived

ReportColumn

Inherited Members

IdentifiableModel.Id

IdentifiableModel.Equals(object)

IdentifiableModel.GetHashCode()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AutoNumberFormat

Gets the format for the auto-generated numbers.

public AutoNumberFormat AutoNumberFormat { get; set; }

Property Value

AutoNumberFormat

the auto number format

ContactOptions

Gets array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST

public IList<Contact> ContactOptions { get; set; }

Property Value

IList<Contact>

the contact options list

Description

Gets the column description

public string Description { get; set; }

Property Value

string

the column description

Format

The format descriptor.

Only returned if the include query string parameter contains format and this column has a non-default format applied to it.

public string Format { get; set; }

Property Value

string

Formula

The formula for a column.

public string Formula { get; set; }

Property Value

string

the column formula

Hidden

Gets the hidden flag.

public bool? Hidden { get; set; }

Property Value

bool?

the hidden flag

Index

Gets or sets the position of the column (zero-based).

public int? Index { get; set; }

Property Value

int?

the index

Locked

Flag indicating whether the column is locked. In a response, a value of true indicates that the column has been locked by the sheet owner or the admin.

public bool? Locked { get; set; }

Property Value

bool?

LockedForUser

Flag indicating whether the column is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request.

public bool? LockedForUser { get; set; }

Property Value

bool?

Options

Gets the list of options for the column.

public IList<string> Options { get; set; }

Property Value

IList<string>

the options

Primary

Gets the primary flag for the column.

public bool? Primary { get; set; }

Property Value

bool?

the primary flag

Symbol

Gets the symbol for the column.

public Symbol? Symbol { get; set; }

Property Value

Symbol?

the symbol

SystemColumnType

Gets the system column Type.

public SystemColumnType? SystemColumnType { get; set; }

Property Value

SystemColumnType?

the system column Type

Tags

Gets the tags that indicate a special Type of column.

public IList<ColumnTag> Tags { get; set; }

Property Value

IList<ColumnTag>

the tags

Title

Gets the title for the column.

public string Title { get; set; }

Property Value

string

the title

Type

Gets the column Type.

public ColumnType? Type { get; set; }

Property Value

ColumnType?

the Type

Validation

Indicates whether validation has been enabled for the column (value = true)

public bool? Validation { get; set; }

Property Value

bool?

Version

Gets the column compatiblity version, 0 for existing types, 1 for multi-assign, > 1 future use

public int? Version { get; set; }

Property Value

int?

Width

Display width of the column in pixels

public long? Width { get; set; }

Property Value

long?