getDocumentAttribute

Retrieve document attribute values in spreadsheet in Safety Analysis Manager

Since R2023b

Syntax

value = getDocumentAttribute(spreadsheet,property)

Description

value = getDocumentAttribute(spreadsheet,property) returns the document attribute value in the Safety Analysis Manager spreadsheet, spreadsheet, that has the property, property.

Examples

Retrieve Values of Document Attributes in Spreadsheet in Safety Analysis Manager

Create a new spreadsheet in the Safety Analysis Manager.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add three document attributes to the spreadsheet by using the addDocumentAttribute function.

addDocumentAttribute(mySpreadsheet,property="myAttribute1",value="1")
addDocumentAttribute(mySpreadsheet,property="myAttribute2",value="2")
addDocumentAttribute(mySpreadsheet,property="myAttribute3",value="3")

Retrieve the value of the document attribute with the property myAttribute1.

vals = getDocumentAttribute(mySpreadsheet,"myAttribute1");

Input Arguments

spreadsheet — Spreadsheet in Safety Analysis Manager

Spreadsheet object

Spreadsheet in the Safety Analysis Manager, specified as a Spreadsheet object.

property — Property of document attribute

string scalar | character vector

Property of the document attribute, specified as a string scalar or character vector.

Data Types: char | string

Output Arguments

value — Value of document attribute

character vector

Value of the document attribute, returned as a character vector.

Version History

Introduced in R2023b