SidebarComponent Class
Represents a specific custom console component to display in a container that hosts multiple components in one of the sidebars of the Salesforce console.
Use this class when accessing Metadata.Layout metadata components. For more information, see “SidebarComponent” in the Metadata API Developer Guide.
The following are properties for SidebarComponent.
-
Specifies the component type. Valid values are “KnowledgeOne”, “Lookup”, “Milestones”, “RelatedList”, “Topics”, “Files”, and “CaseExperts”.
-
If the component is a lookup field, the name of the quick action used to create a record.
-
If the component is a lookup field, lets users associate a record with this field.
-
The height of the component in the container. The
unitproperty determines the unit of measurement, in pixels or percent. -
Indicates if the component is enabled for Knowledge One.
-
The name of the component as it displays to console users. Available for components in a container with the style of tabs or accordion.
-
If the component is a lookup field, the name of the field.
-
If the component is a Visualforce page, the name of the Visualforce page.
-
If the component is a related list component, the list of related list names.
-
The unit of measurement (pixels or percent) for the height and width of the component in the container.
-
If the component is a lookup field, the name of the quick action used to update a record.
-
The width of the component in the container. The
unitproperty determines the unit of measurement, in pixels or percent.
Specifies the component type. Valid values are “KnowledgeOne”, “Lookup”, “Milestones”, “RelatedList”, “Topics”, “Files”, and “CaseExperts”.
public String componentType {get; set;}
Type: String
If the component is a lookup field, the name of the quick action used to create a record.
public String createAction {get; set;}
Type: String
If the component is a lookup field, lets users associate a record with this field.
public Boolean enableLinking {get; set;}
Type: Boolean
The height of the component in the container. The unit property determines the unit of measurement, in pixels or percent.
public Integer height {get; set;}
Type: Integer
Indicates if the component is enabled for Knowledge One.
public Boolean knowledgeOneEnable {get; set;}
Type: Boolean
The name of the component as it displays to console users. Available for components in a container with the style of tabs or accordion.
public String label {get; set;}
Type: String
If the component is a lookup field, the name of the field.
public String lookup {get; set;}
Type: String
If the component is a Visualforce page, the name of the Visualforce page.
public String page_x {get; set;}
Type: String
If the component is a related list component, the list of related list names.
public List<Metadata.RelatedList> relatedLists {get; set;}
Type: List<Metadata.RelatedList>
The unit of measurement (pixels or percent) for the height and width of the component in the container.
public String unit {get; set;}
Type: String
If the component is a lookup field, the name of the quick action used to update a record.
public String updateAction {get; set;}
Type: String
The width of the component in the container. The unit property determines the unit of measurement, in pixels or percent.
public Integer width {get; set;}
Type: Integer
The following are methods for SidebarComponent.
-
Makes a duplicate copy of the
Metadata.SidebarComponent.
Makes a duplicate copy of the Metadata.SidebarComponent.
public Object clone()
Type: Object