com.aspose.cells
Class LineFormat

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

public class LineFormat 
extends FillFormat

Represents all setting of the line.

Property Getters/Setters Summary
intgetBeginArrowheadLength()
voidsetBeginArrowheadLength(int value)
           Gets and sets the begin arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
intgetBeginArrowheadStyle()
voidsetBeginArrowheadStyle(int value)
           Gets and sets the begin arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
intgetBeginArrowheadWidth()
voidsetBeginArrowheadWidth(int value)
           Gets and sets the begin arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
intgetCapType()
voidsetCapType(int value)
           Specifies the ending caps. The value of the property is LineCapType integer constant.
intgetCompoundType()
voidsetCompoundType(int value)
           Specifies the line compound type. The value of the property is MsoLineStyle integer constant.
intgetDashStyle()
voidsetDashStyle(int value)
           Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.
intgetEndArrowheadLength()
voidsetEndArrowheadLength(int value)
           Gets and sets the end arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
intgetEndArrowheadStyle()
voidsetEndArrowheadStyle(int value)
           Gets and sets the end arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
intgetEndArrowheadWidth()
voidsetEndArrowheadWidth(int value)
           Gets and sets the end arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
intgetFillType()→ inherited from FillFormat
voidsetFillType(int value)
           Gets and sets fill type The value of the property is FillType integer constant.
ColorgetGradientColor1()→ inherited from FillFormat
           Returns the gradient color 1 for the the specified fill.
ColorgetGradientColor2()→ inherited from FillFormat
           Returns the gradient color 2 for the the specified fill.
intgetGradientColorType()→ inherited from FillFormat
           Returns the gradient color type for the specified fill. The value of the property is GradientColorType integer constant.
doublegetGradientDegree()→ inherited from FillFormat
           Returns the gradient degree for the the specified fill.
GradientFillgetGradientFill()→ inherited from FillFormat
           Gets GradientFill object.
intgetGradientStyle()→ inherited from FillFormat
           Returns the gradient style for the specified fill. The value of the property is GradientStyleType integer constant.
intgetGradientVariant()→ inherited from FillFormat
           Returns the gradient variant for the the specified fill.
byte[]getImageData()→ inherited from FillFormat
voidsetImageData(byte[] value)
           Gets and sets the picture image data.
intgetJoinType()
voidsetJoinType(int value)
           Specifies the line join type. The value of the property is LineJoinType integer constant.
intgetPattern()→ inherited from FillFormat
voidsetPattern(int value)
           Represents an area's display pattern. The value of the property is FillPattern integer constant.
PatternFillgetPatternFill()→ inherited from FillFormat
           Gets PatternFill object.
intgetPictureFormatType()→ inherited from FillFormat
voidsetPictureFormatType(int value)
           Gets and sets the picture format type. The value of the property is FillPictureType integer constant.
intgetPresetColor()→ inherited from FillFormat
           Returns the gradient preset color for the the specified fill. The value of the property is GradientPresetType integer constant.
doublegetScale()→ inherited from FillFormat
voidsetScale(double value)
           Gets and sets the picture format scale.
intgetSetType()→ inherited from FillFormat
voidsetSetType(int value)
           Gets the fill format set type. The value of the property is FormatSetType integer constant.
SolidFillgetSolidFill()→ inherited from FillFormat
           Gets SolidFill object.
intgetTexture()→ inherited from FillFormat
voidsetTexture(int value)
           Represents the texture type for the specified fill. The value of the property is TextureType integer constant.
TextureFillgetTextureFill()→ inherited from FillFormat
           Gets TextureFill object.
doublegetTransparency()→ inherited from FillFormat
voidsetTransparency(double value)
           Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
intgetType()→ inherited from FillFormat
voidsetType(int value)
           Gets and sets the fill type. The value of the property is FillType integer constant.
doublegetWeight()
voidsetWeight(double value)
           Gets or sets the weight of the line in unit of points.
 
Method Summary
voidsetOneColorGradient(Color color, double degree, int style, int variant)→ inherited from FillFormat
           Sets the specified fill to a one-color gradient.
voidsetPresetColorGradient(int presetColor, int style, int variant)→ inherited from FillFormat
           Sets the specified fill to a preset-color gradient.
voidsetTwoColorGradient(Color color1, Color color2, int style, int variant)→ inherited from FillFormat
           Sets the specified fill to a two-color gradient.
voidsetTwoColorGradient(Color color1, double transparency1, Color color2, double transparency2, int style, int variant)→ inherited from FillFormat
           Sets the specified fill to a two-color gradient.
 

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

→ inherited from FillFormat
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

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

getTransparency/setTransparency

→ inherited from FillFormat
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

→ inherited from FillFormat
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.

getGradientFill

→ inherited from FillFormat
public GradientFill getGradientFill()
Gets GradientFill object.

getTextureFill

→ inherited from FillFormat
public TextureFill getTextureFill()
Gets TextureFill object.

getSolidFill

→ inherited from FillFormat
public SolidFill getSolidFill()
Gets SolidFill object.

getPatternFill

→ inherited from FillFormat
public PatternFill getPatternFill()
Gets PatternFill object.

getGradientColorType

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

getGradientStyle

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

getGradientColor1

→ inherited from FillFormat
public Color getGradientColor1()
Returns the gradient color 1 for the the specified fill.

getGradientColor2

→ inherited from FillFormat
public 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

→ inherited from FillFormat
public double getGradientDegree()
Returns the gradient degree for the the specified fill. Can only be a value from 0.0 (dark) through 1.0 (light).

getGradientVariant

→ inherited from FillFormat
public int getGradientVariant()
Returns the gradient variant for the the specified fill. 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

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

getTexture/setTexture

→ inherited from FillFormat
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

→ inherited from FillFormat
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

→ inherited from FillFormat
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

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

getImageData/setImageData

→ inherited from FillFormat
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.

Method Detail

setOneColorGradient

→ inherited from FillFormat
public void setOneColorGradient(Color color, double degree, int style, int variant)
Sets the specified fill to a one-color gradient.
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

→ inherited from FillFormat
public void setTwoColorGradient(Color color1, Color color2, int style, int variant)
Sets the specified fill to a two-color gradient.
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

→ inherited from FillFormat
public void setTwoColorGradient(Color color1, double transparency1, Color color2, double transparency2, int style, int variant)
Sets the specified fill to a two-color gradient.
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

→ inherited from FillFormat
public void setPresetColorGradient(int presetColor, int style, int variant)
Sets the specified fill to a preset-color gradient.
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.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.