Class ReportColumnIdentifier

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

An object for matching a source sheet column for a report. It requires one of:

• [type, title] for regular columns
• [type, systemColumnType] for system columns
• [type=TEXT_NUMBER, primary=true] for the primary column
• [type=TEXT_NUMBER, sheetNameColumn=true] for the special sheet name report column

Note: You can combine multiple CHECKBOX columns or multiple PICKLIST columns from different sheets into a single report column, even if their underlying symbols differ. However, you can't combine a CHECKBOX column with a PICKLIST column, because they're different types.

Note: The system column type AUTO_NUMBER is matched together with columns having the same title and type=TEXT_NUMBER. Therefore, title is a required property in this case.

public class ReportColumnIdentifier

Inheritance

object

ReportColumnIdentifier

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Primary

Gets or sets whether to match the primary column.

public bool? Primary { get; set; }

Property Value

bool?

true if primary, false otherwise

SheetNameColumn

Gets or sets whether to match the special "Sheet Name" report column.

public bool? SheetNameColumn { get; set; }

Property Value

bool?

true if sheet name column, false otherwise

SystemColumnType

Gets or sets the system column type to match.

public SystemColumnType? SystemColumnType { get; set; }

Property Value

SystemColumnType?

the system column type

Title

Gets or sets the title of a column to match. Note: If you specified primary=true to match primary columns, you can set the resulting report column title to this value.

public string? Title { get; set; }

Property Value

string

the title

Type

Gets or sets the type of column to match.

public ColumnType Type { get; set; }

Property Value

ColumnType

the type