LayoutItem Class

Represents the valid values that define a layout item.

Namespace

Metadata

Usage

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

LayoutItem Properties

The following are properties for LayoutItem.

analyticsCloudComponent

A Wave Analytics dashboard component on a page.

Signature

public Metadata.AnalyticsCloudComponentLayoutItem analyticsCloudComponent {get; set;}

behavior

Determines the field behavior.

Signature

public Metadata.UiBehavior behavior {get; set;}

Property Value

Type: Metadata.UiBehavior

canvas

References a canvas app.

Signature

public String canvas {get; set;}

Property Value

Type: String

component

References a component.

Signature

public String component {get; set;}

Property Value

Type: String

emptySpace

Controls if this layout item is a blank space.

Signature

public Boolean emptySpace {get; set;}

Property Value

Type: Boolean

field

The field name reference, relative to the layout, for example “Description” or “MyField__c”.

Signature

public String field {get; set;}

Property Value

Type: String

height

For s-controls and pages only, the height in pixels.

Signature

public Integer height {get; set;}

Property Value

Type: Integer

page_x

Reference to a Visualforce page.

Signature

public String page_x {get; set;}

Property Value

Type: String

reportChartComponent

Refers to a report chart that you can add to a standard or custom object page.

Signature

public Metadata.ReportChartComponentLayoutItem reportChartComponent {get; set;}

scontrol

Reference to an s-control.

Signature

public String scontrol {get; set;}

Property Value

Type: String

showLabel

For s-control and pages only, whether to show the label.

Signature

public Boolean showLabel {get; set;}

Property Value

Type: Boolean

showScrollbars

For s-control and pages only, whether to show scrollbars.

Signature

public Boolean showScrollbars {get; set;}

Property Value

Type: Boolean

width

For s-control and pages only, the width in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%.

Signature

public String width {get; set;}

Property Value

Type: String

LayoutItem Methods

The following are methods for LayoutItem.

clone()

Makes a duplicate copy of the Metadata.LayoutItem.

Signature

public Object clone()

Return Value

Type: Object