ScrollBarActiveXControl

Inheritance: java.lang.Object, com.aspose.cells.ActiveXControlBase, com.aspose.cells.ActiveXControl, com.aspose.cells.SpinButtonActiveXControl

public class ScrollBarActiveXControl extends SpinButtonActiveXControl

Represents the ScrollBar control.

Example

         //Initialize a new workbook.
         Workbook book = new Workbook();
 
         //Add a ToggleButtonActiveXControl.
         Shape shape = book.getWorksheets().get(0).getShapes().addActiveXControl(ControlType.SCROLL_BAR, 1, 0, 1, 0, 100, 50);
         ScrollBarActiveXControl activeXControl = (ScrollBarActiveXControl)shape.getActiveXControl();
 
         //do your business
 
         //Save the excel file.
         book.save("exmaple.xlsx");

Methods

Method	Description
equals(Object arg0)
getBackOleColor()	Gets the ole color of the background.
getClass()
getData()	Gets the binary data of the control.
getFont()	Represents the font of the control.
getForeOleColor()	Gets the ole color of the foreground.
getHeight()	Gets the height of the control in unit of points.
getIMEMode()	Gets the default run-time mode of the Input Method Editor for the control as it receives focus.
getLargeChange()	Gets the amount by which the Position property changes
getLinkedCell()	Gets the linked cell.
getListFillRange()	Gets the list fill range.
getMax()	Gets the maximum acceptable value.
getMin()	Gets the minimum acceptable value.
getMouseIcon()	Gets a custom icon to display as the mouse pointer for the control.
getMousePointer()	Gets the type of icon displayed as the mouse pointer for the control.
getOrientation()	Gets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
getPosition()	Gets the value.
getShadow()	Indicates whether to show a shadow.
getSmallChange()	Gets the amount by which the Position property changes
getTextAlign()	Represents how to align the text used by the control.
getType()	Gets the type of the ActiveX control.
getWidth()	Gets the width of the control in unit of points.
getWorkbook()	Gets the Workbook object.
hashCode()
isAutoSize()	Indicates whether the control will automatically resize to display its entire contents.
isEnabled()	Indicates whether the control can receive the focus and respond to user-generated events.
isLocked()	Indicates whether data in the control is locked for editing.
isTransparent()	Indicates whether the control is transparent.
isVisible()	Indicates whether this control is visible.
notify()
notifyAll()
setAutoSize(boolean value)	Indicates whether the control will automatically resize to display its entire contents.
setBackOleColor(int value)	Sets the ole color of the background.
setEnabled(boolean value)	Indicates whether the control can receive the focus and respond to user-generated events.
setForeOleColor(int value)	Sets the ole color of the foreground.
setHeight(double value)	Sets the height of the control in unit of points.
setIMEMode(int value)	Sets the default run-time mode of the Input Method Editor for the control as it receives focus.
setLargeChange(int value)	Sets the amount by which the Position property changes
setLinkedCell(String value)	Sets the linked cell.
setListFillRange(String value)	Sets the list fill range.
setLocked(boolean value)	Indicates whether data in the control is locked for editing.
setMax(int value)	Sets the maximum acceptable value.
setMin(int value)	Sets the minimum acceptable value.
setMouseIcon(byte[] value)	Sets a custom icon to display as the mouse pointer for the control.
setMousePointer(int value)	Sets the type of icon displayed as the mouse pointer for the control.
setOrientation(int value)	Sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
setPosition(int value)	Sets the value.
setShadow(boolean value)	Indicates whether to show a shadow.
setSmallChange(int value)	Sets the amount by which the Position property changes
setTextAlign(int value)	Represents how to align the text used by the control.
setTransparent(boolean value)	Indicates whether the control is transparent.
setVisible(boolean value)	Indicates whether this control is visible.
setWidth(double value)	Sets the width of the control in unit of points.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getBackOleColor()

public int getBackOleColor()

Gets the ole color of the background.

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getData()

public byte[] getData()

Gets the binary data of the control.

Returns: byte[]

getFont()

public Font getFont()

Represents the font of the control.

Returns: Font

getForeOleColor()

public int getForeOleColor()

Gets the ole color of the foreground.

Remarks

Not applies to Image control.

Returns: int

getHeight()

public double getHeight()

Gets the height of the control in unit of points.

Returns: double

getIMEMode()

public int getIMEMode()

Gets the default run-time mode of the Input Method Editor for the control as it receives focus.

See InputMethodEditorMode.

Returns: int

getLargeChange()

public int getLargeChange()

Gets the amount by which the Position property changes

Example

         activeXControl.setLargeChange(5);

Returns: int

getLinkedCell()

public String getLinkedCell()

Gets the linked cell.

Returns: java.lang.String

getListFillRange()

public String getListFillRange()

Gets the list fill range.

Returns: java.lang.String

getMax()

public int getMax()

Gets the maximum acceptable value.

Example

         activeXControl.setMax(100);

Returns: int

getMin()

public int getMin()

Gets the minimum acceptable value.

Example

         activeXControl.setMin(0);

Returns: int

getMouseIcon()

public byte[] getMouseIcon()

Gets a custom icon to display as the mouse pointer for the control.

Returns: byte[]

getMousePointer()

public int getMousePointer()

Gets the type of icon displayed as the mouse pointer for the control.

See ControlMousePointerType.

Returns: int

getOrientation()

public int getOrientation()

Gets whether the SpinButton or ScrollBar is oriented vertically or horizontally.

See ControlScrollOrientation.

Example

         if(activeXControl.getOrientation() == com.aspose.cells.ControlScrollOrientation.AUTO)
         {
             activeXControl.setOrientation(com.aspose.cells.ControlScrollOrientation.HORIZONTAL);
         }

Returns: int

getPosition()

public int getPosition()

Gets the value.

Example

         activeXControl.setPosition(30);

Returns: int

getShadow()

public boolean getShadow()

Indicates whether to show a shadow.

Returns: boolean

getSmallChange()

public int getSmallChange()

Gets the amount by which the Position property changes

Example

         activeXControl.setSmallChange(5);

Returns: int

getTextAlign()

public int getTextAlign()

Represents how to align the text used by the control.

See TextAlignmentType.

Returns: int

getType()

public int getType()

Gets the type of the ActiveX control.

See ControlType.

Example

         if(activeXControl.getType() == com.aspose.cells.ControlType.SCROLL_BAR)
         {
             //do something
         }

Returns: int

getWidth()

public double getWidth()

Gets the width of the control in unit of points.

Returns: double

getWorkbook()

public Workbook getWorkbook()

Gets the Workbook object.

Returns: Workbook

hashCode()

public native int hashCode()

Returns: int

isAutoSize()

public boolean isAutoSize()

Indicates whether the control will automatically resize to display its entire contents.

Returns: boolean

isEnabled()

public boolean isEnabled()

Indicates whether the control can receive the focus and respond to user-generated events.

Returns: boolean

isLocked()

public boolean isLocked()

Indicates whether data in the control is locked for editing.

Returns: boolean

isTransparent()

public boolean isTransparent()

Indicates whether the control is transparent.

Returns: boolean

isVisible()

public boolean isVisible()

Indicates whether this control is visible.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAutoSize(boolean value)

public void setAutoSize(boolean value)

Indicates whether the control will automatically resize to display its entire contents.

Parameters:

Parameter	Type	Description
value	boolean

setBackOleColor(int value)

public void setBackOleColor(int value)

Sets the ole color of the background.

Parameters:

Parameter	Type	Description
value	int

setEnabled(boolean value)

public void setEnabled(boolean value)

Indicates whether the control can receive the focus and respond to user-generated events.

Parameters:

Parameter	Type	Description
value	boolean

setForeOleColor(int value)

public void setForeOleColor(int value)

Sets the ole color of the foreground.

Remarks

Not applies to Image control.

Parameters:

Parameter	Type	Description
value	int

setHeight(double value)

public void setHeight(double value)

Sets the height of the control in unit of points.

Parameters:

Parameter	Type	Description
value	double

setIMEMode(int value)

public void setIMEMode(int value)

Sets the default run-time mode of the Input Method Editor for the control as it receives focus.

See InputMethodEditorMode.

Parameters:

Parameter	Type	Description
value	int

setLargeChange(int value)

public void setLargeChange(int value)

Sets the amount by which the Position property changes

Parameters:

Parameter	Type	Description
value	int

setLinkedCell(String value)

public void setLinkedCell(String value)

Sets the linked cell.

Parameters:

Parameter	Type	Description
value	java.lang.String

setListFillRange(String value)

public void setListFillRange(String value)

Sets the list fill range.

Parameters:

Parameter	Type	Description
value	java.lang.String

setLocked(boolean value)

public void setLocked(boolean value)

Indicates whether data in the control is locked for editing.

Parameters:

Parameter	Type	Description
value	boolean

setMax(int value)

public void setMax(int value)

Sets the maximum acceptable value.

Parameters:

Parameter	Type	Description
value	int

setMin(int value)

public void setMin(int value)

Sets the minimum acceptable value.

Parameters:

Parameter	Type	Description
value	int

setMouseIcon(byte[] value)

public void setMouseIcon(byte[] value)

Sets a custom icon to display as the mouse pointer for the control.

Parameters:

Parameter	Type	Description
value	byte[]

setMousePointer(int value)

public void setMousePointer(int value)

Sets the type of icon displayed as the mouse pointer for the control.

See ControlMousePointerType.

Parameters:

Parameter	Type	Description
value	int

setOrientation(int value)

public void setOrientation(int value)

Sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.

See ControlScrollOrientation.

Parameters:

Parameter	Type	Description
value	int

setPosition(int value)

public void setPosition(int value)

Sets the value.

Parameters:

Parameter	Type	Description
value	int

setShadow(boolean value)

public void setShadow(boolean value)

Indicates whether to show a shadow.

Parameters:

Parameter	Type	Description
value	boolean

setSmallChange(int value)

public void setSmallChange(int value)

Sets the amount by which the Position property changes

Parameters:

Parameter	Type	Description
value	int

setTextAlign(int value)

public void setTextAlign(int value)

Represents how to align the text used by the control.

See TextAlignmentType.

Parameters:

Parameter	Type	Description
value	int

setTransparent(boolean value)

public void setTransparent(boolean value)

Indicates whether the control is transparent.

Parameters:

Parameter	Type	Description
value	boolean

setVisible(boolean value)

public void setVisible(boolean value)

Indicates whether this control is visible.

Parameters:

Parameter	Type	Description
value	boolean

setWidth(double value)

public void setWidth(double value)

Sets the width of the control in unit of points.

Parameters:

Parameter	Type	Description
value	double

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int