Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class ListBox

java.lang.Object
  extended by com.aspose.cells.Shape
      extended by com.aspose.cells.ListBox

public class ListBox
extends Shape


Method Summary
 java.lang.String getInputRange()
          Gets the worksheet range used to fill the specified combo box.
 int getItemCount()
          Gets the number of items in the list box.
 java.lang.String getLinkedCell()
          Gets the worksheet range linked to the control's value
 Cell getSelectedCell()
          Gets the selected cell.
 Cell[] getSelectedCells()
          Gets the selected cells.
 int getSelectedIndex()
          Gets the index number of the currently selected item in the list box.
 byte getSelectionType()
          Gets the selection mode of the specified list box.
 boolean isSelected(int index)
          Indicates whether the item is selected.
 boolean isShadow()
          Indicates whether the shape has 3-D shading.
 void setHeight(int height)
          Sets the height, in unit of pixel.
 void setInputRange(java.lang.String formula)
          Sets the worksheet range used to fill the specified combo box.
 void setLinkedCell(java.lang.String formula)
          Sets the worksheet range linked to the control's value
 void setSelectedIndex(int index)
          Sets the index number of the currently selected item in the list box.
 void setSelectedItem(int index, boolean selected)
          Sets whether the item is selected.
 void setSelectionType(byte type)
          Sets the selection mode of the specified list box.
 void setShadow(boolean flag)
          Sets whether the shape has 3-D shading.
 
Methods inherited from class com.aspose.cells.Shape
addHyperlink, getCharacters, getFill, getFont, getGroup, getHeight, getHeightCM, getHeightInch, getHeightInChart, getHyperlink, getLeft, getLeftCM, getLeftInch, getLeftInChart, getLine, getLowerRightColumn, getLowerRightRow, getName, getOrientation, getPlacement, getRotation, getText, getTextHorizontalAlignment, getTextVerticalAlignment, getTop, getTopCM, getTopInch, getTopInChart, getType, getUpperLeftColumn, getUpperLeftRow, getWidth, getWidthCM, getWidthInch, getWidthInChart, getZOrderPosition, hasLine, isFilled, isFlippedHorizontally, isFlippedVertically, isLockAspectRatio, isLocked, isPrintable, move, move, moveToCenter, setCharacters, setFilled, setFlippedHorizontally, setFlippedVertically, setFont, setHasLine, setHeightCM, setHeightInch, setHeightInChart, setLeft, setLeftCM, setLeftInch, setLeftInChart, setLeftPosition, setLeftPositionInPixel, setLockAspectRatio, setLocked, setName, setOrientation, setPlacement, setPrintable, setRotation, setText, setTextHorizontalAlignment, setTextVerticalAlignment, setTop, setTopCM, setTopInch, setTopInChart, setTopPosition, setTopPositionInPixel, setUpperLeftColumn, setUpperLeftRow, setWidth, setWidthCM, setWidthInch, setWidthInChart
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setHeight

public void setHeight(int height)
Description copied from class: Shape
Sets the height, in unit of pixel.

Overrides:
setHeight in class Shape
Parameters:
height - the height, in unit of pixel.

getLinkedCell

public java.lang.String getLinkedCell()
Gets the worksheet range linked to the control's value

Overrides:
getLinkedCell in class Shape
Returns:
the worksheet range linked to the control's value

setLinkedCell

public void setLinkedCell(java.lang.String formula)
Sets the worksheet range linked to the control's value

Overrides:
setLinkedCell in class Shape
Parameters:
formula - the worksheet range linked to the control's value

getInputRange

public java.lang.String getInputRange()
Gets the worksheet range used to fill the specified combo box.

Returns:
the worksheet range used to fill the specified combo box.

setInputRange

public void setInputRange(java.lang.String formula)
Sets the worksheet range used to fill the specified combo box.

Parameters:
formula - the worksheet range used to fill the specified combo box.

isShadow

public boolean isShadow()
Indicates whether the shape has 3-D shading.

Returns:
true if the shape has 3-D shading.

setShadow

public void setShadow(boolean flag)
Sets whether the shape has 3-D shading.

Parameters:
flag - true if the shape has 3-D shading.

getItemCount

public int getItemCount()
Gets the number of items in the list box.

Returns:
the number of items in the list box.

getSelectedIndex

public int getSelectedIndex()
Gets the index number of the currently selected item in the list box. Index is Zero-based. -1 means no item is selected.

Returns:
the index number of the currently selected item in the list box.

setSelectedIndex

public void setSelectedIndex(int index)
Sets the index number of the currently selected item in the list box. Index is Zero-based.

Parameters:
index - the index number of the currently selected item in the list box. -1 means no item is selected.

setSelectedItem

public void setSelectedItem(int index,
                            boolean selected)
Sets whether the item is selected.

Parameters:
index - the item index. Zero-based.
selected - whether the item is selected. true means that this item should be selected. false means that this item should be unselected.

isSelected

public boolean isSelected(int index)
Indicates whether the item is selected.

Parameters:
index - the item index
Returns:
whether the item is selected.

getSelectedCells

public Cell[] getSelectedCells()
Gets the selected cells.

Returns:
the selected cells. null if the input range is not set or no item is selected.

getSelectedCell

public Cell getSelectedCell()
Gets the selected cell.

Returns:
the current selected cell.

getSelectionType

public byte getSelectionType()
Gets the selection mode of the specified list box.

Returns:
the selection mode of the specified list box.

setSelectionType

public void setSelectionType(byte type)
Sets the selection mode of the specified list box.

Parameters:
type - the selection mode of the specified list box.