com.aspose.cells
Class LineFormat

java.lang.Object
  FillFormat
      com.aspose.cells.LineFormat

public class LineFormat 
extends FillFormat

//Instantiating a Workbook object
Workbook workbook = new Workbook();
ShapeCollection shapes = workbook.getWorksheets().get(0).getShapes();
Shape shape = shapes.addRectangle(1, 0, 1, 0, 50, 100);
LineFormat lineFmt = shape.getLine();

//do your business

public int getCompoundType() / public void setCompoundType(int value)

Specifies the line compound type. The value of the property is MsoLineStyle integer constant.

Example:

lineFmt.setCompoundType(MsoLineStyle.SINGLE);

public int getDashStyle() / public void setDashStyle(int value)

Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.

Example:

lineFmt.setDashStyle(MsoLineDashStyle.SOLID);

public int getCapType() / public void setCapType(int value)

Specifies the ending caps. The value of the property is LineCapType integer constant.

Example:

lineFmt.setCapType(LineCapType.FLAT);

public int getJoinType() / public void setJoinType(int value)

Specifies the line join type. The value of the property is LineJoinType integer constant.

Example:

lineFmt.setJoinType(LineJoinType.ROUND);

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

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

Example:

lineFmt.setBeginArrowheadStyle(MsoArrowheadStyle.ARROW_OPEN);

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

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

Example:

lineFmt.setBeginArrowheadWidth(MsoArrowheadWidth.MEDIUM);

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

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

Example:

lineFmt.setBeginArrowheadLength(MsoArrowheadLength.LONG);

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

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

Example:

lineFmt.setEndArrowheadStyle(MsoArrowheadStyle.ARROW_OPEN);

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

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

Example:

lineFmt.setEndArrowheadWidth(MsoArrowheadWidth.MEDIUM);

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

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

Example:

lineFmt.setEndArrowheadLength(MsoArrowheadLength.LONG);

public double getWeight() / public void setWeight(double value)

Gets or sets the weight of the line in unit of points.

Example:

lineFmt.setWeight(2.0d);

public int getType() / public void setType(int value)

Gets and sets the fill type. The value of the property is FillType integer constant.

NOTE: This member is now obsolete. Instead, please use FillFormat.FillType property instead. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.

public int getFillType() / public void setFillType(int value)

Gets and sets fill type The value of the property is FillType integer constant.

public double getTransparency() / public void setTransparency(double value)

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

public int getSetType() / public void setSetType(int value)

Gets the fill format set type. The value of the property is FormatSetType integer constant.

NOTE: This member is now obsolete. Instead, please use FillFormat.FillType property instead. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.

public GradientFill getGradientFill()

Gets GradientFill object.

public TextureFill getTextureFill()

Gets TextureFill object.

public SolidFill getSolidFill()

Gets SolidFill object.

public PatternFill getPatternFill()

Gets PatternFill object.

public int getGradientColorType()

Returns the gradient color type for the specified fill. The value of the property is GradientColorType integer constant.

public int getGradientStyle()

Returns the gradient style for the specified fill. The value of the property is GradientStyleType integer constant.

public com.aspose.cells.Color getGradientColor1()

Returns the gradient color 1 for the specified fill.

public com.aspose.cells.Color getGradientColor2()

Returns the gradient color 2 for the specified fill.

Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful.

public double getGradientDegree()

Returns the gradient degree for the specified fill. Only applies for Excel 2007.

Can only be a value from 0.0 (dark) through 1.0 (light).

public int getGradientVariant()

Returns the gradient variant for the specified fill. Only applies for Excel 2007.

Can only be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.

public int getPresetColor()

Returns the gradient preset color for the specified fill. The value of the property is GradientPresetType integer constant.

public int getTexture() / public void setTexture(int value)

Represents the texture type for the specified fill. The value of the property is TextureType integer constant.

public int getPattern() / public void setPattern(int value)

Represents an area's display pattern. The value of the property is FillPattern integer constant.

public int getPictureFormatType() / public void setPictureFormatType(int value)

Gets and sets the picture format type. The value of the property is FillPictureType integer constant.

public double getScale() / public void setScale(double value)

Gets and sets the picture format scale.

public byte[] getImageData() / public void setImageData(byte[] value)

Gets and sets the picture image data.

If the fill format is not custom texture format, returns null.

public int hashCode()

Gets the hash code.

Returns:

Example:

int hashCode = lineFmt.hashCode();

public boolean equals(java.lang.Object obj)

Determines whether this instance has the same value as another specified LineFormat object.

Parameters:

obj - The LineFormat object to compare with this instance.

Returns:

true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false.

Example:

//You have to make sure that the index value in this line of code exists
LineFormat obj = workbook.getWorksheets().get(0).getShapes().get(0).getLine();
if (lineFmt.equals(obj))
{
    //do what you want
}

public void setOneColorGradient(com.aspose.cells.Color color, double degree, int style, int variant)

Sets the specified fill to a one-color gradient. Only applies for Excel 2007.

Parameters:

color - One gradient color.

degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).

style - A GradientStyleType value. Gradient shading style.

variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.

public void setTwoColorGradient(com.aspose.cells.Color color1, com.aspose.cells.Color color2, int style, int variant)

Sets the specified fill to a two-color gradient. Only applies for Excel 2007.

Parameters:

color1 - One gradient color.

color2 - Two gradient color.

style - A GradientStyleType value. Gradient shading style.

variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.

public void setTwoColorGradient(com.aspose.cells.Color color1, double transparency1, com.aspose.cells.Color color2, double transparency2, int style, int variant)

Sets the specified fill to a two-color gradient. Only applies for Excel 2007.

Parameters:

color1 - One gradient color.

transparency1 - The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear).

color2 - Two gradient color.

transparency2 - The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear).

style - A GradientStyleType value. Gradient shading style.

variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.

public void setPresetColorGradient(int presetColor, int style, int variant)

Sets the specified fill to a preset-color gradient. Only applies for Excel 2007.

Parameters:

presetColor - A GradientPresetType value. Preset color type

style - A GradientStyleType value. Gradient shading style.

variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.