com.aspose.cells

com.aspose.cells

Class LineFormat

  • java.lang.Object 
public class LineFormat 
extends FillFormat

Represents all setting of the line.

Property Getters/Setters Summary
intgetBeginArrowheadLength()
void
setBeginArrowheadLength(intvalue)
           Gets and sets the begin arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
intgetBeginArrowheadStyle()
void
setBeginArrowheadStyle(intvalue)
           Gets and sets the begin arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
intgetBeginArrowheadWidth()
void
setBeginArrowheadWidth(intvalue)
           Gets and sets the begin arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
intgetCapType()
void
setCapType(intvalue)
           Specifies the ending caps. The value of the property is LineCapType integer constant.
intgetCompoundType()
void
setCompoundType(intvalue)
           Specifies the line compound type. The value of the property is MsoLineStyle integer constant.
intgetDashStyle()
void
setDashStyle(intvalue)
           Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.
intgetEndArrowheadLength()
void
setEndArrowheadLength(intvalue)
           Gets and sets the end arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
intgetEndArrowheadStyle()
void
setEndArrowheadStyle(intvalue)
           Gets and sets the end arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
intgetEndArrowheadWidth()
void
setEndArrowheadWidth(intvalue)
           Gets and sets the end arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
intgetFillType()
void
setFillType(intvalue)
           Gets and sets fill type The value of the property is FillType integer constant.
com.aspose.cells.ColorgetGradientColor1()
Returns the gradient color 1 for the the specified fill.
com.aspose.cells.ColorgetGradientColor2()
Returns the gradient color 2 for the the specified fill.
intgetGradientColorType()
Returns the gradient color type for the specified fill. The value of the property is GradientColorType integer constant.
doublegetGradientDegree()
Returns the gradient degree for the the specified fill. Only applies for Excel 2007.
GradientFillgetGradientFill()
Gets GradientFill object.
intgetGradientStyle()
Returns the gradient style for the specified fill. The value of the property is GradientStyleType integer constant.
intgetGradientVariant()
Returns the gradient variant for the the specified fill. Only applies for Excel 2007.
byte[]getImageData()
void
setImageData(byte[]value)
           Gets and sets the picture image data.
intgetJoinType()
void
setJoinType(intvalue)
           Specifies the line join type. The value of the property is LineJoinType integer constant.
intgetPattern()
void
setPattern(intvalue)
           Represents an area's display pattern. The value of the property is FillPattern integer constant.
PatternFillgetPatternFill()
Gets PatternFill object.
intgetPictureFormatType()
void
setPictureFormatType(intvalue)
           Gets and sets the picture format type. The value of the property is FillPictureType integer constant.
intgetPresetColor()
Returns the gradient preset color for the the specified fill. The value of the property is GradientPresetType integer constant.
doublegetScale()
void
setScale(doublevalue)
           Gets and sets the picture format scale.
intgetSetType()
void
setSetType(intvalue)
           Gets the fill format set type. The value of the property is FormatSetType integer constant.
SolidFillgetSolidFill()
Gets SolidFill object.
intgetTexture()
void
setTexture(intvalue)
           Represents the texture type for the specified fill. The value of the property is TextureType integer constant.
TextureFillgetTextureFill()
Gets TextureFill object.
doublegetTransparency()
void
setTransparency(doublevalue)
           Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
intgetType()
void
setType(intvalue)
           Gets and sets the fill type. The value of the property is FillType integer constant.
doublegetWeight()
void
setWeight(doublevalue)
           Gets or sets the weight of the line in unit of points.
 
Method Summary
voidsetOneColorGradient(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.
voidsetPresetColorGradient(int presetColor, int style, int variant)
Sets the specified fill to a preset-color gradient. Only applies for Excel 2007.
voidsetTwoColorGradient(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.
voidsetTwoColorGradient(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.
 

    • Property Getters/Setters Detail

      • getCompoundType/setCompoundType

        public int getCompoundType() / public void setCompoundType(int value)
        Specifies the line compound type. The value of the property is MsoLineStyle integer constant.

      • getDashStyle/setDashStyle

        public int getDashStyle() / public void setDashStyle(int value)
        Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.

      • getCapType/setCapType

        public int getCapType() / public void setCapType(int value)
        Specifies the ending caps. The value of the property is LineCapType integer constant.

      • getJoinType/setJoinType

        public int getJoinType() / public void setJoinType(int value)
        Specifies the line join type. The value of the property is LineJoinType integer constant.

      • getBeginArrowheadStyle/setBeginArrowheadStyle

        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.

      • getBeginArrowheadWidth/setBeginArrowheadWidth

        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.

      • getBeginArrowheadLength/setBeginArrowheadLength

        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.

      • getEndArrowheadStyle/setEndArrowheadStyle

        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.

      • getEndArrowheadWidth/setEndArrowheadWidth

        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.

      • getEndArrowheadLength/setEndArrowheadLength

        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.

      • getWeight/setWeight

        public double getWeight() / public void setWeight(double value)
        Gets or sets the weight of the line in unit of points.

      • getType/setType

        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.

      • getFillType/setFillType

        public int getFillType() / public void setFillType(int value)
        Gets and sets fill type The value of the property is FillType integer constant.

      • getTransparency/setTransparency

        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).

      • getSetType/setSetType

        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.

      • getGradientColorType

        public int getGradientColorType()
        Returns the gradient color type for the specified fill. The value of the property is GradientColorType integer constant.

      • getGradientStyle

        public int getGradientStyle()
        Returns the gradient style for the specified fill. The value of the property is GradientStyleType integer constant.

      • getGradientColor1

        public com.aspose.cells.Color getGradientColor1()
        Returns the gradient color 1 for the the specified fill.

      • getGradientColor2

        public com.aspose.cells.Color getGradientColor2()
        Returns the gradient color 2 for the the specified fill. Only when the graident color type is GradientColorType.TwoColors, this property is meaningful.

      • getGradientDegree

        public double getGradientDegree()
        Returns the gradient degree for the the specified fill. Only applies for Excel 2007. Can only be a value from 0.0 (dark) through 1.0 (light).

      • getGradientVariant

        public int getGradientVariant()
        Returns the gradient variant for the 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.

      • getPresetColor

        public int getPresetColor()
        Returns the gradient preset color for the the specified fill. The value of the property is GradientPresetType integer constant.

      • getTexture/setTexture

        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.

      • getPattern/setPattern

        public int getPattern() / public void setPattern(int value)
        Represents an area's display pattern. The value of the property is FillPattern integer constant.

      • getPictureFormatType/setPictureFormatType

        public int getPictureFormatType() / public void setPictureFormatType(int value)
        Gets and sets the picture format type. The value of the property is FillPictureType integer constant.

      • getScale/setScale

        public double getScale() / public void setScale(double value)
        Gets and sets the picture format scale.

      • getImageData/setImageData

        public byte[] getImageData() / public void setImageData(byte[] value)
        Gets and sets the picture image data. If the fill format is not custom texture format,return null.

    setCompoundType

    public voidsetCompoundType(intvalue)
    Specifies the line compound type. The value of the property is MsoLineStyle integer constant.

    setDashStyle

    public voidsetDashStyle(intvalue)
    Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.

    setCapType

    public voidsetCapType(intvalue)
    Specifies the ending caps. The value of the property is LineCapType integer constant.

    setJoinType

    public voidsetJoinType(intvalue)
    Specifies the line join type. The value of the property is LineJoinType integer constant.

    setBeginArrowheadStyle

    public voidsetBeginArrowheadStyle(intvalue)
    Gets and sets the begin arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.

    setBeginArrowheadWidth

    public voidsetBeginArrowheadWidth(intvalue)
    Gets and sets the begin arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.

    setBeginArrowheadLength

    public voidsetBeginArrowheadLength(intvalue)
    Gets and sets the begin arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.

    setEndArrowheadStyle

    public voidsetEndArrowheadStyle(intvalue)
    Gets and sets the end arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.

    setEndArrowheadWidth

    public voidsetEndArrowheadWidth(intvalue)
    Gets and sets the end arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.

    setEndArrowheadLength

    public voidsetEndArrowheadLength(intvalue)
    Gets and sets the end arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.

    setWeight

    public voidsetWeight(doublevalue)
    Gets or sets the weight of the line in unit of points.

    setType

    public voidsetType(intvalue)
    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.

    setFillType

    public voidsetFillType(intvalue)
    Gets and sets fill type The value of the property is FillType integer constant.

    setTransparency

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

    setSetType

    public voidsetSetType(intvalue)
    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.

    setTexture

    public voidsetTexture(intvalue)
    Represents the texture type for the specified fill. The value of the property is TextureType integer constant.

    setPattern

    public voidsetPattern(intvalue)
    Represents an area's display pattern. The value of the property is FillPattern integer constant.

    setPictureFormatType

    public voidsetPictureFormatType(intvalue)
    Gets and sets the picture format type. The value of the property is FillPictureType integer constant.

    setScale

    public voidsetScale(doublevalue)
    Gets and sets the picture format scale.

    setImageData

    public voidsetImageData(byte[]value)
    Gets and sets the picture image data. If the fill format is not custom texture format,return null.

    • Method Detail

      • setOneColorGradient

        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.

      • setTwoColorGradient

        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.

      • setTwoColorGradient

        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.

      • setPresetColorGradient

        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.