ISetCollectionInfo

​

Interface ISetCollectionInfo

interface ISetCollectionInfo

Extends com.amazon.apmf.IStandard This interface allows a publisher to describe an element which contains a collection of items. This interface is deprecated. Replaced by ISetCollectionInfo2.

​

Methods

​

caption()

void caption(string caption)

Set a textual description of this collection (a table caption for example). If the caption is displayed on-screen, use setOnScreenCaption instead.

​

Parameters

caption

string — Required the caption or description of this collection.

---

​

onScreenCaption()

void onScreenCaption(TextChunk[] caption)

Set the on-screen textual caption for this collection if any. If this collection does not have an on-screen caption, but adding a description would prove useful, use setCaption instead.

​

Parameters

caption

TextChunk[] — Required the text of the on-screen caption.

---

​

rowCount()

void rowCount(i32 rowCount)

Sets the number of rows in this collection.

​

Parameters

rowCount

i32 — Required the row count.

---

​

columnCount()

void columnCount(i32 columnCount)

Set the number of columns in this collection.

​

Parameters

columnCount

i32 — Required the column count.

---