|
||
| Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate | ||
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectcom.aspose.cells.TextBox
public class TextBox
Encapsulates the object that represents a textbox in a spreadsheet.
| Method Summary | |
|---|---|
void |
addHyperlink(java.lang.String address)
Adds a hyperlink to the mso drawing object. |
java.lang.String |
getContent()
Gets the content of textbox. |
ShapeFill |
getFill()
Gets a object that contains fill formatting properties for the specified shape. |
Font |
getFont()
Gets the font of textbox. |
int |
getHeight()
Gets the height, in unit of pixel. |
double |
getHeightCM()
Gets the height, in unit of centimeters. |
float |
getHeightInch()
Gets the height, in unit of inches. |
int |
getHeightInChart()
Gets the height, in units of 1/4000 of the chart area. |
Hyperlink |
getHyperlink()
Gets a hyperlink from the mso drawing object. |
int |
getLeft()
Gets the horizontal offset of textbox from its left column, in unit of pixel. |
double |
getLeftCM()
Gets the horizontal offset of textbox from its left column, in unit of centimeters. |
float |
getLeftInch()
Gets the horizontal offset of textbox from its left column, in unit of inches. |
int |
getLeftInChart()
Gets the horizontal offset of textbox from its left column, in units of 1/4000 of the chart area. |
ShapeLine |
getLine()
Gets a object that contains line formatting properties for the shape. |
int |
getOrientation()
Gets text orientation. |
int |
getPlacement()
Gets the way the drawing obejct is attached to the cells below it. |
int |
getTextHorizontalAlignment()
Gets the text horizontal alignment. |
int |
getTextVerticalAlignment()
Gets the text vertical alignment of text. |
int |
getTop()
Gets the vertical offset of textbox from its top row, in unit of pixel. |
double |
getTopCM()
Gets the vertical offset of textbox from its top row, in unit of centimeters. |
float |
getTopInch()
Gets the vertical offset of textbox from its top row, in unit of inches. |
int |
getTopInChart()
Gets the vertical offset of textbox from its top row, in units of 1/4000 of the chart area. |
int |
getUpperLeftColumn()
Gets the upper left column index. |
int |
getUpperLeftRow()
Gets the upper left row index. |
int |
getWidth()
Gets the widthx, in unit of pixel. |
double |
getWidthCM()
Gets the width, in unit of centimeters. |
float |
getWidthInch()
Gets the width, in unit of inches. |
int |
getWidthInChart()
Gets the widthx, in units of 1/4000 of the chart area. |
boolean |
hasLine()
Indicates whether shape has border line. |
boolean |
isFilled()
Indicates whether shape is filled. |
void |
setContent(java.lang.String content)
Sets the content of textbox. |
void |
setFilled(boolean isFilled)
Sets whether shape is filled. |
void |
setFont(Font font)
Sets the font of textbox. |
void |
setHasLine(boolean hasLine)
Sets whether shape has border line. |
void |
setHeight(int height)
Sets the height, in unit of pixel. |
void |
setHeightCM(double height)
Sets the height, in unit of centimeters. |
void |
setHeightInch(double height)
Sets the height, in unit of inches. |
void |
setHeightInChart(int height)
Sets the height, in units of 1/4000 of the chart area. |
void |
setLeft(int left)
Sets the horizontal offset of textbox from its left column, in unit of pixel. |
void |
setLeftCM(double left)
Sets the horizontal offset of textbox from its left column, in unit of centimeters. |
void |
setLeftInch(double left)
Sets the horizontal offset of textbox from its left column, in unit of inches. |
void |
setLeftInChart(int left)
Sets the horizontal offset of textbox from its left column, in units of 1/4000 of the chart area. |
void |
setOrientation(int orientation)
Sets text orientation. |
void |
setPlacement(byte placementType)
Sets the way the drawing obejct is attached to the cells below it. |
void |
setTextHorizontalAlignment(int textAlignmentType)
Sets the text horizontal alignment. |
void |
setTextVerticalAlignment(int textAlignmentType)
Sets the text vertical alignment of text. |
void |
setTop(int top)
Sets the vertical offset of textbox from its top row, in unit of pixel. |
void |
setTopCM(double top)
Sets the vertical offset of textbox from its top row, in unit of centimeters. |
void |
setTopInch(double top)
Sets the vertical offset of textbox from its top row, in unit of inches. |
void |
setTopInChart(int top)
Sets the vertical offset of textbox from its top row, in units of 1/4000 of the chart area. |
void |
setUpperLeftColumn(int column)
Sets the upper left column index. |
void |
setUpperLeftRow(int row)
Sets the upper left row index. |
void |
setWidth(int width)
Sets the width, in unit of pixel. |
void |
setWidthCM(double width)
Sets the width, in unit of centimeters. |
void |
setWidthInch(double width)
Sets the width, in unit of inches. |
void |
setWidthInChart(int width)
Sets the width, in units of 1/4000 of the chart area. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public Font getFont()
CellsException - if TextBoxes has been removed.public void setFont(Font font)
font - the font of textbox.
CellsException - if TextBoxes has been removed.public java.lang.String getContent()
public void setContent(java.lang.String content)
content - the content of textbox.
CellsException - if TextBoxes has been removed.public int getTextHorizontalAlignment()
CellsException - if TextBoxes has been removed.setTextHorizontalAlignment(int)public void setTextHorizontalAlignment(int textAlignmentType)
textAlignmentType - the text horizontal alignment.
It could be one of the following values: | TextAlignmentType.LEFT |
| TextAlignmentType.CENTER |
| TextAlignmentType.RIGHT |
| TextAlignmentType.JUSTIFY |
| TextAlignmentType.DISTRIBUTED |
CellsException - if TextBoxes has been removed.
java.lang.IllegalArgumentException - if text alignment type is invalid.public int getTextVerticalAlignment()
CellsException - if TextBoxes has been removed.setTextVerticalAlignment(int)public void setTextVerticalAlignment(int textAlignmentType)
textAlignmentType - the text vertical alignment of text.
It could be one of the following values: | TextAlignmentType.TOP |
| TextAlignmentType.CENTER |
| TextAlignmentType.BOTTOM |
| TextAlignmentType.JUSTIFY |
| TextAlignmentType.DISTRIBUTED |
CellsException - if TextBoxes has been removed.
java.lang.IllegalArgumentException - if text alignment type is invalid.public void setOrientation(int orientation)
| MsoTextOrientation.NO_ROTATED |
| MsoTextOrientation.TOP_TO_BOTTOM |
| MsoTextOrientation.UPWARD |
| MsoTextOrientation.DOWNWARD |
java.lang.IllegalArgumentException - if rotation is one of MsoTextOrientation constants.
CellsException - if TextBoxes has been removed.public int getOrientation()
CellsException - if TextBoxes has been removed.setOrientation(int)public ShapeFill getFill()
public ShapeLine getLine()
public boolean isFilled()
public void setFilled(boolean isFilled)
isFilled - whether shape is filled.public Hyperlink getHyperlink()
public void addHyperlink(java.lang.String address)
address - address of this hyperlink.This parameter can't be empty.public boolean hasLine()
public void setHasLine(boolean hasLine)
hasLine - whether shape has border line.public int getUpperLeftColumn()
public void setUpperLeftColumn(int column)
column - the upper left column index .public int getUpperLeftRow()
public void setUpperLeftRow(int row)
row - the upper left row index.public int getHeight()
public void setHeight(int height)
height - the height, in unit of pixel.public int getHeightInChart()
public void setHeightInChart(int height)
height - the height, in units of 1/4000 of the chart area.
java.lang.IllegalArgumentException - if height > 4000;public float getHeightInch()
public void setHeightInch(double height)
height - the heigh, in unit of inches.public double getHeightCM()
public void setHeightCM(double height)
height - the height, in unit of centimeters.public int getWidth()
public void setWidth(int width)
width - the width, in unit of pixel.public int getWidthInChart()
public void setWidthInChart(int width)
width - the width, in units of 1/4000 of the chart area.
java.lang.IllegalArgumentException - if width > 4000;public float getWidthInch()
public void setWidthInch(double width)
width - the width, in unit of inches.public double getWidthCM()
public void setWidthCM(double width)
width - the width, in unit of centimeters.public int getLeft()
public void setLeft(int left)
left - the horizontal offset of textbox from its left column, in unit
of pixel.public int getLeftInChart()
public void setLeftInChart(int left)
left - the horizontal offset of textbox from its left column, in units of 1/4000 of the chart area.
java.lang.IllegalArgumentException - if left > 4000;public float getLeftInch()
public void setLeftInch(double left)
left - the horizontal offset of textbox from its left column, in unit
of inches.public double getLeftCM()
public void setLeftCM(double left)
left - the horizontal offset of textbox from its left column, in unit
of centimeters.public int getTop()
public void setTop(int top)
top - the vertical offset of textbox from its top row, in unit of
pixel.public int getTopInChart()
public void setTopInChart(int top)
top - the vertical offset of textbox from its top row, in units of 1/4000 of the chart area.
java.lang.IllegalArgumentException - if top > 4000;public float getTopInch()
public void setTopInch(double top)
top - the vertical offset of textbox from its top row, in unit of
inches.public double getTopCM()
public void setTopCM(double top)
top - the vertical offset of textbox from its top row, in unit of
centimeters.public int getPlacement()
setPlacement(byte)public void setPlacement(byte placementType)
placementType - the way the drawing obejct is attached to the cells below it. It
could be one of the following values: | PlacementType.FREE_FLOATING |
| PlacementType.MOVE |
| PlacementType.MOVE_AND_SIZE |
java.lang.IllegalArgumentException - if placementType is not member of PlacementType
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||