Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ConsoleComponent Class

Represents a custom console component on a section of a page layout.

Namespace

Metadata

Usage

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

ConsoleComponent Properties

The following are properties for ConsoleComponent.

height

The height of the custom console component in pixels.

Signature

public Integer height {get; set;}

Property Value

Type: Integer

location

The location of the custom console component on the page layout. Valid values are right, left, top, and bottom.

Signature

public String location {get; set;}

Property Value

Type: String

visualforcePage

The unique name of the custom console component.

Signature

public String visualforcePage {get; set;}

Property Value

Type: String

width

The width of the custom console component in pixels.

Signature

public Integer width {get; set;}

Property Value

Type: Integer

ConsoleComponent Methods

The following are methods for ConsoleComponent.

clone()

Makes a duplicate copy of the Metadata.ConsoleComponent.

Signature

public Object clone()

Return Value

Type: Object