cphChangeEditMode

cphChangeEditMode(
g_cphID
t_newMode
)
=> t / nil

Description

Changes the physConfig from edit mode to the specified mode. If switching to read mode, r, and the physConfig has changed since the last edit, a prompt for saving or discarding the edits displays.

Arguments

g_cphID	ID of physical configuration view.
t_newMode	The mode in which the physConfig open for editing needs to be reopened. Other supported modes are: Read mode (r) Access mode (a)

Value Returned

t	Successfully changed the edit mode of the physical configuration view.
nil	The edit mode of the physical configuration view could not be changed.

Example

For the specified layout cellview ID, the physical configuration view is changed to Read mode (r).

cph = cphGetLayoutXLConfig(layoutCVId)

cphChangeEditMode(cph "r")

Return to top