FormIt Plugin API  v23.0.0 (2023.0.0)
FormIt.GroupEdit API

Description

Functions

json FormIt.GroupEdit.GetEditingHistoryID ()
 
json FormIt.GroupEdit.GetInContextEditingPath ()
 Get the editing context path. More...
 
json FormIt.GroupEdit.SetInContextEditingPath (path)
 Set the editing context path. More...
 
json FormIt.GroupEdit.IsEditingInContext ()
 Returns true if edit in context is happening. More...
 
json FormIt.GroupEdit.EndEditInContext ()
 End editing in context. More...
 
json FormIt.GroupEdit.ExitToParentContext ()
 Exit to the parent context. More...
 
json FormIt.GroupEdit.GetShowEditedGroupOnly ()
 Returns the status of the "Show Edited Group Only" option. More...
 
json FormIt.GroupEdit.SetShowEditedGroupOnly (show)
 Sets the status of the "Show Edited Group Only" option. More...
 

Function Documentation

json FormIt.GroupEdit.EndEditInContext ( )

End editing in context.

Returns
JSON_UNDEFINED
json FormIt.GroupEdit.ExitToParentContext ( )

Exit to the parent context.

If editing a nested group, this method will exit to the parent context as defined by the editing path.

Returns
JSON_UNDEFINED
json FormIt.GroupEdit.GetEditingHistoryID ( )
json FormIt.GroupEdit.GetInContextEditingPath ( )

Get the editing context path.

The path is to the specific instance that is being edited.

Returns
Returns WSM.GroupInstancePath.
json FormIt.GroupEdit.GetShowEditedGroupOnly ( )

Returns the status of the "Show Edited Group Only" option.

Returns
Returns true if "Show Edited Group Only" is active.
json FormIt.GroupEdit.IsEditingInContext ( )

Returns true if edit in context is happening.

Returns
Returns true if currently editing in context.
json FormIt.GroupEdit.SetInContextEditingPath ( path  )

Set the editing context path.

The path is to the specific instance that should be edited.

Parameters
[in]pathWSM.GroupInstancePath
Returns
Returns success.
json FormIt.GroupEdit.SetShowEditedGroupOnly ( show  )

Sets the status of the "Show Edited Group Only" option.

Parameters
[in]valWSM.GroupInstancePath
[in]showbool
Returns
JSON_UNDEFINED