GetLayoutAsync Method
Overloads
| GetLayoutAsync() |
Evaluates an object and displays its properties including the dynamic properties. If the member Example:
Please refer to Engine API reference for illustrations. A A A |
|
| GetLayoutAsync(AsyncHandle) |
Evaluates an object and displays its properties including the dynamic properties. If the member Example:
Please refer to Engine API reference for illustrations. A A A |
GetLayoutAsync()
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.
Please refer to Engine API reference for illustrations.
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.
Declaration
Task<GenericObjectLayout> GetLayoutAsync()
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GenericObjectLayout> |
Remarks
In addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object.
For example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.
GetLayoutAsync(AsyncHandle)
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.
Please refer to Engine API reference for illustrations.
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.
Declaration
Task<GenericObjectLayout> GetLayoutAsync(AsyncHandle asyncHandle)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GenericObjectLayout> |
Remarks
In addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object.
For example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!