renameDocumentAttribute

R2026b

Rename document attributes in Safety Analysis Manager documents

Since R2023b

collapse all in page

Syntax

renameDocumentAttribute(spreadsheet,property,newProperty)
renameDocumentAttribute(faultTreeDocument,property,newProperty)

Description

renameDocumentAttribute(spreadsheet,property,newProperty) updates the specified property of a document attribute with a new property, newProperty, in the Safety Analysis Manager spreadsheet, spreadsheet.

example

renameDocumentAttribute(faultTreeDocument,property,newProperty) updates the specified property of a document attribute with a new property, newProperty in the Safety Analysis Manager fault tree document, faultTreeDocument. (since R2026b)

example

Examples

collapse all

Create a new spreadsheet in the Safety Analysis Manager.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add a document attribute to the spreadsheet by using the addDocumentAttribute function.

addDocumentAttribute(mySpreadsheet,property="myAttribute1",value="1")

Update the property of the document attribute to updatedAttribute1.

renameDocumentAttribute(...
mySpreadsheet,"myAttribute1","updatedAttribute1")

Create a new fault tree document in the Safety Analysis Manager.

myFaultTreeDoc = safetyAnalysisMgr.newDocument("fault-tree");

Add a document attribute to the fault tree document by using the addDocumentAttribute function.

addDocumentAttribute(myFaultTreeDoc,property="myAttribute1",value="1")

Update the myAttribute1 property to updatedAttribute1.

renameDocumentAttribute(...
myFaultTreeDoc,"myAttribute1","updatedAttribute1")

Input Arguments

collapse all

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

Fault tree document in the Safety Analysis Manager, specified as a FaultTreeDocument object.

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

Data Types: char | string

Updated property of existing document attribute, specified as a string scalar or character vector.

Data Types: char | string

Version History

Introduced in R2023b

expand all

See Also

Objects

Functions