Newer Version Available
describePrimaryCompactLayouts()
Syntax
1DescribeCompactLayout[] primaryCompactLayouts = connection.describePrimaryCompactLayouts(string[] sObjectType)Usage
Use this call to retrieve information about the primary compact layout for the given object types. This call returns metadata about a given primary compact layout. For more information about compact layouts, see the Salesforce Help.
Sample Code—Java
1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17public void testDescribePrimaryCompactLayoutsSample() {
18 try {
19 String[] objectsToDescribe = new String[] {"Account","Lead"};
20 DescribeCompactLayout[] primaryCompactLayouts = connection.describePrimaryCompactLayouts(objectsToDescribe);
21
22 for (int i = 0; i < primaryCompactLayouts.length; i++) {
23 DescribeCompactLayout cLayout = primaryCompactLayouts[i];
24 System.out.println(" There is a compact layout with name: " + cLayout.getName());
25
26 // Write the objectType
27 System.out.println(" This compact layout is the primary compact layout for: " + cLayout.getObjectType());
28
29 DescribeLayoutItem[] fieldItems = cLayout.getFieldItems();
30 System.out.println(" There are " + fieldItems.length + " fields in this compact layout.");
31
32 // Write field items
33 for (int j = 0; j < fieldItems.length; j++) {
34 System.out.println(j + " This compact layout has a field with name: " + fieldItems[j].getLabel());
35 }
36
37 DescribeLayoutItem[] imageItems = cLayout.getImageItems();
38 System.out.println(" There are " + imageItems.length + " image fields in this compact layout.");
39
40 // Write the image items
41 for (int j = 0; j < imageItems.length; j++) {
42 System.out.println(j + " This compact layout has an image field with name: " + imageItems[j].getLabel());
43 }
44
45 DescribeLayoutButton[] actions = cLayout.getActions();
46 System.out.println(" There are " + actions.length + " buttons in this compact layout.");
47
48 // Write the action buttons
49 for (int j = 0; j < actions.length; j++) {
50 System.out.println(j + " This compact layout has a button with name: " + actions[j].getLabel());
51 }
52 }
53
54 } catch (ConnectionException ce) {
55 ce.printStackTrace();
56 }
57}Arguments
| Name | Type | Description |
|---|---|---|
| sObjectTypes | string[] | An array of one or more objects. The specified values must be valid objects for your organization. |