GetLayout method

Overview

Evaluates an object and displays its properties including the dynamic properties.

If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.

Example:

A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.

A GetLayout call on A returns information on the objects A, B and C.

A GetLayout call on B returns information on the objects B, D and E.

A GetLayout call on C returns information on the object C.

Parameters

None

Outputs

The following is returned in the output:

GenericObjectLayout

Name	Description	Type
qInfo	Identifier and type of the generic object.	NxInfo
qMeta	Information about publishing and permissions. This parameter is optional.	Null or NxMeta
qExtendsId	Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string.	String
qHasSoftPatches	Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).	Boolean
qError	This parameter is optional. Gives information on the error.	Null or NxLayoutErrors
qSelectionInfo	Information about the selections.	NxSelectionInfo

NxInfo

Name	Description	Type
qId	Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. This parameter is optional. If an identifier is not set, the engine automatically sets one.	String
qType	Type of the object. This parameter is mandatory.	String

NxMeta

Name	Description	Type
qName	Name. This property is optional.	String

NxLayoutErrors

Name	Description	Type
ErrorCode	Error code.	Integer

NxSelectionInfo

Name	Description	Type
qInSelections	Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections method.	Boolean
qMadeSelections	Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see BeginSelections method.	Boolean