Container Class

Represents a location and style in which to display more than one custom console component in the sidebars of the console.

Namespace

Metadata

Usage

Use this class when accessing Metadata.Layout metadata components. For more information, see “Container” in the Metadata API Developer Guide.

Container Properties

The following are properties for Container.

height

The height of the component’s container. The unit property determines the unit of measurement, in pixels or percent.

Signature

public Integer height {get; set;}

Property Value

Type: Integer

isContainerAutoSizeEnabled

If set to true, stacked console components in the sidebars autosize vertically.

Signature

public Boolean isContainerAutoSizeEnabled {get; set;}

Property Value

Type: Boolean

region

The location of the component’s container (right, left, bottom, top).

Signature

public String region {get; set;}

Property Value

Type: String

sidebarComponents

Represents a specific custom console component to display in the components’ container.

Signature

public List<Metadata.SidebarComponent> sidebarComponents {get; set;}

Property Value

Type: List<Metadata.SidebarComponent>

style

The style of the container in which to display multiple components (stack, tab, accordion).

Signature

public String style {get; set;}

Property Value

Type: String

unit

The unit of measurement, in pixels or percent, for the height or width of the components’ container.

Signature

public String unit {get; set;}

Property Value

Type: String

width

The width of the component’s container. The unit property determines the unit of measurement, in pixels or percent.

Signature

public Integer width {get; set;}

Property Value

Type: Integer

Container Methods

The following are methods for Container.

clone()

Makes a duplicate copy of the Metadata.Container.

Signature

public Object clone()

Return Value

Type: Object