com.aspose.cells
Class LineShape

java.lang.Object
  Shape
      com.aspose.cells.LineShape

public class LineShape 
extends Shape

//Instantiate a new Workbook.
Workbook workbook = new Workbook();

//Get the first worksheet in the book.
Worksheet worksheet = workbook.getWorksheets().get(0);

//Add a new line to the worksheet.
LineShape line1 = worksheet.getShapes().addLine(5, 0, 1, 0, 0, 250);

//Set the line dash style
line1.getLineFormat().setDashStyle(MsoLineDashStyle.SOLID);

//Set the placement.
line1.setPlacement(PlacementType.FREE_FLOATING);

//Add another line to the worksheet.
LineShape line2 = worksheet.getShapes().addLine(7, 0, 1, 0, 85, 250);

//Set the line dash style.
line2.getLineFormat().setDashStyle(MsoLineDashStyle.DASH_LONG_DASH);

//Set the weight of the line.
line2.getLineFormat().setWeight(4);

//Set the placement.
line2.setPlacement(PlacementType.FREE_FLOATING);

//Add the third line to the worksheet.
LineShape line3 = worksheet.getShapes().addLine(13, 0, 1, 0, 0, 250);

//Set the line dash style
line3.getLineFormat().setDashStyle(MsoLineDashStyle.SOLID);

//Set the placement.
line3.setPlacement(PlacementType.FREE_FLOATING);

//Make the gridlines invisible in the first worksheet.
workbook.getWorksheets().get(0).setGridlinesVisible(false);

//Save the excel file.
workbook.save("d:\\test\\tstlines.xls");

public int getBeginArrowheadStyle() / public void setBeginArrowheadStyle(int value)

Gets and sets the begin arrow head style of the line. The value of the property is MsoArrowheadStyle integer constant.

public int getBeginArrowheadWidth() / public void setBeginArrowheadWidth(int value)

Gets and sets the begin arrow head width of the line. The value of the property is MsoArrowheadWidth integer constant.

public int getBeginArrowheadLength() / public void setBeginArrowheadLength(int value)

Gets and sets the begin arrow head length of the line. The value of the property is MsoArrowheadLength integer constant.

public int getEndArrowheadStyle() / public void setEndArrowheadStyle(int value)

Gets and sets the end arrow head style of the line. The value of the property is MsoArrowheadStyle integer constant.

public int getEndArrowheadWidth() / public void setEndArrowheadWidth(int value)

Gets and sets the end arrow head width of the line. The value of the property is MsoArrowheadWidth integer constant.

public int getEndArrowheadLength() / public void setEndArrowheadLength(int value)

Gets and sets the end arrow head length of the line. The value of the property is MsoArrowheadLength integer constant.

public int getZOrderPosition() / public void setZOrderPosition(int value)

Returns the position of a shape in the z-order.

public java.lang.String getName() / public void setName(java.lang.String value)

Gets and sets the name of the shape.

public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)

Returns or sets the descriptive (alternative) text string of the Shape object.

public java.lang.String getTitle() / public void setTitle(java.lang.String value)

Specifies the title (caption) of the current shape object.

public MsoLineFormat getLineFormat()

Returns a MsoLineFormat object that contains line formatting properties for the specified shape.

public MsoFillFormat getFillFormat()

Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.

public FillFormat getFill()

Returns a FillFormat object that contains fill formatting properties for the specified shape.

public MsoTextFrame getTextFrame()

Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.

public MsoFormatPicture getFormatPicture()

Gets and sets the options of the picture format.

public boolean isHidden() / public void setHidden(boolean value)

Indicates whether the object is visible.

public boolean isLockAspectRatio() / public void setLockAspectRatio(boolean value)

True means that don't allow changes in aspect ratio.

public int getRotation() / public void setRotation(int value)

Gets and sets the rotation of the shape.

NOTE: This member is now obsolete. Instead, please use Shape.RotationAngle property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

public double getRotationAngle() / public void setRotationAngle(double value)

Gets and sets the rotation of the shape.

public Hyperlink getHyperlink()

Gets the hyperlink of the shape.

public boolean isGroup()

Indicates whether the shape is a group.

public boolean isWordArt()

Indicates whether this shape is a word art.

public TextEffectFormat getTextEffect()

Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.

public boolean isLocked() / public void setLocked(boolean value)

True if the object is locked, False if the object can be modified when the sheet is protected.

public boolean isPrintable() / public void setPrintable(boolean value)

True if the object is printable

public boolean isPrinted() / public void setPrinted(boolean value)

True if the object is printable

NOTE: This member is now obsolete. Instead, please use Shape.IsPrintable property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

public int getMsoDrawingType()

Gets and sets mso drawing type. The value of the property is MsoDrawingType integer constant.

public int getAutoShapeType() / public void setAutoShapeType(int value)

Gets the auto shape type. The value of the property is AutoShapeType integer constant.

public int getPlacement() / public void setPlacement(int value)

Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. The value of the property is PlacementType integer constant.

public int getUpperLeftRow() / public void setUpperLeftRow(int value)

Represents upper left corner row index.

If the shape is in the shape or in the group , UpperLeftRow will be ignored.

public int getUpperDeltaY() / public void setUpperDeltaY(int value)

Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.

public int getUpperLeftColumn() / public void setUpperLeftColumn(int value)

Represents upper left corner column index.

public int getUpperDeltaX() / public void setUpperDeltaX(int value)

Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.

public int getActualLowerRightRow()

Get the actual bottom row.

public int getLowerRightRow() / public void setLowerRightRow(int value)

Represents lower right corner row index.

public int getLowerDeltaY() / public void setLowerDeltaY(int value)

Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.

public int getLowerRightColumn() / public void setLowerRightColumn(int value)

Represents lower right corner column index.

public int getLowerDeltaX() / public void setLowerDeltaX(int value)

Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.

public int getRight()

Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.

public int getBottom()

Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.

public int getWidth() / public void setWidth(int value)

Represents the width of shape, in unit of pixels.

public double getWidthInch() / public void setWidthInch(double value)

Represents the width of the shape, in unit of inch.

public double getWidthPt() / public void setWidthPt(double value)

Represents the width of the shape, in unit of point.

public double getWidthCM() / public void setWidthCM(double value)

Represents the width of the shape, in unit of centimeters.

public int getHeight() / public void setHeight(int value)

Represents the height of shape, in unit of pixel.

public double getHeightInch() / public void setHeightInch(double value)

Represents the height of the shape, in unit of inches.

public double getHeightPt() / public void setHeightPt(double value)

Represents the height of the shape, in unit of points.

public double getHeightCM() / public void setHeightCM(double value)

Represents the height of the shape, in unit of inches.

public int getLeft() / public void setLeft(int value)

Represents the horizontal offset of shape from its left column, in unit of pixels.

public double getLeftInch() / public void setLeftInch(double value)

Represents the horizontal offset of shape from its left column, in unit of inches.

public double getLeftCM() / public void setLeftCM(double value)

Represents the horizontal offset of shape from its left column, in unit of centimeters.

public int getTop() / public void setTop(int value)

Represents the vertical offset of shape from its top row, in unit of pixels.

If the shape is in the chart, represents the vertical offset of shape from its top border.

public double getTopInch() / public void setTopInch(double value)

Represents the vertical offset of shape from its top row, in unit of inches.

public double getTopCM() / public void setTopCM(double value)

Represents the vertical offset of shape from its top row, in unit of centimeters.

public int getX() / public void setX(int value)

Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.

public int getY() / public void setY(int value)

Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

public int getWidthScale() / public void setWidthScale(int value)

Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;

public int getHeightScale() / public void setHeightScale(int value)

Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;

public int getTopInShape() / public void setTopInShape(int value)

Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.

Only Applies when this shape in the group or chart.

public int getLeftInShape() / public void setLeftInShape(int value)

Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.

Only Applies when this shape in the group or chart.

public int getWidthInShape() / public void setWidthInShape(int value)

Represents the width of the shape, in unit of 1/4000 of the parent shape.

Only Applies when this shape in the group or chart.

public int getHeightInShape() / public void setHeightInShape(int value)

Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..

Only Applies when this shape in the group or chart.

public int getHeightInChart() / public void setHeightInChart(int value)

Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.HeightInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public int getLeftInChart() / public void setLeftInChart(int value)

Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.LeftInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public int getTopInChart() / public void setTopInChart(int value)

Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.TopInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public int getWidthInChart() / public void setWidthInChart(int value)

Represents the width of the shape, in unit of 1/4000 of the parent shape.

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.WidthInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public int getPositionX() / public void setPositionX(int value)

Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.X property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public int getPositionY() / public void setPositionY(int value)

Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.Y property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public GroupShape getGroup()

Gets the group shape which contains this shape.

public int getType()

Gets the auto shape type. The value of the property is AutoShapeType integer constant.

public boolean hasLine() / public void setHasLine(boolean value)

Gets and sets the line border of the shape is visible.

public boolean isFilled() / public void setFilled(boolean value)

Indicates whether the fill format is visible.

public boolean isFlippedHorizontally() / public void setFlippedHorizontally(boolean value)

Gets and sets whether shape is horizontally flipped .

public boolean isFlippedVertically() / public void setFlippedVertically(boolean value)

Gets and sets whether shape is vertically flipped .

public boolean getRelativeToOriginalPictureSize() / public void setRelativeToOriginalPictureSize(boolean value)

Indicates whether shape is relative to original picture size.

public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)

Gets or sets the worksheet range linked to the control's value.

public Font getFont() / public void setFont(Font value)

Represents the font of textbox.

public java.lang.String getText() / public void setText(java.lang.String value)

Represents the string in this TextBox object.

public java.lang.String getHtmlText() / public void setHtmlText(java.lang.String value)

Gets and sets the html string which contains data and some formattings in this textbox.

public int getTextVerticalOverflow() / public void setTextVerticalOverflow(int value)

Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

public int getTextHorizontalOverflow() / public void setTextHorizontalOverflow(int value)

Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

public boolean isTextWrapped() / public void setTextWrapped(boolean value)

Gets and sets the text wrapped type of the shape which contains text.

public int getTextOrientationType() / public void setTextOrientationType(int value)

Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)

Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)

Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

public void updateSelectedValue()
                        throws java.lang.Exception

Update the selected value by the value of the linked cell.

public void formatCharacters(int startIndex, int length, Font font)

Format some chararcters with the font setting.

Parameters:

startIndex - The start index.

length - The the length.

font - The font setting.

public FontSetting characters(int startIndex, int length)

Returns a Characters object that represents a range of characters within the text.

This method only works on shape with title.

Parameters:

startIndex - The index of the start of the character.

length - The number of characters.

Returns:

Characters object.

public java.util.ArrayList getCharacters()

Returns all Characters objects that represents a range of characters within the text .

Returns:

All Characters objects

public int[] calculateTextSize()
                       throws java.lang.Exception

Recalculate the text area

Returns:

Text's Size in an array(width and array).

public Hyperlink addHyperlink(java.lang.String address)

Adds a hyperlink to the shape.

Parameters:

address - Address of the hyperlink.

Returns:

Return the new hyperlink object.

public void removeHyperlink()

Remove the hyperlink of the shape.

public void moveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)

Moves the shape to a specified range.

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

lowerRightRow - Lower right row index

lowerRightColumn - Lower right column index