Table of Contents

Class Widget

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

Represents the widget object.

public class Widget : IdentifiableModel
Inheritance
Widget
Inherited Members

Properties

Contents

Get the data that specifies the contents of the widget. See description of contents variable for valid objects.

public IWidgetContent Contents { get; set; }

Property Value

IWidgetContent

the contents

Error

Error if this widget is in an error state

public Error Error { get; set; }

Property Value

Error

Height

Number of Rows that the widget occupies on the Sight.

public int? Height { get; set; }

Property Value

int?

the Height

ShowTitle

True indicates that the client should display the widget title. Note that this is independent of the “title” string which may be null or empty.

public bool? ShowTitle { get; set; }

Property Value

bool?

the showTitle flag

ShowTitleIcon

True indicates that the client should display the Sheet icon in the widget title.

public bool? ShowTitleIcon { get; set; }

Property Value

bool?

the showTitleIcon flag

Title

(Optional) Title of the widget.

public string Title { get; set; }

Property Value

string

the Title

TitleFormat

The title format FormatDescriptor string.

public string TitleFormat { get; set; }

Property Value

string

the FormatDescriptor

Type

Get the Type of widget.

public WidgetType Type { get; set; }

Property Value

WidgetType

the WidgetType

Version

Widget version number.

public int? Version { get; set; }

Property Value

int?

the Version

Width

Number of Columns that the widget occupies on the Sight.

public int? Width { get; set; }

Property Value

int?

the Width

XPosition

X-coordinate of widget’s position on the Sight.

public int? XPosition { get; set; }

Property Value

int?

the xPosition

YPosition

Y-coordinate of widget’s position on the Sight.

public int? YPosition { get; set; }

Property Value

int?

the yPosition

See Also