Table of Contents

Class AbstractSheet<TRow, TColumn, TCell>

Namespace
Smartsheet.Api.Models
Assembly
smartsheet-csharp-sdk.dll

Represents the Sheet object.

public abstract class AbstractSheet<TRow, TColumn, TCell> : NamedModel where TRow : AbstractRow<TColumn, TCell> where TColumn : Column where TCell : Cell

Type Parameters

TRow
TColumn
TCell
Inheritance
AbstractSheet<TRow, TColumn, TCell>
Derived
Inherited Members

Fields

columns

Represents the columns for the sheet.

[CLSCompliant(false)]
protected IList<TColumn> columns

Field Value

IList<TColumn>

rows

Represents the rows for the sheet.

[CLSCompliant(false)]
protected IList<TRow> rows

Field Value

IList<TRow>

Properties

AccessLevel

Gets the access level for the sheet.

public AccessLevel? AccessLevel { get; set; }

Property Value

AccessLevel?

the access level

Attachments

Gets the attachments for the sheet.

public IList<Attachment> Attachments { get; set; }

Property Value

IList<Attachment>

the attachments

Columns

Gets the columns for the sheet.

public IList<TColumn> Columns { get; set; }

Property Value

IList<TColumn>

the columns

ContactReferences

Gets the list of contact references for this sheet

public IList<ContactObjectValue> ContactReferences { get; set; }

Property Value

IList<ContactObjectValue>

CreatedAt

Gets the date and time the sheet was created.

public DateTime? CreatedAt { get; set; }

Property Value

DateTime?

the created at

CrossSheetReferences

Gets the list of cross-sheet references used by this sheet

public IList<CrossSheetReference> CrossSheetReferences { get; set; }

Property Value

IList<CrossSheetReference>

DependenciesEnabled

Gets the dependencies enabled flag.

public bool? DependenciesEnabled { get; set; }

Property Value

bool?

the dependencies enabled

Discussions

Gets the discussions for the sheet.

public IList<Discussion> Discussions { get; set; }

Property Value

IList<Discussion>

the discussions

EffectiveAttachmentOptions

Array of enum strings (see Attachment.attachmentType) indicating the allowable attachment options for the current user and sheet

public IList<AttachmentType> EffectiveAttachmentOptions { get; set; }

Property Value

IList<AttachmentType>

list of attachment types

Favorite

Returned only if the user has marked this sheet as a favorite in their Home tab (value = “true”).

public bool? Favorite { get; set; }

Property Value

bool?

true if marked as favorite, false otherwise

Filters

Gets the list of sheet filters for this sheet.

public IList<SheetFilter> Filters { get; set; }

Property Value

IList<SheetFilter>

the list of sheet filters

FromId

Gets the Id of the sheet/template from which the sheet was created.

public long? FromId { get; set; }

Property Value

long?

the from Id

GanttEnabled

Gets the Gantt enabled flag.

public bool? GanttEnabled { get; set; }

Property Value

bool?

the Gantt enabled flag

HasSummaryFields

Gets a flag indicating whether the sheet summary is present

public bool? HasSummaryFields { get; set; }

Property Value

bool?

flag indicating whether the sheet summary is present

ModifiedAt

Gets the date and time the sheet was last modified.

public DateTime? ModifiedAt { get; set; }

Property Value

DateTime?

the modified at

Owner

Represents the email of the owner

public string Owner { get; set; }

Property Value

string

OwnerId

Represents the Id of the owner

public long? OwnerId { get; set; }

Property Value

long?

Gets the Permalink for the sheet.

public string Permalink { get; set; }

Property Value

string

the Permalink

ProjectSettings

Gets sheet’s project settings containing the working days, non-working days, and length of day for a project sheet

public ProjectSettings ProjectSettings { get; set; }

Property Value

ProjectSettings

ReadOnly

Gets the read only flag for the sheet.

public bool? ReadOnly { get; set; }

Property Value

bool?

the read only

ResourceManagementEnabled

Indicates whether resource management is enabled.

public bool? ResourceManagementEnabled { get; set; }

Property Value

bool?

true if enabled, false otherwise

Rows

Gets the rows for the sheet.

public IList<TRow> Rows { get; set; }

Property Value

IList<TRow>

the rows

ShowParentRowsForFilters

Returned only if there are column filters on the sheet. Value = “true” if “show parent rows” is enabled for the filters.

public bool? ShowParentRowsForFilters { get; set; }

Property Value

bool?

“true” if “show parent rows” is enabled for the filters

Source

A Source object indicating the sheet or template from which this sheet was created.

public Source Source { get; set; }

Property Value

Source

source of sheet

Summary

A SheetSummary object containting the sheet summary if available

public SheetSummary Summary { get; set; }

Property Value

SheetSummary

the sheet summary

TotalRowCount

The total number of rows in the sheet.

public long? TotalRowCount { get; set; }

Property Value

long?

The total number of rows in the sheet

UserPermissions

A SheetUserPermissions object containing the sheet user permissions

public SheetUserPermissions UserPermissions { get; set; }

Property Value

SheetUserPermissions

the sheet user permissions

UserSettings

A SheetUserSettings object containing the current user’s sheet-specific settings..

public SheetUserSettings UserSettings { get; set; }

Property Value

SheetUserSettings

SheetUserSettings object

Version

Gets the version for the sheet.

public int? Version { get; set; }

Property Value

int?

the version

Workspace

Gets the workspace (ID and Name only) for the sheet

public Workspace Workspace { get; set; }

Property Value

Workspace

the workspace

Methods

GetColumnByIndex(int)

Gets a column by index.

public TColumn GetColumnByIndex(int index)

Parameters

index int

the column index

Returns

TColumn

the column by index

GetRowByRowNumber(int)

Get a Row by row number.

public TRow GetRowByRowNumber(int rowNumber)

Parameters

rowNumber int

the row number

Returns

TRow

the row by row number

Edit this page