Class SummaryField

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

Represents the SummaryField object.

public class SummaryField : IdentifiableModel

Inheritance

object

IdentifiableModel

SummaryField

Inherited Members

IdentifiableModel.Equals(object)

IdentifiableModel.GetHashCode()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ContactOptions

Get contact options, only valid when type is CONTACT_LIST

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

Property Value

IList<Contact>

the list of contact options

CreatedAt

Get summary field time of creation.

public DateTime? CreatedAt { get; set; }

Property Value

DateTime?

createdAt

CreatedBy

Get User object of summary field creator

public User CreatedBy { get; set; }

Property Value

User

User object

DisplayValue

Gets the display value of the summary field

public string DisplayValue { get; set; }

Property Value

string

the display value

Format

Gets the format descriptor

public string Format { get; set; }

Property Value

string

the format

Formula

Gets the formula for the summary field

public string Formula { get; set; }

Property Value

string

the formula

Hyperlink

Gets the hyperlink associated with the field, if any

public Hyperlink Hyperlink { get; set; }

Property Value

Hyperlink

the hyperlink

Id

Override Id property so that JSON.NET knows to make an exception of not serializating the Id. (i.e. serialize the Id in this case)

public override long? Id { get; set; }

Property Value

long?

Image

Gets the image associated with the field, if any

public Image Image { get; set; }

Property Value

Image

the image

Index

Gets the field index or position

public int? Index { get; set; }

Property Value

int?

the index

Locked

Gets flag indicating whether field is locked

public bool? Locked { get; set; }

Property Value

bool?

true if row is locked

LockedForUser

Gets flag indicating whether field is locked for the requesting user

public bool? LockedForUser { get; set; }

Property Value

bool?

true if row is locked for user

ModifiedAt

Gets the last modification date and time

public DateTime? ModifiedAt { get; set; }

Property Value

DateTime?

modified at

ModifiedBy

Get the User who last modified the field

public User ModifiedBy { get; set; }

Property Value

User

User object

ObjectValue

Gets the field's objectValue

public ObjectValue ObjectValue { get; set; }

Property Value

ObjectValue

the ObjectValue

Options

Gets PICKLIST options

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

Property Value

IList<string>

options

Symbol

Gets applicable symbol for PICKLIST type

public string Symbol { get; set; }

Property Value

string

symbol

Title

Gets the field's title

public string Title { get; set; }

Property Value

string

title

Type

Gets the field's type - see Column Type

public ColumnType Type { get; set; }

Property Value

ColumnType

type

Validation

Gets flag indicating whether summary field values are restricted to type

public bool? Validation { get; set; }

Property Value

bool?

validation

See Also

SummaryField Object Help