apex:pageBlockTable

A list of data displayed as a table within either an <apex:pageBlock> or <apex:pageBlockSection> component, similar to a related list or list view in a standard Salesforce page. Like an <apex:dataTable>, an <apex:pageBlockTable> is defined by iterating over a set of data, displaying information about one item of data per row. The set of data can contain up to 1,000 items.

The body of the <apex:pageBlockTable> contains one or more column components that specify what information should be displayed for each item of data, similar to a table. Unlike the <apex:dataTable> component, the default styling for <apex:pageBlockTable> matches standard Salesforce styles. Any additional styles specified with <apex:pageBlockTable> attributes are appended to the standard Salesforce styles.

Note that if you specify an sObject field as the value attribute for a column, the associated label for that field is used as the column header by default. To override this behavior, use the headerValue attribute on the column, or the column's header facet.

For Visualforce pages running Salesforce.com API version 20.0 or higher, an <apex:repeat> tag can be contained within this component to generate columns.

This component supports HTML pass-through attributes using the "html-" prefix. Pass-through attributes are attached to the generated table's <tbody> tag.

Example

<!-- For this example to render properly, you must associate the Visualforce page 

with a valid account record in the URL. 

For example, if 001D000000IRt53 is the account ID, the resulting URL should be: 

https://Salesforce_instance/apex/myPage?id=001D000000IRt53

See the Visualforce Developer's Guide Quick Start Tutorial for more information. -->
                        

         



<!-- Page: -->

<apex:page standardController="Account"> <apex:pageBlock title="My Content"> <apex:pageBlockTable value="{!account.Contacts}" var="item"> <apex:column value="{!item.name}"/> </apex:pageBlockTable> </apex:pageBlock> </apex:page>

Attributes

Attribute Name Attribute Type Description Required? API Version Access
align String The position of the rendered HTML table with respect to the page. Possible values include "left", "center", or "right". If left unspecified, this value defaults to "left". 12.0 global
bgcolor String This attribute was deprecated in Salesforce API version 18.0 and has no effect on the page. 12.0 global
border String The width of the frame around the rendered HTML table, in pixels. 12.0 global
captionClass String The style class used to display the caption for the rendered HTML table, if a caption facet is specified. This attribute is used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 12.0 global
captionStyle String The style used to display the caption for the rendered HTML table, if a caption facet is specified. This attribute is used primarily for adding inline CSS styles. 12.0 global
cellpadding String The amount of space between the border of each list cell and its content. If the value of this attribute is a pixel length, all four margins are this distance from the content. If the value of the attribute is a percentage length, the top and bottom margins are equally separated from the content based on a percentage of the available vertical space, and the left and right margins are equally separated from the content based on a percentage of the available horizontal space. 12.0 global
cellspacing String The amount of space between the border of each list cell and the border of the other cells surrounding it and/or the list's edge. This value must be specified in pixels or percentage. 12.0 global
columnClasses String A comma-separated list of one or more classes associated with the list's columns, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. If more than one class is specified, the classes are applied in a repeating fashion to all columns. For example, if you specify columnClasses="classA, classB", then the first column is styled with classA, the second column is styled with classB, the third column is styled with classA, the fourth column is styled with classB, and so on. 12.0 global
columns Integer The number of columns in this page block table. 12.0 global
columnsWidth String A comma-separated list of the widths applied to each list column. Values can be expressed as pixels (for example, columnsWidth="100px, 100px"). 12.0 global
dir String The direction in which the generated HTML component should be read. Possible values include "RTL" (right to left) or "LTR" (left to right). 12.0 global
first Integer The first element in the iteration visibly rendered in the page block table, where 0 is the index of the first element in the set of data specified by the value attribute. For example, if you did not want to display the first two elements in the set of records specified by the value attribute, set first="2". 12.0 global
footerClass String The style class used to display the footer (bottom row) for the rendered HTML table, if a footer facet is specified. This attribute is used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 12.0 global
frame String The borders drawn for this page block table. Possible values include "none", "above", "below", "hsides", "vsides", "lhs", "rhs", "box", and "border". If not specified, this value defaults to "border". 12.0 global
headerClass String The style class used to display the header for the rendered HTML table, if a header facet is specified. This attribute is used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 12.0 global
id String An identifier that allows the pageBlockTable component to be referenced by other components in the page. 12.0 global
lang String The base language for the generated HTML output, for example, "en" or "en-US". For more information on this attribute, see the W3C specifications. 12.0 global
onclick String The JavaScript invoked if the onclick event occurs--that is, if the user clicks the page block table. 12.0 global
ondblclick String The JavaScript invoked if the ondblclick event occurs--that is, if the user clicks the page block table twice. 12.0 global
onkeydown String The JavaScript invoked if the onkeydown event occurs--that is, if the user presses a keyboard key. 12.0 global
onkeypress String The JavaScript invoked if the onkeypress event occurs--that is, if the user presses or holds down a keyboard key. 12.0 global
onkeyup String The JavaScript invoked if the onkeyup event occurs--that is, if the user releases a keyboard key. 12.0 global
onmousedown String The JavaScript invoked if the onmousedown event occurs--that is, if the user clicks a mouse button. 12.0 global
onmousemove String The JavaScript invoked if the onmousemove event occurs--that is, if the user moves the mouse pointer. 12.0 global
onmouseout String The JavaScript invoked if the onmouseout event occurs--that is, if the user moves the mouse pointer away from the page block table. 12.0 global
onmouseover String The JavaScript invoked if the onmouseover event occurs--that is, if the user moves the mouse pointer over the page block table. 12.0 global
onmouseup String The JavaScript invoked if the onmouseup event occurs--that is, if the user releases the mouse button. 12.0 global
onRowClick String The JavaScript invoked if the onRowClick event occurs--that is, if the user clicks a row in the page block table. 12.0 global
onRowDblClick String The JavaScript invoked if the onRowDblClick event occurs--that is, if the user clicks a row in the page block list table. 12.0 global
onRowMouseDown String The JavaScript invoked if the onRowMouseDown event occurs--that is, if the user clicks a mouse button in a row of the page block table. 12.0 global
onRowMouseMove String The JavaScript invoked if the onRowMouseMove event occurs--that is, if the user moves the mouse pointer over a row of the page block table. 12.0 global
onRowMouseOut String The JavaScript invoked if the onRowMouseOut event occurs--that is, if the user moves the mouse pointer away from a row in the page block table. 12.0 global
onRowMouseOver String The JavaScript invoked if the onRowMouseOver event occurs--that is, if the user moves the mouse pointer over a row in the page block table. 12.0 global
onRowMouseUp String The JavaScript invoked if the onRowMouseUp event occurs--that is, if the user releases the mouse button over a row in the page block table. 12.0 global
rendered Boolean A Boolean value that specifies whether the component is rendered on the page. If not specified, this value defaults to true. 12.0 global
rowClasses String A comma-separated list of one or more classes associated with the page block table's rows, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. If more than one class is specified, the classes are applied in a repeating fashion to all rows. For example, if you specify columnRows="classA, classB", then the first row is styled with classA, the second row is styled with classB, the third row is styled with classA, the fourth row is styled with classB, and so on. 12.0 global
rows Integer The number of rows in this page block table. 12.0 global
rules String The borders drawn between cells in the page block table. Possible values include "none", "groups", "rows", "cols", and "all". If not specified, this value defaults to "none". 12.0 global
style String The style used to display the pageBlockTable component, used primarily for adding inline CSS styles. 12.0 global
styleClass String The style class used to display the pageBlockTable component, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 12.0 global
summary String A summary of the page block table's purpose and structure for Section 508 compliance. 12.0 global
title String The text to display as a tooltip when the user's mouse pointer hovers over this component. 12.0 global
value Object The collection of data displayed in the page block table. Yes 12.0 global
var String The name of the variable that represents one element in the collection of data specified by the value attribute. You can then use this variable to display the element itself in the body of the pageBlockTable component tag. Yes 12.0 global
width String The width of the entire pageBlockTable, expressed either as a relative percentage to the total amount of available horizontal space (for example, width="80%"), or as the number of pixels (for example, width="800px"). 12.0 global

Facets

Facet Name Description API Version
caption The components that appear in the caption for the page block table. Note that the order in which a caption facet appears in the body of a pageBlockTable component does not matter, because any facet with name="caption" will control the appearance of the table's caption. 12.0
footer The components that appear in the footer row for the page block table. Note that the order in which a footer facet appears in the body of a pageBlockTable component does not matter, because any facet with name="footer" will control the appearance of the final row in the table. 12.0
header The components that appear in the header row for the page block table. Note that the order in which a header facet appears in the body of a pageBlockTable component does not matter, because any facet with name="header" will control the appearance of the first row in the table. 12.0
© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.