View Source

h2. Overview
_Since 3.0_

When using the data exporter utility, if one wishes to prevent certain data to be exported in the file, one can add the {{<ace:excludeFromExport />}} tag inside the component one wants to avoid exporting. If this tag is placed inside {{<ace:column>}}, {{<ace:row>}}, or {{<ace:columnGroup>}} it will prevent the entire column, row or column group from being exported. This component is only read by the data exporter. It doesn't affect any other aspect of the page.

{tip}See the ICEfaces Showcase [Live Demo|http://icefaces-showcase.icesoft.org/showcase.jsf?grp=aceMenu&exp=excludeFromExport] of this component, complete with source code.{tip}

h2. Getting Started

The following is an example of {{<ace:excludeFromExport />}}.

{panel}
{code:xml|borderStyle=dashed}
<ace:dataExporter type="csv" target="myTable" fileName="tableData"/>

<ace:dataTable id="myTable" value="#{bean.items}" var="item">
<ace:column headerText="Column One">
<ace:excludeFromExport />
<h:outputText value="#{item.propertyA}"/>
</ace:column>
<ace:column headerText="Column Two">
<h:outputText value="#{item.propertyB}"/>
<h:outputText value="#{item.propertyC}">
<ace:excludeFromExport />
</h:outputText>
</ace:column>
</ace:dataTable>
{code}
{panel}
The code above will prevent the entire first column from being exported, and for the second column, only property B will be exported.

If a table is using stacked columns, it won't affect the results of the exporting action. The data exporter is unaware of stacked columns.

h2. Attributes

This component has no attributes.

{tip:title=TagLib Documentation}For reference, the complete taglib documentation for this component is available [here|http://res.icesoft.org/docs/v4_latest/ace/tld/ace/excludeFromExport.html].{tip}


h2. JavaScript APIs / Client Behaviours

This component doesn't affect any aspect of the client side.

h2. Keyboard and ARIA Support

Not applicable.

h2. Known Issues

None, at the moment.