Edit

Excel.LinkedEntityId interface

Package:
excel

The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.

Remarks

API set: ExcelApi 1.16

Used by

Examples

// Loads a linked entity cell value using a LinkedEntityId.
async function loadLinkedEntity(domainId: string, entityId: string) {
    await Excel.run(async (context) => {
        // Specify the linked entity ID to load.
        const linkedEntityId: Excel.LinkedEntityId = {
            entityId: entityId,
            domainId: domainId,
            serviceId: 268436224, // Service ID used by Excel to identify linked entity cell values associated with an add-in.
            culture: "en-US",
        };

        // Load the linked entity cell value.
        context.workbook.linkedEntityDataDomains.loadLinkedEntityCellValue(linkedEntityId);
        await context.sync();
    });
}

Properties

culture

Represents which language culture was used to create this CellValue.
domainId

Represents a domain specific to a service used to create the CellValue.
entityId

Represents an identifier specific to a service used to create the CellValue.
serviceId

Represents which service was used to create the CellValue.

Property Details

culture

Represents which language culture was used to create this CellValue.

culture: string;

Property Value

string

Remarks

API set: ExcelApi 1.16

domainId

Represents a domain specific to a service used to create the CellValue.

domainId?: string;

Property Value

string

Remarks

API set: ExcelApi 1.16

entityId

Represents an identifier specific to a service used to create the CellValue.

entityId: string;

Property Value

string

Remarks

API set: ExcelApi 1.16

serviceId

Represents which service was used to create the CellValue.

serviceId: number;

Property Value

number

Remarks

API set: ExcelApi 1.16