Edit

Share via

Excel.StringCellValue interface

  • Reference
Package:
excel

Represents the value of a cell containing a string.

Remarks

[ API set: ExcelApi 1.16 ]

Properties

basicType

Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue

Represents the value that would be returned by Range.values for a cell with this value.
layouts

Represents layout information for views of this string value.
properties

Represents additional properties of this string value.
provider

Represents information that describes the service that provided the data in this StringCellValue. This information can be used for branding in card view.
referencedValues

Represents the cell values which are referenced within StringCellValue.properties.
type

Represents the type of this cell value.

Property Details

basicType

Represents the value that would be returned by Range.valueTypes for a cell with this value.

basicType?: RangeValueType.string | "String";

Property Value

string | "String"

Remarks

[ API set: ExcelApi 1.16 ]

basicValue

Represents the value that would be returned by Range.values for a cell with this value.

basicValue: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.16 ]

layouts

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents layout information for views of this string value.

layouts?: BasicViewLayouts;

Property Value

Excel.BasicViewLayouts

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

properties

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents additional properties of this string value.

properties?: {
            [key: string]: EntityPropertyType;
        };

Property Value

{ [key: string]: Excel.EntityPropertyType; }

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

provider

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents information that describes the service that provided the data in this StringCellValue. This information can be used for branding in card view.

provider?: CellValueProviderAttributes;

Property Value

Excel.CellValueProviderAttributes

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

referencedValues

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the cell values which are referenced within StringCellValue.properties.

referencedValues?: ReferencedValue[];

Property Value

Excel.ReferencedValue[]

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

Represents the type of this cell value.

type: CellValueType.string | ReferenceValueType.string | "String";

Property Value

string | string | "String"

Remarks

[ API set: ExcelApi 1.16 ]