Main Content

getReferences

Get referenced cells

Since R2024b

Description

cellReferences = getReferences(spreadsheetCell) returns the Safety Analysis Manager spreadsheet referenced cells that the cell, spreadsheetCell, references.

example

Examples

collapse all

Create two Safety Analysis Manager spreadsheets, and store each Spreadsheet object in a variable.

mySpreadsheet1 = safetyAnalysisMgr.newSpreadsheet;
mySpreadsheet2 = safetyAnalysisMgr.newSpreadsheet;

Add three rows to each spreadsheet by using the addRow function.

addRow(mySpreadsheet1,Count=3)
addRow(mySpreadsheet2,Count=3)

Add a text column and derived column that have custom labels to the mySpreadsheet2 spreadsheet by using the addColumn function.

addColumn(mySpreadsheet2,Count=2,Type=["text","derived"]...
  ,Label=["Check Box Column","Derived Column"])

Add a check box column that has a custom label to the mySpreadsheet1 spreadsheet by using the addColumn function.

addColumn(mySpreadsheet1,Type="checkbox",Label="Check Box Column")

Save the spreadsheets.

save(mySpreadsheet1,"spreadsheet1.mldatx")
save(mySpreadsheet2,"spreadsheet2.mldatx")

Retrieve the SpreadsheetCell objects for the first cells in the first and second column in the mySpreadsheet1 spreadsheet and the first cell in the derived column in the mySpreadsheet2 spreadsheet.

myCell1(1) = getCell(mySpreadsheet1,1,1);
myCell1(2) = getCell(mySpreadsheet1,1,2);
myCell2 = getCell(mySpreadsheet2,1,"Derived Column");

Create a reference where the myCell2 cell references the myCell1 cells by using the addReference function.

addReference(myCell2,myCell1)

Retrieve the referenced cells.

myCellReferences = getReferences(myCell2);

Input Arguments

collapse all

Spreadsheet cell to add the reference to, specified as a SpreadsheetCell object. The cell must be in a derived column. For more information on derived columns, see Define Derived Values and Define the Derived Column Formula.

Output Arguments

collapse all

Referenced cells, returned as a cell array of CellReference objects. The cell array lists the referenced cells in the order of their creation. To adjust the order, use the moveReference function.

Version History

Introduced in R2024b