The ExpandStructure client API displays an object and its relationships of a designated kind.
|
Argument |
Description |
|---|---|
|
Parameter 1 |
GraphDef or PathDef to expand |
|
Parameter 1 description |
Name of the directed graph definition or path definition to execute. Path definition in the format of +/-PathDefn::RelationshipDisplayAs eg:- +SPFXmtlDocuments::Documents. |
|
Parameter 1 type |
String |
|
Parameter 1 default |
None |
|
Parameter 2 |
Column set to present results |
|
Parameter 2 description |
Name of the column set to present results. Default column set = SPFObject |
|
Parameter 2 type |
String |
|
Parameter 2 default |
SPFObject |
|
Parameter 3 |
Title |
|
Parameter 3 description |
Title for the form |
|
Parameter 3 type |
String |
|
Parameter 3 default |
None |
|
Parameter 4 |
Sort Criteria |
|
Parameter 4 description |
Sort Criteria - use / to represent each level then +/- Asc/Desc then comma for multi column followed by a /. So, to sort on name on second level: /Name+/ to sort on name second level then name on fourth level: /Name+//Name+/ |
|
Parameter 4 type |
String |
|
Parameter 4 default |
None |
|
Parameter 5 |
Suppress Drag/Drop |
|
Parameter 5 description |
Suppress Drag/Drop. The default is to allow drag-and-drop functionality (False) |
|
Parameter 5 type |
Boolean |
|
Parameter 5 default |
False |
|
Parameter 6 |
Suppress Display in Properties Grid |
|
Parameter 6 description |
Suppress single click show item in Properties window. The default is to show the item (False) |
|
Parameter 6 type |
Boolean |
|
Parameter 6 default |
False |
|
Parameter 7 |
Suppress RHM |
|
Parameter 7 description |
Suppress the entire shortcut menu. The default is to have it enabled (False) |
|
Parameter 7 type |
Boolean |
|
Parameter 7 default |
False |
|
Parameter 8 |
Suppress Rel Expansion on RHM |
|
Parameter 8 description |
Suppress the relationships on the shortcut menu, so you only see the actions. |
|
Parameter 8 type |
Boolean |
|
Parameter 8 default |
False |
|
Parameter 9 |
Initial Expansion Level |
|
Parameter 9 description |
The number of levels that will be expanded by default. The number to include relationship nodes, if visible. |
|
Parameter 9 type |
Integer |
|
Parameter 9 default |
None |
|
Parameter 10 |
Display Relationship Nodes |
|
Parameter 10 description |
Indicates whether to display relationship nodes in the Tree List View. |
|
Parameter 10 type |
Boolean |
|
Parameter 10 default |
True |
For more information on how to run a report to view the details of client APIs, see
Create a client API report.
The following methods use the ExpandStructure client API to to expand an object and certain relationships.
-
ExpandClassDef
-
ManageClassTrees
-
ManageEnumTrees
-
SectionedXmtlHistory
-
NonSectionedXmtlHistory
-
XmtlExpandSectionedStructure
-
XmtlExpandNonSectionedStructure