Skip to main content

GetParent

Returns the parent range object of the current format condition.

Inherited from ApiFormatCondition.GetParent.

Example

Retrieve the collection that owns a conditional formatting rule in a spreadsheet.

// How do I access the parent formatting collection that a specific rule belongs to in a spreadsheet?

// Trace back from a formatting rule to its owning collection to manage all related conditions in a spreadsheet.

const worksheet = Api.GetActiveSheet();

worksheet.GetRange('A1').SetValue('Sales Data');
worksheet.GetRange('A2').SetValue(100);
worksheet.GetRange('A3').SetValue(250);
worksheet.GetRange('A4').SetValue(150);

const dataRange = worksheet.GetRange('A2:A4');
const formatConditions = dataRange.GetFormatConditions();
const condition = formatConditions.Add('xlCellValue', 'xlGreater', '200');
condition.SetFillColor(Api.CreateColorFromRGB(200, 100, 100));

const parentRange = condition.GetParent();
worksheet.GetRange('C1').SetValue('Parent range:');
worksheet.GetRange('C2').SetValue(parentRange.GetAddress());