Excel.RemoveDuplicatesResult class

Package:

excel

Represents the results from Range.removeDuplicates.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
removed	Number of duplicated rows removed by the operation.
uniqueRemaining	Number of remaining unique rows present in the resulting range.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RemoveDuplicatesResult object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RemoveDuplicatesResultData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

removed

Number of duplicated rows removed by the operation.

readonly removed: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

uniqueRemaining

Number of remaining unique rows present in the resulting range.

readonly uniqueRemaining: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:D11");

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult;

Parameters

options

Excel.Interfaces.RemoveDuplicatesResultLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.RemoveDuplicatesResult

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.RemoveDuplicatesResult;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.RemoveDuplicatesResult

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RemoveDuplicatesResult;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.RemoveDuplicatesResult

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RemoveDuplicatesResult object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RemoveDuplicatesResultData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.RemoveDuplicatesResultData;

Returns

Excel.Interfaces.RemoveDuplicatesResultData