GetParent

Returns the parent ApiWorksheet object for the AutoFilter.

Syntax

expression.GetParent();

expression - A variable that represents a ApiAutoFilter class.

Parameters

This method doesn't have any parameters.

Returns

ApiWorksheet

Example

This example retrieves the worksheet that owns the AutoFilter.

• Code
• Result

// How to navigate back from ApiAutoFilter to ApiWorksheet.

// Use ApiAutoFilter.GetParent() to get the parent sheet.

let worksheet = Api.GetActiveSheet();

// Create a simple AutoFilter
worksheet.GetRange("A1").SetValue("Name");
worksheet.GetRange("A2").SetValue("Alice");
worksheet.GetRange("A3").SetValue("Bob");
worksheet.GetRange("A4").SetValue("Charlie");

let range = worksheet.GetRange("A1:A4");
range.SetAutoFilter();

// Get the AutoFilter and its parent worksheet
let autoFilter = worksheet.AutoFilter;
let parentSheet = autoFilter.GetParent();   // or autoFilter.Parent

worksheet.GetRange("C1").SetValue("Parent worksheet name:");
worksheet.GetRange("C2").SetValue(parentSheet.GetName());

worksheet.GetRange("C4").SetValue("AutoFilter is attached to this worksheet.");